* modified description to mention chinese chess and other variants
[xboard.git] / manual / html_node / Options.html
1 <html lang="en">
2 <head>
3 <title>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.12">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="prev" href="Menus.html#Menus" title="Menus">
9 <link rel="next" href="Chess-Servers.html#Chess-Servers" title="Chess Servers">
10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
11 <meta http-equiv="Content-Style-Type" content="text/css">
12 <style type="text/css"><!--
13   pre.display { font-family:inherit }
14   pre.format  { font-family:inherit }
15   pre.smalldisplay { font-family:inherit; font-size:smaller }
16   pre.smallformat  { font-family:inherit; font-size:smaller }
17   pre.smallexample { font-size:smaller }
18   pre.smalllisp    { font-size:smaller }
19   span.sc    { font-variant:small-caps }
20   span.roman { font-family:serif; font-weight:normal; } 
21   span.sansserif { font-family:sans-serif; font-weight:normal; } 
22 --></style>
23 </head>
24 <body>
25 <div class="node">
26 <p>
27 <a name="Options"></a>
28 Next:&nbsp;<a rel="next" accesskey="n" href="Chess-Servers.html#Chess-Servers">Chess Servers</a>,
29 Previous:&nbsp;<a rel="previous" accesskey="p" href="Menus.html#Menus">Menus</a>,
30 Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
31 <hr>
32 </div>
33
34 <h2 class="chapter">3 Options</h2>
35
36 <p><a name="index-Options-111"></a><a name="index-Options-112"></a>
37 This section documents the command-line options to XBoard.  You can
38 set these options in two ways: by typing them on the shell command
39 line you use to start XBoard, or by setting them as X resources
40 (typically in your <samp><span class="file">.Xresources</span></samp> file).  Many of the options
41 cannot be changed while XBoard is running; others set the initial
42 state of items that can be changed with the <a href="Options.html#Options">Options</a> menu.
43
44    <p>Most of the options have both a long name and a short name. To turn a
45 boolean option on or off from the command line, either give its long
46 name followed by the value true or false
47 (&lsquo;<samp><span class="samp">-longOptionName true</span></samp>&rsquo;), or give just the short name to turn the
48 option on (&lsquo;<samp><span class="samp">-opt</span></samp>&rsquo;), or the short name preceded by &lsquo;<samp><span class="samp">x</span></samp>&rsquo; to
49 turn the option off (&lsquo;<samp><span class="samp">-xopt</span></samp>&rsquo;). For options that take strings or
50 numbers as values, you can use the long or short option names
51 interchangeably.
52
53    <p>Each option corresponds to an X resource with the same name, so
54 if you like, you can set options in your <samp><span class="file">.Xresources</span></samp> file
55 or in a file named <samp><span class="file">XBoard</span></samp> in your home directory. 
56 For options that have two names, the longer one is the name of
57 the corresponding X resource; the short name is not recognized. 
58 To turn a boolean option on or off as an
59 X resource, give its long name followed by the value
60 true or false (&lsquo;<samp><span class="samp">XBoard*longOptionName: true</span></samp>&rsquo;).
61
62 <ul class="menu">
63 <li><a accesskey="1" href="Chess-engine-options.html#Chess-engine-options">Chess engine options</a>:         Controlling the chess engine. 
64 <li><a accesskey="2" href="UCI-_002b-WB-Engine-Settings.html#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>:     Setting some very common engine parameters
65 <li><a accesskey="3" href="ICS-options.html#ICS-options">ICS options</a>:                  Connecting to and using ICS. 
66 <li><a accesskey="4" href="Load-and-Save-options.html#Load-and-Save-options">Load and Save options</a>:        Input/output options. 
67 <li><a accesskey="5" href="User-interface-options.html#User-interface-options">User interface options</a>:       Look and feel options. 
68 <li><a accesskey="6" href="Adjudication-Options.html#Adjudication-Options">Adjudication Options</a>:         Control adjudication of engine-engine games. 
69 <li><a accesskey="7" href="Other-options.html#Other-options">Other options</a>:                Miscellaneous. 
70 </ul>
71
72    </body></html>
73