updatd manual, added FAQ
[xboard.git] / manual / html_node / CMail-options.html
index 6bbff40..f69b154 100644 (file)
@@ -33,63 +33,64 @@ Up:&nbsp;<a rel="up" accesskey="u" href="CMail.html#CMail">CMail</a>
 <h3 class="section">10.1 CMail options</h3>
 
      <dl>
-<dt>-h<dd>Displays <samp><span class="file">cmail</span></samp> usage information. 
-<br><dt>-c<dd>Shows the conditions of the GNU General Public License. 
-See <a href="Copying.html#Copying">Copying</a>. 
-<br><dt>-w<dd>Shows the warranty notice of the GNU General Public License. 
-See <a href="Copying.html#Copying">Copying</a>. 
-<br><dt>-v<dt>-xv<dd>Provides or inhibits verbose output from <samp><span class="file">cmail</span></samp> and XBoard,
-useful for debugging. The
-<code>-xv</code>
-form also inhibits the cmail introduction message. 
-<br><dt>-mail<dt>-xmail<dd>Invokes or inhibits the sending of a mail message containing the move. 
-<br><dt>-xboard<dt>-xxboard<dd>Invokes or inhibits the running of XBoard on the game file. 
-<br><dt>-reuse<dt>-xreuse<dd>Invokes or inhibits the reuse of an existing XBoard to display the
-current game. 
-<br><dt>-remail<dd>Resends the last mail message for that game. This inhibits running
-XBoard. 
-<br><dt>-game &lt;name&gt;<dd>The name of the game to be processed. 
-<br><dt>-wgames &lt;number&gt;<dt>-bgames &lt;number&gt;<dt>-games &lt;number&gt;<dd>Number of games to start as White, as Black or in total. Default is 1 as
-white and none as black. If only one color is specified then none of the
-other color is assumed. If no color is specified then equal numbers of
-White and Black games are started, with the extra game being as White if an
-odd number of total games is specified. 
-<br><dt>-me &lt;short name&gt;<dt>-opp &lt;short name&gt;<dd>A one-word alias for yourself or your opponent. 
-<br><dt>-wname &lt;full name&gt;<dt>-bname &lt;full name&gt;<dt>-name &lt;full name&gt;<dt>-oppname &lt;full name&gt;<dd>The full name of White, Black, yourself or your opponent. 
-<br><dt>-wna &lt;net address&gt;<dt>-bna &lt;net address&gt;<dt>-na &lt;net address&gt;<dt>-oppna &lt;net address&gt;<dd>The email address of White, Black, yourself or your opponent. 
-<br><dt>-dir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> keeps its files. This defaults to the
-environment variable <code>$CMAIL_DIR</code> or failing that, <code>$CHESSDIR</code>,
-<samp><span class="file">$HOME/Chess</span></samp> or <samp><span class="file">~/Chess</span></samp>. It will be created if it does not exist. 
-<br><dt>-arcdir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> archives completed games. Defaults to
-the environment variable <code>$CMAIL_ARCDIR</code> or, in its absence, the same
-directory as cmail keeps its working files (above). 
-<br><dt>-mailprog &lt;mail program&gt;<dd>The program used by cmail to send email messages. This defaults to the
-environment variable <code>$CMAIL_MAILPROG</code> or failing that
-<samp><span class="file">/usr/ucb/Mail</span></samp>, <samp><span class="file">/usr/ucb/mail</span></samp> or <samp><span class="file">Mail</span></samp>. You will need
-to set this variable if none of the above paths fit your system. 
-<br><dt>-gamesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailgames-403"></a>A file containing a list of games with email addresses. This defaults to
-the environment variable <code>$CMAIL_GAMES</code> or failing that
-<samp><span class="file">.cmailgames</span></samp>. 
-<br><dt>-aliasesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailaliases-404"></a>A file containing one or more aliases for a set of email addresses. This
-defaults to the environment variable <code>$CMAIL_ALIASES</code> or failing
-that <samp><span class="file">.cmailaliases</span></samp>. 
-<br><dt>-logFile &lt;file&gt;<dd>A file in which to dump verbose debugging messages that are invoked with
-the &lsquo;<samp><span class="samp">-v</span></samp>&rsquo;
-option. 
-<br><dt>-event &lt;event&gt;<dd>The PGN Event tag (default &lsquo;<samp><span class="samp">Email correspondence game</span></samp>&rsquo;). 
-<br><dt>-site &lt;site&gt;<dd>The PGN Site tag (default &lsquo;<samp><span class="samp">NET</span></samp>&rsquo;). 
-<br><dt>-round &lt;round&gt;<dd>The PGN Round tag (default &lsquo;<samp><span class="samp">-</span></samp>&rsquo;, not applicable). 
-<br><dt>-mode &lt;mode&gt;<dd>The PGN Mode tag (default &lsquo;<samp><span class="samp">EM</span></samp>&rsquo;, Electronic Mail). 
-<br><dt>Other options<dd>Any option flags not listed above are passed through to XBoard. 
-Invoking XBoard through CMail changes the default values of two XBoard
-options: The default value for &lsquo;<samp><span class="samp">-noChessProgram</span></samp>&rsquo; is changed to
-true; that is, by default no chess engine is started.  The default
-value for &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo; is changed to 0; that is, by default
-XBoard immediately goes to the end of the game as played so far,
-rather than stepping through the moves one by one.  You can still set
-these options to whatever values you prefer by supplying them on
-CMail's command line.  See <a href="Options.html#Options">Options</a>. 
+<dt>-h<dd>Displays <samp><span class="file">cmail</span></samp> usage information.\r
+<br><dt>-c<dd>Shows the conditions of the GNU General Public License.\r
+See <a href="Copying.html#Copying">Copying</a>.\r
+<br><dt>-w<dd>Shows the warranty notice of the GNU General Public License.\r
+See <a href="Copying.html#Copying">Copying</a>.\r
+<br><dt>-v<dt>-xv<dd>Provides or inhibits verbose output from <samp><span class="file">cmail</span></samp> and XBoard,\r
+useful for debugging. The\r
+<code>-xv</code>\r
+form also inhibits the cmail introduction message.\r
+<br><dt>-mail<dt>-xmail<dd>Invokes or inhibits the sending of a mail message containing the move.\r
+<br><dt>-xboard<dt>-xxboard<dd>Invokes or inhibits the running of XBoard on the game file.\r
+<br><dt>-reuse<dt>-xreuse<dd>Invokes or inhibits the reuse of an existing XBoard to display the\r
+current game.\r
+<br><dt>-remail<dd>Resends the last mail message for that game. This inhibits running\r
+XBoard.\r
+<br><dt>-game &lt;name&gt;<dd>The name of the game to be processed.\r
+<br><dt>-wgames &lt;number&gt;<dt>-bgames &lt;number&gt;<dt>-games &lt;number&gt;<dd>Number of games to start as White, as Black or in total. Default is 1 as\r
+white and none as black. If only one color is specified then none of the\r
+other color is assumed. If no color is specified then equal numbers of\r
+White and Black games are started, with the extra game being as White if an\r
+odd number of total games is specified.\r
+<br><dt>-me &lt;short name&gt;<dt>-opp &lt;short name&gt;<dd>A one-word alias for yourself or your opponent.\r
+<br><dt>-wname &lt;full name&gt;<dt>-bname &lt;full name&gt;<dt>-name &lt;full name&gt;<dt>-oppname &lt;full name&gt;<dd>The full name of White, Black, yourself or your opponent.\r
+<br><dt>-wna &lt;net address&gt;<dt>-bna &lt;net address&gt;<dt>-na &lt;net address&gt;<dt>-oppna &lt;net address&gt;<dd>The email address of White, Black, yourself or your opponent.\r
+<br><dt>-dir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> keeps its files. This defaults to the\r
+environment variable <code>$CMAIL_DIR</code> or failing that, <code>$CHESSDIR</code>,\r
+<samp><span class="file">$HOME/Chess</span></samp> or <samp><span class="file">~/Chess</span></samp>. It will be created if it does not exist.\r
+<br><dt>-arcdir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> archives completed games. Defaults to\r
+the environment variable <code>$CMAIL_ARCDIR</code> or, in its absence, the same\r
+directory as cmail keeps its working files (above).\r
+<br><dt>-mailprog &lt;mail program&gt;<dd>The program used by cmail to send email messages. This defaults to the\r
+environment variable <code>$CMAIL_MAILPROG</code> or failing that\r
+<samp><span class="file">/usr/ucb/Mail</span></samp>, <samp><span class="file">/usr/ucb/mail</span></samp> or <samp><span class="file">Mail</span></samp>. You will need\r
+to set this variable if none of the above paths fit your system.\r
+<br><dt>-gamesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailgames-406"></a>A file containing a list of games with email addresses. This defaults to\r
+the environment variable <code>$CMAIL_GAMES</code> or failing that\r
+<samp><span class="file">.cmailgames</span></samp>.\r
+<br><dt>-aliasesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailaliases-407"></a>A file containing one or more aliases for a set of email addresses. This\r
+defaults to the environment variable <code>$CMAIL_ALIASES</code> or failing\r
+that <samp><span class="file">.cmailaliases</span></samp>.\r
+<br><dt>-logFile &lt;file&gt;<dd>A file in which to dump verbose debugging messages that are invoked with\r
+the &lsquo;<samp><span class="samp">-v</span></samp>&rsquo;\r
+option.\r
+<br><dt>-event &lt;event&gt;<dd>The PGN Event tag (default &lsquo;<samp><span class="samp">Email correspondence game</span></samp>&rsquo;).\r
+<br><dt>-site &lt;site&gt;<dd>The PGN Site tag (default &lsquo;<samp><span class="samp">NET</span></samp>&rsquo;).\r
+<br><dt>-round &lt;round&gt;<dd>The PGN Round tag (default &lsquo;<samp><span class="samp">-</span></samp>&rsquo;, not applicable).\r
+<br><dt>-mode &lt;mode&gt;<dd>The PGN Mode tag (default &lsquo;<samp><span class="samp">EM</span></samp>&rsquo;, Electronic Mail).\r
+<br><dt>Other options<dd>Any option flags not listed above are passed through to XBoard.\r
+Invoking XBoard through CMail changes the default values of two XBoard\r
+options: The default value for &lsquo;<samp><span class="samp">-noChessProgram</span></samp>&rsquo; is changed to\r
+true; that is, by default no chess engine is started.  The default\r
+value for &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo; is changed to 0; that is, by default\r
+XBoard immediately goes to the end of the game as played so far,\r
+rather than stepping through the moves one by one.  You can still set\r
+these options to whatever values you prefer by supplying them on\r
+CMail's command line.  See <a href="Options.html#Options">Options</a>.\r
 </dl>
+\r
 
    </body></html>