[0m


XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



[1mNAME
     [0mxutil - output information about the X server

[1mSYNOPSIS
     xutil [0m[[1m-screen [0m_n_u_m_b_e_r] [[1m-displayid [0m_d_i_s_p_l_a_y_n_a_m_e] [[1m-help
     [0m[_o_p_t_i_o_n]] [[1m-[0m_o_p_t_i_o_n]

[1mDESCRIPTION
     [0m_X_u_t_i_l is a utility for obtaining information about an X
     server.  All the information which the X server gives to a
     client when the client first connects can be output.  Infor-
     mation is output in a form suitable for use in shell
     scripts, with the _o_p_t_i_o_n controlling which piece of informa-
     tion is produced.

[1mOPTIONS
     -displayid  [0mThis allows the setting of the DISPLAY environ-
		 ment variable to be overwritten.  Where the
		 information produced by _x_u_t_i_l depends on the
		 screen number of the display this option can be
		 used to obtain information about other screens.

     [1m-screen	 [0mThis allows the screen number of the display
		 environment variable or of [1m-displayid [0mto be
		 overridden.  This makes it easy to use _x_u_t_i_l to
		 find out about other screens on the display.

     Only one of the other possible options can be given.

     [1m-help     [0mOutputs usage information for _x_u_t_i_l.  If an argu-
	       ment is given it must be one of the other options
	       (except [1m-exec[0m) in which case help information is
	       output about that option, or the keyword [1moptions
	       [0min which case a list of all the options is pro-
	       duced or [1mall [0min which case full help information
	       for all the options is output.

     [1m-exec     [0mThe remainder of the arguments are treated as a
	       command which will be executed on each screen of
	       the X server.  The DISPLAY environment variable is
	       set to each screen in turn and the given command
	       executed.  The commands are executed in parallel.
	       The _x_u_t_i_l command will succeed if all commands are
	       started successfully.  _X_u_t_i_l makes no attempt to
	       check the exit status of the commands.

     [1m-verbose  [0mThis option functions in the same way as [1m-exec
	       [0mexcept that the display name and the process id of
	       the started commands are printed on the output
	       stream.

     [1m-protocolVersion



[0mPrinted 4/11/91             Release 4				1






XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



	       Prints the major version number of the X protocol
	       - since this is X11 this value should always be
	       11.

     [1m-protocolRevision
	       [0mPrints the minor protocol revision number.
	       Currently this is 0 (there have been no revisions
	       to the protocol).

     [1m-serverVendor
	       [0mIdentification of the X server implemention - the
	       name of the organisation which is responsible for
	       server implementation (which need not be the same
	       as the organisation responsible for the client
	       side - Xlib).  This name will normally be
	       registered with the MIT X Consortium "X Register".
	       The name is used by some applications to work out
	       server specific information.

     [1m-serverRelease
	       [0mPrints the server release number.  The meaning of
	       this number is determined solely by the server
	       implementor; for Acorn servers it is a simple
	       numeric value which gets larger with later
	       releases of our server.

     [1m-imageByteOrder
	       [0mPrints the byte order expected by the server for
	       bitmap data - the order of bytes within a scan
	       line unit (see [1m-scanlineUnit[0m).  For bitmaps the
	       value is only relevant if the scan line unit is 16
	       or 32.  The value then says whether a single scan
	       line unit is transmitted with its least signifi-
	       cant byte first (_x_u_t_i_l will output [1mLSBFirst[0m) or
	       the most significant first ([1mMSBFirst[0m).  Prints the
	       mapping of scan line units to bits on the display
	       is determined by the bitmap bit order - see [1m-
	       bitmapBitOrder[0m.	Notice that the format of bitmap
	       data is determined by the server - the server can
	       handle one and only one format.	This value also
	       specifies the format of 4 bit-per-pixel image data
	       (well, this is what the protocol says) - the
	       implication is that the first (screen left most) 4
	       bit pixel is in the least significant bits of a
	       byte for LSBFirst, and the most significant for
	       MSBFirst.

     [1m-scanlineUnit
	       [0mPrints the number of bits in a single unit of bit-
	       map data provided to the server.  This number will
	       be 8, 16 or 32 (unless there is a bug in the
	       server).  Bitmap data must be transmitted to the



Printed 4/11/91             Release 4				2






XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



	       server in chunks of this size, individual chunks
	       will be encoded in bytes according to the bitmap
	       byte order - see [1m-imageByteOrder[0m.

     [1m-scanlinePad
	       [0mPrints the number of bits which a single scan line
	       of a bitmap sent to the server must be padded to.
	       The server expects each scan line of a bitmap or
	       other image data to be padded to a multiple of
	       this number of bits.  The number will be 8, 16 or
	       32 and will be greater than or equal to the scan
	       line unit size.

     [1m-bitmapBitOrder
	       [0mPrints the bit order (screen left to right) within
	       a single scan line unit of server image data.
	       _X_u_t_i_l will output either [1mLSBFirst [0m(if the least
	       significant bit of a scan line unit is left most
	       on the screen) or [1mMSBFirst [0m(if the most signifi-
	       cant bit of a scan line unit is the left most on
	       the screen).

     [1m-pixmapFormats
	       [0mPrints the image formats supported by the server
	       are output.  Each format is output on a separate
	       line as three decimal numbers separated by tab
	       characters.  The first number is the depth of the
	       format (which can have any value), the second is
	       the number of bits used per pixel in the format
	       (which must be 1, 4, 8, 16, 24 or 32).  The final
	       number gives the scan line padding required by the
	       format; this must be 8, 16 or 32 (bits).

     [1m-motionBufferSize
	       [0mPrints the size of the keyboard mouse motion
	       buffer.	If non-zero this is the approximate
	       number of mouse motion events which the server
	       keeps a record of.

     [1m-minimumKeycode
	       [0mPrints the first keycode used by the server as a
	       decimal number.

     [1m-maximumKeycode
	       [0mPrints the last keycode used by the server as a
	       decimal number.

     [1m-numberOfScreens
	       [0mPrints the number of different screens on this
	       display.

     [1m-screens  [0mThis is the default action of _x_u_t_i_l.  It prints



Printed 4/11/91             Release 4				3






XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



	       the display ids of all the screens of the X
	       server, one per line, on the output.

     The remaining arguments are screen specific - they output
     information about the default screen of the display (this
     will be the screen specified in the DISPLAY environment
     variable).

     [1m-rootWindow
	       [0mPrints the root window id as a hexadecimal number
	       (preceded by 0x).

     [1m-width    [0mPrints the width (in pixels) of the root window.

     [1m-height   [0mPrints the height (in pixels) of the root window.

     [1m-mmwidth  [0mPrints the width (in millimetres) of the screen.
	       This option and the [1m-mmheight [0moption will not be
	       reliable on machines where the monitor can be
	       changed!

     [1m-mmheight [0mPrints the height (in millimetres) of the screen.

     [1m-allowedDepths
	       [0mPrints the depths supported on the screen.  The
	       depths are output as decimal numbers, one per
	       line.

     [1m-rootDepth
	       [0mPrints the depth of the root window.

     [1m-rootVisual
	       [0mPrints the id of the visual of the root window.

     [1m-rootColormap
	       [0mPrints the id of the colour map associated with
	       the root visual.

     [1m-rootColormapCells
	       [0mPrints the number of entries in the default colour
	       map.

     [1m-whitePixel
	       [0mPrints the pixel value of the white pixel.

     [1m-blackPixel
	       [0mPrints the pixel value of the black pixel.

     [1m-minimumInstalledColormaps
	       [0mPrints the minimum number of colour maps which can
	       be installed at once.  The server can guarantee to
	       install at least this number of colour maps at



Printed 4/11/91             Release 4				4






XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



	       once on this screen.

     [1m-maximumInstalledColormaps
	       [0mPrints the maximum number of colour maps which can
	       be installed at once.  The server may install up
	       to this number of colour maps at once - depending
	       on the allocations of colours within the map.

     [1m-backingStore
	       [0mShows what backing store support is available on
	       the default screen.  _X_u_t_i_l will output one of
	       [1mNever [0m(the server does not implement backing
	       store) [1mWhenMapped [0m(the server can provide backing
	       store for windows when they are mapped) or [1mAlways
	       [0m(the server can provide backing store for any win-
	       dow).  Even if the server specifies [1mAlways [0mbacking
	       storage may be limited in other ways.

     [1m-saveUnders
	       [0mShows whether save unders are supported on the
	       default screen.	_X_u_t_i_l will output either [1mtrue [0mor
	       [1mfalse[0m.

     [1m-visualClass
	       [0mPrints the class of the default visual of the
	       screen.	The value printed will be one of [1mSta-
	       ticGray GrayScale StaticColor PseudoColor
	       TrueColor [0mor [1mDirectColor[0m.  These correspond to the
	       constants defined in the X header file
	       /_u_s_r/_i_n_c_l_u_d_e/_X_1_1/_X._h.

     [1m-redMask  [0mPrints the colour map red mask of the default
	       visual as a hexadecimal number.

     [1m-greenMask
	       [0mPrints the colour map green mask of the default
	       visual as a hexadecimal number.

     [1m-blueMask [0mPrints the colour map blue mask of the default
	       visual as a hexadecimal number.

     [1m-bitsPerRGB
	       [0mPrints the number of significant bits per red,
	       green or blue value in the colour maps of the
	       default visual.	The screen can resolve no more
	       red green or blue intensity levels than indicated
	       by this value.

     [1m-visuals  [0mPrints information about all the visuals of the
	       screen.	One line is output per visual supported
	       on this screen.	The information consists of a
	       number of fields separated by tab characters



Printed 4/11/91             Release 4				5






XUTIL(1)	    UNIX Programmer's Manual		 XUTIL(1)



	       (there are no other tab or space characters in the
	       output, so the output can easily be used as input
	       to, for example, _a_w_k(1))._T_h_einformation_i_sas

	       [1mhexadecimal    [0mThe id of the visual.

	       [1mdecimal	      [0mThe depth of the visual.

	       [1mstring	      [0mThe visual class in the same format
			      as the result of [1m-visualClass[0m.

	       [1mhexadecimal    [0mThe colour map red mask.

	       [1mhexadecimal    [0mThe colour map green mask.

	       [1mhexadecimal    [0mThe colour map blue mask.

	       [1mdecimal	      [0mThe size of the colour map (the
			      number of entries).

	       [1mdecimal	      [0mThe number of significant bits in
			      the red, green and blue values in
			      colour map entries.

[1mENVIRONMENT
     DISPLAY   [0mTo get the default host, display number, and (if
	       required) screen.

[1mERRORS
     [0mIf the result returned by the server cannot be represented
     (because the server has a bug in it, or because it
     corresponds to a protocol other than X version 11.0) _x_u_t_i_l
     normally produces output of the form "*** unknown ***", or
     (if the value is an integer) "*** unknown (<value>) ***".
     If a visual class is incorrect the output will be
     InvalidClass<integer>, with <integer> replaced by the number
     the server returned.

[1mSEE ALSO
     [0mX(1), xdpyinfo(1), xwininfo(1), xprop(1), xrdb(1)

[1mCOPYRIGHT
     [0mCopyright 1990 Acorn Computers Ltd

[1mAUTHOR
     [0mJB, Acorn Computers Ltd









Printed 4/11/91             Release 4				6



[0m