updated documentation
[xboard.git] / manual / html_node / Major-modes.html
1 <html lang="en">
2 <head>
3 <title>Major modes - 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="index.html#Top" title="Top">
9 <link rel="next" href="Menus.html#Menus" title="Menus">
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 <h1 class="settitle">XBoard</h1>
26 <div class="node">
27 <p>
28 <a name="Major-modes"></a>
29 Next:&nbsp;<a rel="next" accesskey="n" href="Menus.html#Menus">Menus</a>,
30 Previous:&nbsp;<a rel="previous" accesskey="p" href="index.html#Top">Top</a>,
31 Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
32 <hr>
33 </div>
34
35 <h2 class="chapter">1 Major modes</h2>
36
37 <p><a name="index-Major-modes-2"></a>\r
38 XBoard always runs in one of four major modes.  You select the\r
39 major mode from the command line when you start up XBoard.\r
40 \r
41      <dl>
42 <dt>xboard [options]<dd>As an interface to GNU Chess or another chess engine running on your\r
43 machine, XBoard lets you play a game against the machine,\r
44 set up arbitrary positions, force variations, watch a game between two\r
45 chess engines, interactively analyze your stored games or set up and\r
46 analyze arbitrary positions.  (Note: Not all chess engines support\r
47 analysis.)\r
48 <br><dt>xboard -ics -icshost hostname [options]<dd>As Internet Chess Server (ICS) interface, XBoard\r
49 lets you play against other ICS users, observe games\r
50 they are playing, or review games that have recently finished.  Most\r
51 of the ICS "wild" chess variants are supported, including bughouse.\r
52 <br><dt>xboard -ncp [options]<dd>XBoard can also be used simply\r
53 as an electronic chessboard to play through games. It will read and\r
54 write game files and allow you to play through variations\r
55 manually. You can use it to browse games off the net or review games\r
56 you have saved.  These features are also available in the other modes.\r
57 <br><dt>|pxboard<dd>If you want to pipe games into XBoard, use the supplied shell\r
58 script <samp><span class="file">pxboard</span></samp>.  For example, from the news reader <samp><span class="file">xrn</span></samp>,\r
59 find a message with one or more games in it, click the Save button,\r
60 and type &lsquo;<samp><span class="samp">|pxboard</span></samp>&rsquo; as the file name.\r
61 <br><dt>cmail [options]<dd>As an interface to electronic mail correspondence chess, XBoard\r
62 works with the cmail program. See <a href="CMail.html#CMail">CMail</a> below for\r
63 instructions.\r
64 </dl>
65    \r
66
67    </body></html>
68