manual/html_node/CMail-options.html

   1 <html lang="en">
   2 <head>
   3 <title>CMail 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="up" href="CMail.html#CMail" title="CMail">
   9 <link rel="next" href="CMail-game.html#CMail-game" title="CMail game">
  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="CMail-options"></a>
  28 Next:&nbsp;<a rel="next" accesskey="n" href="CMail-game.html#CMail-game">CMail game</a>,
  29 Up:&nbsp;<a rel="up" accesskey="u" href="CMail.html#CMail">CMail</a>
  30 <hr>
  31 </div>
  32
  33 <h3 class="section">10.1 CMail options</h3>
  34
  35      <dl>
  36 <dt>-h<dd>Displays <samp><span class="file">cmail</span></samp> usage information.
  37 <br><dt>-c<dd>Shows the conditions of the GNU General Public License.
  38 See <a href="Copying.html#Copying">Copying</a>.
  39 <br><dt>-w<dd>Shows the warranty notice of the GNU General Public License.
  40 See <a href="Copying.html#Copying">Copying</a>.
  41 <br><dt>-v<dt>-xv<dd>Provides or inhibits verbose output from <samp><span class="file">cmail</span></samp> and XBoard,
  42 useful for debugging. The
  43 <code>-xv</code>
  44 form also inhibits the cmail introduction message.
  45 <br><dt>-mail<dt>-xmail<dd>Invokes or inhibits the sending of a mail message containing the move.
  46 <br><dt>-xboard<dt>-xxboard<dd>Invokes or inhibits the running of XBoard on the game file.
  47 <br><dt>-reuse<dt>-xreuse<dd>Invokes or inhibits the reuse of an existing XBoard to display the
  48 current game.
  49 <br><dt>-remail<dd>Resends the last mail message for that game. This inhibits running
  50 XBoard.
  51 <br><dt>-game &lt;name&gt;<dd>The name of the game to be processed.
  52 <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
  53 white and none as black. If only one color is specified then none of the
  54 other color is assumed. If no color is specified then equal numbers of
  55 White and Black games are started, with the extra game being as White if an
  56 odd number of total games is specified.
  57 <br><dt>-me &lt;short name&gt;<dt>-opp &lt;short name&gt;<dd>A one-word alias for yourself or your opponent.
  58 <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.
  59 <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.
  60 <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
  61 environment variable <code>$CMAIL_DIR</code> or failing that, <code>$CHESSDIR</code>,
  62 <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.
  63 <br><dt>-arcdir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> archives completed games. Defaults to
  64 the environment variable <code>$CMAIL_ARCDIR</code> or, in its absence, the same
  65 directory as cmail keeps its working files (above).
  66 <br><dt>-mailprog &lt;mail program&gt;<dd>The program used by cmail to send email messages. This defaults to the
  67 environment variable <code>$CMAIL_MAILPROG</code> or failing that
  68 <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
  69 to set this variable if none of the above paths fit your system.
  70 <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
  71 the environment variable <code>$CMAIL_GAMES</code> or failing that
  72 <samp><span class="file">.cmailgames</span></samp>.
  73 <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
  74 defaults to the environment variable <code>$CMAIL_ALIASES</code> or failing
  75 that <samp><span class="file">.cmailaliases</span></samp>.
  76 <br><dt>-logFile &lt;file&gt;<dd>A file in which to dump verbose debugging messages that are invoked with
  77 the &lsquo;<samp><span class="samp">-v</span></samp>&rsquo;
  78 option.
  79 <br><dt>-event &lt;event&gt;<dd>The PGN Event tag (default &lsquo;<samp><span class="samp">Email correspondence game</span></samp>&rsquo;).
  80 <br><dt>-site &lt;site&gt;<dd>The PGN Site tag (default &lsquo;<samp><span class="samp">NET</span></samp>&rsquo;).
  81 <br><dt>-round &lt;round&gt;<dd>The PGN Round tag (default &lsquo;<samp><span class="samp">-</span></samp>&rsquo;, not applicable).
  82 <br><dt>-mode &lt;mode&gt;<dd>The PGN Mode tag (default &lsquo;<samp><span class="samp">EM</span></samp>&rsquo;, Electronic Mail).
  83 <br><dt>Other options<dd>Any option flags not listed above are passed through to XBoard.
  84 Invoking XBoard through CMail changes the default values of two XBoard
  85 options: The default value for &lsquo;<samp><span class="samp">-noChessProgram</span></samp>&rsquo; is changed to
  86 true; that is, by default no chess engine is started.  The default
  87 value for &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo; is changed to 0; that is, by default
  88 XBoard immediately goes to the end of the game as played so far,
  89 rather than stepping through the moves one by one.  You can still set
  90 these options to whatever values you prefer by supplying them on
  91 CMail's command line.  See <a href="Options.html#Options">Options</a>.
  92 </dl>
  93
  94    </body></html>
  95