.TH xcmstest "" "" "X Utility"
.PC "XCMS test program"
\fBxcmstest [\-echo] [\-display \fIdisplayname\^\fB]\fR
.PP
.HS
.SH Options:
.IC \fB\-echo\fR
Echo a command as it is executed; used mostly when reading a file of commands
via the standard input
.IC "\fB\-display \fIdisplayname\fR"
Read the display
.I displayname
.HE
.B xcmstest
is a simple interface for testing the XCMS API library.
.SH "Before Invocation"
Ensure that the Screen Color Characterization Data (SCCD) has been placed into
the appropriate properties on the screen's root window.
To load these properties, refer to the entry in this manual for the utility
.BR xcmsdb .
.PP
.B xcmstest
recognizes the following command-line options:
.IP \fB\-echo\fR
Echo a command as it is executed.
This option usually is used when reading a file of commands
via the standard input.
.IP "\fB\-display \fIdisplayname\fR"
Read the display
.IR displayname .
.PP
To convert color names using a client-side color name
data base, the data-base file must be specified via the environment variable
.BR XCMSDB .
To use the sample database provided with this release, set
.B XCMSDB
as follows:
.DM
	setenv XCMSDB `pwd`/Xcms.txt
.DE
.SH "Using xcmstest"
Upon invocation, you should receive the prompt
.DM
	XCMS >
.DE
.PP
At this point you can enter commands.
.B xcmstest
recognizes the following commands:
.IP \fBinit\fR
Initiate contact with
.IR displayname .
.IS \fBquit\fR
Exit from
.BR cmstest .
.IS \fBbye\fR
Synonym for
.BR quit .
.IS \fBhalt\fR
Synonym for
.BR quit .
.IS \fBq\fR
Synonym for
.BR quit .
.IS \fBlist\fR
List available commands
.IS \fB?\fR
Synonym for
.BR list .
.IS "\fBCreateColormap \fIname AllocFlag\fR"
.I AllocFlag
must be either
.B AllocNone
or
.BR AllocAll .
.IS \fBFreeColormap\fR
Free the current color map.
.IS "\fBSet_idir \fIdirname\fR"
.IS "\fBSet_vdir \fIdirname\fR"
.IS "\fBSet_rdir \fIdirname\fR"
.IS \fBGet_idir\fR
.IS \fBGet_vdir\fR
.IS \fBGet_rdir\fR
.IS "\fBXSynchronize ON|OFF\fR"
.IS "\fBAllocColor \fIFormat Stim1 Stim2 Stim3 Result_Format \fB[\fIColormap\^\fB]\fR"
.IS "\fBAllocNamedColor \fIcolor_string result_format \fB[\fIColormap\^\fB]\fR"
.IS "\fBConvertColor \fIFrom_Format Stim1 Stim2 Stim3 To_Format\fR"
.IS "\fBLookupColor \fIcolor_string result_format \fB[\fIColormap\^\fB]\fR"
.IS "\fBQueryColor \fIPixel result_format \fB[\fIColormap\^\fB]\fR"
.IS "\fBQueryColors \fIresult_format \fB[\fIColormap\^\fB]\fR"
.IS "\fBQueryColors \fIresult_format \fB[\fIColormap\^\fB]\fR"
.IS "\fBStoreColor <Pixel> <Format> <Stim1> <Stim2> <Stim3> [Colormap]
.IS "\fBStoreColors [\fIColormap\^\fB]\fR"
.IS "\fBAddDIColorSpace \fIFormat\fR
.I Format
must be one of
.BR CIELab ,
.BR CIELuv ,
or
.BR TekHVC .
.IS "\fBFormatOfPrefix \fIprefix\fR"
.IS "\fBPrefixOfId \fIFormat\fR"
.I Format
must be one of
.BR UNDEFINED ,
.BR CIEXYZ ,
.BR CIExyY ,
.BR CIEuvY ,
.BR CIELab ,
.BR CIELuv ,
.BR TekHVC ,
.BR RGBi ,
or
.BR RGB .
.IS "\fBMaxChroma \fIHue Value\fR"
.IS "\fBMaxValue \fIHue Chroma\fR"
.IS "\fBMaxValueSamples \fIHue nSamples\fR"
.IS "\fBMaxValueChroma \fIHue\fR"
.IS "\fBMinValue \fIHue Chroma\fR"
.IS "\fBAdjustValue \fIHue Value Chroma\fR"
.IS "\fBReduceChroma \fIHue Value Chroma\fR"
.IS "\fBShortestValueChroma \fIHue Value Chroma\fR"
.IS "\fBShortestValueChroma \fIHue Value Chroma\fR"
.IS "\fBXAllocNamedColor \fIcolor_string \fB[\fIColormap\^\fB]\fR"
.IS "\fBXLookupColor \fIcolor_string \fB[\fIColormap\^\fB]\fR"
.IS "\fBXParseColor \fIcolor_string \fB[\fIcolormap\^\fB]\fR"
.IS "\fBXStoreNamedColor \fIcolor_string pixel \fB[\fIColormap\^\fB]\fR"
.PP
You can, if you wish, redirect the standard input so that
.B xcmstest
can read and execute a file of commands.
In this case, you should use the option
.BR \-echo ,
which tells
.B xcmstest
to echo the command before executing it.
This creates a more readable output.
.SH "See Also"
.B
xcmsdb,
X utilities
.R
.SH Notes
Color-name strings passed to
.B xcmstest
commands cannot contain a space.
However, because spaces are ignored by the
.B "XCMS API"
library, you can pass a color name with the spaces eliminated.
For example:
.DM
	LookupColor cornflowerblue UNDEFINED RGB
.DE
.PP
Copyright \(co 1991, Massachusetts Institute of Technology.
