3 <title>User interface options - XBoard</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="XBoard">
6 <meta name="generator" content="makeinfo 4.13">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Options.html#Options" title="Options">
9 <link rel="prev" href="Load-and-Save-options.html#Load-and-Save-options" title="Load and Save options">
10 <link rel="next" href="Adjudication-Options.html#Adjudication-Options" title="Adjudication Options">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <meta http-equiv="Content-Style-Type" content="text/css">
13 <style type="text/css"><!--
14 pre.display { font-family:inherit }
15 pre.format { font-family:inherit }
16 pre.smalldisplay { font-family:inherit; font-size:smaller }
17 pre.smallformat { font-family:inherit; font-size:smaller }
18 pre.smallexample { font-size:smaller }
19 pre.smalllisp { font-size:smaller }
20 span.sc { font-variant:small-caps }
21 span.roman { font-family:serif; font-weight:normal; }
22 span.sansserif { font-family:sans-serif; font-weight:normal; }
27 <a name="User-interface-options"></a>
29 Next: <a rel="next" accesskey="n" href="Adjudication-Options.html#Adjudication-Options">Adjudication Options</a>,
30 Previous: <a rel="previous" accesskey="p" href="Load-and-Save-options.html#Load-and-Save-options">Load and Save options</a>,
31 Up: <a rel="up" accesskey="u" href="Options.html#Options">Options</a>
35 <h3 class="section">3.5 User interface options</h3>
37 <p><a name="index-User-interface-options-314"></a><a name="index-Options_002c-User-interface-315"></a>
39 <dt>-display<dt>-geometry<dt>-iconic<dd><a name="index-display_002c-option-316"></a><a name="index-geometry_002c-option-317"></a><a name="index-iconic_002c-option-318"></a>These and most other standard Xt options are accepted.
40 <br><dt>-noGUI<dd><a name="index-noGUI_002c-option-319"></a>Suppresses all GUI functions of XBoard
41 (to speed up automated ultra-fast engine-engine games, which you dont want to watch).
42 There will be no board or clock updates, no printing of moves,
43 and no update of the icon on the task bar in this mode.
44 <br><dt>-movesound/-xmovesound or -ringBellAfterMoves true/false<dd><a name="index-movesound_002c-option-320"></a><a name="index-bell_002c-option-321"></a><a name="index-ringBellAfterMoves_002c-option-322"></a>Sets the Move Sound menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
45 For compatibility with old XBoard versions, -bell/-xbell are also
46 accepted as abbreviations for this option.
47 <br><dt>-exit/-xexit or -popupExitMessage true/false<dd><a name="index-exit_002c-option-323"></a><a name="index-popupExitMessage_002c-option-324"></a>Sets the Popup Exit Message menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
48 <br><dt>-popup/-xpopup or -popupMoveErrors true/false<dd><a name="index-popup_002c-option-325"></a><a name="index-popupMoveErrors_002c-option-326"></a>Sets the Popup Move Errors menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
49 <br><dt>-queen/-xqueen or -alwaysPromoteToQueen true/false<dd><a name="index-queen_002c-option-327"></a><a name="index-alwaysPromoteToQueen_002c-option-328"></a>Sets the Always Queen menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
50 <br><dt>-legal/-xlegal or -testLegality true/false<dd><a name="index-legal_002c-option-329"></a><a name="index-testLegality_002c-option-330"></a>Sets the Test Legality menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
51 <br><dt>-size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)<dd><a name="index-size_002c-option-331"></a><a name="index-boardSize_002c-option-332"></a><a name="index-board-size-333"></a>Determines how large the board will be, by selecting the pixel size
52 of the pieces and setting a few related parameters.
53 The sizeName can be one of: Titanic, giving 129x129 pixel pieces,
54 Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky 72x72,
55 Medium 64x64, Moderate 58x58, Average 54x54, Middling 49x49, Mediocre
56 45x45, Small 40x40, Slim 37x37, Petite 33x33, Dinky 29x29, Teeny 25x25,
58 Orthodox pieces of all these sizes are built into XBoard.
60 be used if you have them; see the pixmapDirectory and bitmapDirectory
62 Complete sets of un-orthodox pieces are only provided in sizes
63 Bulky, Middling and (to a lesser extent) Petite;
64 Archbishop, Marshall and Amazon are also available in all sizes between
66 When no bitmap is available, the piece will be displayed as Amazon or King.
67 The default depends on the size of your screen; it is approximately the
68 largest size that will fit without clipping.
70 <p>You can select other sizes or vary other layout parameters by providing
71 a list of comma-separated values (with no spaces) as the argument.
72 You do not need to provide all the values; for any you omit from the
73 end of the list, defaults are taken from the nearest built-in size.
74 The value <code>n1</code> gives the piece size, <code>n2</code> the width of the
76 between squares, <code>n3</code> the desired size for the
77 clockFont, <code>n4</code> the desired size for the coordFont,
78 <code>n5</code> the desired size for the default font,
79 <code>n6</code> the smallLayout flag (0 or 1),
80 and <code>n7</code> the tinyLayout flag (0 or 1).
81 All dimensions are in pixels.
82 If the border between squares is eliminated (0 width), the various
83 highlight options will not work, as there is nowhere to draw the highlight.
84 If smallLayout is 1 and <code>titleInWindow</code> is true,
85 the window layout is rearranged to make more room for the title.
86 If tinyLayout is 1, the labels on the menu bar are abbreviated
87 to one character each and the buttons in the button bar are made narrower.
88 <br><dt>-coords/-xcoords or -showCoords true/false<dd><a name="index-coords_002c-option-334"></a><a name="index-showCoords_002c-option-335"></a>Sets the Show Coords menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
89 The <code>coordFont</code> option specifies what font to use.
90 <br><dt>-autoraise/-xautoraise or -autoRaiseBoard true/false<dd><a name="index-autoraise_002c-option-336"></a><a name="index-autoRaiseBoard_002c-option-337"></a>Sets the Auto Raise Board menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
91 <br><dt>-autoflip/-xautoflip or -autoFlipView true/false<dd><a name="index-autoflip_002c-option-338"></a><a name="index-autoFlipView_002c-option-339"></a>Sets the Auto Flip View menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
92 <br><dt>-flip/-xflip or -flipView true/false<dd><a name="index-flip_002c-option-340"></a><a name="index-flipView_002c-option-341"></a>If Auto Flip View is not set, or if you are observing but not participating
93 in a game, then the positioning of the board at the start of each game
94 depends on the flipView option. If flipView is false (the default),
95 the board is positioned so that the white pawns move from the bottom to the
96 top; if true, the black pawns move from the bottom to the top.
97 In any case, the Flip menu option (see <a href="Options-Menu.html#Options-Menu">Options Menu</a>)
98 can be used to flip the board after
100 <br><dt>-title/-xtitle or -titleInWindow true/false<dd><a name="index-title_002c-option-342"></a><a name="index-titleInWindow_002c-option-343"></a>If this option is true, XBoard displays player names (for ICS
101 games) and game file names (for ‘<samp><span class="samp">Load Game</span></samp>’) inside its main
102 window. If the option is false (the default), this information is
103 displayed only in the window banner. You probably won't want to
104 set this option unless the information is not showing up in the
105 banner, as happens with a few X window managers.
106 <br><dt>-buttons/-xbuttons or -showButtonBar True/False<dd><a name="index-buttons_002c-option-344"></a><a name="index-showButtonBar_002c-option-345"></a>If this option is False, xboard omits the [<<] [<] [P] [>] [>>] button
107 bar from the window, allowing the message line to be wider. You can
108 still get the functions of these buttons using the menus or their keyboard
109 shortcuts. Default: true.
110 <br><dt>-mono/-xmono or -monoMode true/false<dd><a name="index-mono_002c-option-346"></a><a name="index-monoMode_002c-option-347"></a>Determines whether XBoard displays its pieces and squares with
111 two colors (true) or four (false). You shouldn't have to
112 specify <code>monoMode</code>; XBoard will determine if it is necessary.
113 <br><dt>-showTargetSquares true/false<dd><a name="index-showTargetSquares_002c-option-348"></a>Determines whether XBoard can highlight the squares a piece has
114 legal moves to, when you grab that piece with the mouse.
115 If this option is set, this feature can be controlled through
116 the Highlight Dragging menu item.
117 <br><dt>-flashCount count<dt>-flashRate rate<dt>-flash/-xflash<dd><a name="index-flashCount_002c-option-349"></a><a name="index-flashRate_002c-option-350"></a><a name="index-flash_002c-option-351"></a><a name="index-xflash_002c-option-352"></a>These options enable flashing of pieces when they
118 land on their destination square.
119 <code>flashCount</code>
120 tells XBoard how many times to flash a piece after it
121 lands on its destination square.
122 <code>flashRate</code>
123 controls the rate of flashing (flashes/sec).
126 sets flashCount to 3.
128 sets flashCount to 0.
129 Defaults: flashCount=0 (no flashing), flashRate=5.
130 <br><dt>-highlight/-xhighlight or -highlightLastMove true/false<dd><a name="index-highlight_002c-option-353"></a><a name="index-highlightLastMove_002c-option-354"></a>Sets the Highlight Last Move menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
131 <br><dt>-highlightMoveWithArrow true/false<dd><a name="index-highlight-Arrow_002c-option-355"></a><a name="index-highlightMoveWithArrow_002c-option-356"></a>Sets the Highlight with Arrow menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
132 <br><dt>-blind/-xblind or -blindfold true/false<dd><a name="index-blind_002c-option-357"></a><a name="index-blindfold_002c-option-358"></a>Sets the Blindfold menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
133 <br><dt>-clockFont font<dd><a name="index-clockFont_002c-option-359"></a><a name="index-Font_002c-clock-360"></a>The font used for the clocks. If the option value is a pattern
134 that does not specify the font size, XBoard tries to choose an
135 appropriate font for the board size being used.
136 Default: -*-helvetica-bold-r-normal–*-*-*-*-*-*-*-*.
137 <br><dt>-coordFont font<dd><a name="index-coordFont_002c-option-361"></a><a name="index-Font_002c-coordinates-362"></a>The font used for rank and file coordinate labels if <code>showCoords</code>
138 is true. If the option value is a pattern that does not specify
139 the font size, XBoard tries to choose an appropriate font for
140 the board size being used.
141 Default: -*-helvetica-bold-r-normal–*-*-*-*-*-*-*-*.
142 <br><dt>-font font<dd><a name="index-font_002c-option-363"></a><a name="index-Font-364"></a>The font used for popup dialogs, menus, comments, etc.
143 If the option value is a pattern that does not specify
144 the font size, XBoard tries to choose an appropriate font for
145 the board size being used.
146 Default: -*-helvetica-medium-r-normal–*-*-*-*-*-*-*-*.
147 <br><dt>-fontSizeTolerance tol<dd><a name="index-fontSizeTolerance_002c-option-365"></a>In the font selection algorithm, a nonscalable font will be preferred
148 over a scalable font if the nonscalable font's size differs
149 by <code>tol</code> pixels
150 or less from the desired size. A value of -1 will force
151 a scalable font to always be used if available; a value of 0 will
152 use a nonscalable font only if it is exactly the right size;
153 a large value (say 1000) will force a nonscalable font to always be
154 used if available. Default: 4.
155 <br><dt>-bm or -bitmapDirectory dir<dt>-pixmap or -pixmapDirectory dir<dd><a name="index-bm_002c-option-366"></a><a name="index-bitmapDirectory_002c-option-367"></a><a name="index-pixmap_002c-option-368"></a><a name="index-pixmapDirectory_002c-option-369"></a>These options control what piece images xboard uses. The XBoard
156 distribution includes one set of pixmap pieces in xpm format, in the
157 directory <samp><span class="file">pixmaps</span></samp>, and one set of bitmap pieces in xbm format,
158 in the directory <samp><span class="file">bitmaps</span></samp>. Pixmap
159 pieces give a better appearance on the screen: the white pieces have
160 dark borders, and the black pieces have opaque internal details. With
161 bitmaps, neither piece color has a border, and the internal details
162 are transparent; you see the square color or other background color
165 <p>If XBoard is configured and compiled on a system that includes libXpm,
166 the X pixmap library, the xpm pixmap pieces are compiled in as the
167 default. A different xpm piece set can be selected at runtime with
168 the <code>pixmapDirectory</code> option, or a bitmap piece set can be selected
169 with the <code>bitmapDirectory</code> option.
171 <p>If XBoard is configured and compiled on a system that does not include
172 libXpm (or the <code>--disable-xpm</code> option is given to the configure
173 program), the bitmap pieces are compiled in as the default. It is not
174 possible to use xpm pieces in this case, but pixmap pieces in another
175 format called "xim" can be used by giving the <code>pixmapDirectory</code> option.
176 Or again, a different bitmap piece set can be selected with the
177 <code>bitmapDirectory</code> option.
179 <p>Files in the <code>bitmapDirectory</code> must be named as follows:
180 The first character of a piece bitmap name gives the piece it
181 represents (‘<samp><span class="samp">p</span></samp>’, ‘<samp><span class="samp">n</span></samp>’, ‘<samp><span class="samp">b</span></samp>’, ‘<samp><span class="samp">r</span></samp>’, ‘<samp><span class="samp">q</span></samp>’, or ‘<samp><span class="samp">k</span></samp>’),
182 the next characters give the size in pixels, the
183 following character indicates whether the piece is
184 solid or outline (‘<samp><span class="samp">s</span></samp>’ or ‘<samp><span class="samp">o</span></samp>’),
185 and the extension is ‘<samp><span class="samp">.bm</span></samp>’.
186 For example, a solid 80x80 knight would be named <samp><span class="file">n80s.bm</span></samp>.
187 The outline bitmaps are used only in monochrome mode.
188 If bitmap pieces are compiled in and the bitmapDirectory is missing
189 some files, the compiled in pieces are used instead.
191 <p>If the bitmapDirectory option is given,
192 it is also possible to replace xboard's icons and menu checkmark,
193 by supplying files named <samp><span class="file">icon_white.bm</span></samp>, <samp><span class="file">icon_black.bm</span></samp>, and
194 <samp><span class="file">checkmark.bm</span></samp>.
196 <p>For more information about pixmap pieces and how to get additional
197 sets, see <a href="zic2xpm.html#zic2xpm">zic2xpm</a> below.
198 <br><dt>-whitePieceColor color<dt>-blackPieceColor color<dt>-lightSquareColor color<dt>-darkSquareColor color<dt>-highlightSquareColor color<dt>-lowTimeWarningColor color<dd><a name="index-Colors-370"></a><a name="index-whitePieceColor_002c-option-371"></a><a name="index-blackPieceColor_002c-option-372"></a><a name="index-lightSquareColor_002c-option-373"></a><a name="index-darkSquareColor_002c-option-374"></a><a name="index-highlightSquareColor_002c-option-375"></a><a name="index-lowTimeWarningColor_002c-option-376"></a>Colors to use for the pieces, squares, and square highlights.
201 <pre class="example"> -whitePieceColor #FFFFCC
202 -blackPieceColor #202020
203 -lightSquareColor #C8C365
204 -darkSquareColor #77A26D
205 -highlightSquareColor #FFFF00
206 -premoveHighlightColor #FF0000
207 -lowTimeWarningColor #FF0000
209 <p>On a grayscale monitor you might prefer:
211 <pre class="example"> -whitePieceColor gray100
212 -blackPieceColor gray0
213 -lightSquareColor gray80
214 -darkSquareColor gray60
215 -highlightSquareColor gray100
216 -premoveHighlightColor gray70
217 -lowTimeWarningColor gray70
219 <br><dt>-drag/-xdrag or -animateDragging true/false<dd><a name="index-drag_002c-option-377"></a><a name="index-animateDragging_002c-option-378"></a>Sets the Animate Dragging menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
220 <br><dt>-animate/-xanimate or -animateMoving true/false<dd><a name="index-animate_002c-option-379"></a><a name="index-animateMoving_002c-option-380"></a>Sets the Animate Moving menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
221 <br><dt>-animateSpeed n<dd><a name="index-g_t_002danimateSpeed_002c-option-381"></a>Number of milliseconds delay between each animation frame when Animate
223 <br><dt>-autoDisplayComment true/false<dt>-autoDisplayTags true/false<dd><a name="index-g_t_002dautoDisplayComment_002c-option-382"></a><a name="index-g_t_002dautoDisplayTags_002c-option-383"></a>If set to true, these options cause the window with the move comments,
224 and the window with PGN tags, respectively, to pop up automatically when
225 such tags or comments are encountered during the replaying a stored or
226 loaded game. Default: true.
227 <br><dt>-pasteSelection true/false<dd><a name="index-g_t_002dpasteSelection_002c-option-384"></a>If this option is set to true, the Paste Position and Paste Game
228 options paste from the currently selected text. If false, they paste
229 from the clipboard. Default: false.
projects / xboard.git / blob