apps/usage.c

   1 /*
   2  * usage.c:
   3  *
   4  * Copyright (c) 2008 James McKenzie <james@fishsoup.dhs.org>,
   5  * All rights reserved.
   6  *
   7  */
   8
   9 static char rcsid[] = "$Id$";
  10
  11 /*
  12  * $Log$
  13  * Revision 1.17  2008/02/28 16:57:51  james
  14  * *** empty log message ***
  15  *
  16  * Revision 1.16  2008/02/27 18:29:49  james
  17  * *** empty log message ***
  18  *
  19  * Revision 1.15  2008/02/27 16:01:24  james
  20  * *** empty log message ***
  21  *
  22  * Revision 1.14  2008/02/27 09:55:57  james
  23  * *** empty log message ***
  24  *
  25  * Revision 1.13  2008/02/27 09:42:53  james
  26  * *** empty log message ***
  27  *
  28  * Revision 1.12  2008/02/27 09:42:21  james
  29  * *** empty log message ***
  30  *
  31  * Revision 1.11  2008/02/27 01:31:38  james
  32  * *** empty log message ***
  33  *
  34  * Revision 1.10  2008/02/27 01:31:14  james
  35  * *** empty log message ***
  36  *
  37  * Revision 1.9  2008/02/24 00:43:55  james
  38  * *** empty log message ***
  39  *
  40  * Revision 1.8  2008/02/24 00:42:53  james
  41  * *** empty log message ***
  42  *
  43  * Revision 1.7  2008/02/23 11:48:52  james
  44  * *** empty log message ***
  45  *
  46  * Revision 1.6  2008/02/20 18:49:11  staffcvs
  47  * *** empty log message ***
  48  *
  49  * Revision 1.5  2008/02/20 18:31:44  james
  50  * *** empty log message ***
  51  *
  52  * Revision 1.4  2008/02/20 17:18:33  james
  53  * *** empty log message ***
  54  *
  55  * Revision 1.3  2008/02/20 02:11:35  james
  56  * *** empty log message ***
  57  *
  58  * Revision 1.2  2008/02/16 10:58:52  james
  59  * *** empty log message ***
  60  *
  61  * Revision 1.1  2008/02/16 01:30:56  james
  62  * *** empty log message ***
  63  *
  64  */
  65
  66 #include <stdio.h>
  67 #include <stdlib.h>
  68
  69 void
  70 usage (void)
  71 {
  72
  73   fprintf (stderr, "Usage:\n"
  74            "sympathy -t      [-K] [-d serialdev|-p] [-b baud] [-f] [-L log]\n"
  75            "                                  [-w WxH] [-u]\n"
  76            "sympathy -s      [-K] [-d serialdev|-p] [-b baud] [-f] [-L log] [-k skt]\n"
  77            "                      [-n hlines] [-w WxH] [-F]\n"
  78            "sympathy [-s -c] [-K] [-d serialdev|-p] [-b baud] [-f] [-L log] [-k skt]\n"
  79            "                      [-n hlines] [-w WxH] [-u]\n"
  80            "sympathy -c      [-H] [-u] -k skt\n"
  81            "sympathy -r id   [-H] [-u]\n"
  82            "sympathy {-l|-ls}\n"
  83            "sympathy -v\n"
  84            "sympathy -h\n"
  85            "\n"
  86            "Main mode:\n"
  87            "   -t  terminal emulator mode: one process is started which reads from\n"
  88            "          the serial device or ptty and writes to the user's terminal.\n"
  89            "   -s  server mode: a process is started (and daemonized unless -F is\n"
  90            "          given) which listens on a socket, and reads from the serial\n"
  91            "          device or ptty.\n"
  92            "   -s -c  server and client mode: Fork a server and connect a client\n"
  93            "            incompatible with -F. This is the default mode\n"
  94            "   -c     client mode: connect to server mode process\n"
  95            "   -r id  client mode: connect to server mode process on socket\n"
  96            "             ~/.sympathy/id or ~/.sympathy/hostname.id if id is an\n"
  97            "             integer\n"
  98            "   -l or -ls  list active sockets in ~/.sympathy\n"
  99            "   -v   show version\n"
 100            "   -h   show help\n"
 101            "\n"
 102            "Options:\n"
 103            "   -K  lock the serial device. By default sympathy checks that no\n"
 104            "          other process has created a lock file, and temporarily ceases\n"
 105            "          to access the serial port if it spots one. With this option\n"
 106            "          sympathy creates a lock file and prevents other programs\n"
 107            "          accessing the serial port. Incompatible with -p\n"
 108            "   -d serialdev  the serial device to connect to, eg /dev/ttyS0\n"
 109            "   -p   fork a login shell in a ptty and connect to that rather than\n"
 110            "           connect to a serial port. This option is the default if\n"
 111            "           no -d option is specified\n"
 112            "   -b baud  the baudrate to set. If omitted sympathy does not set\n"
 113            "              a baudrate and uses the current setting\n"
 114            "   -f  set RTS/CTS flowcontrol. By default sympathy disables flow\n"
 115            "         control\n"
 116            "   -k socket  explicity set the name of the socket, by default\n"
 117            "                sympathy will use ~/.sympathy/$pid\n"
 118            "   -F  do not detach, run the server in the foreground\n"
 119            "   -H  instead of connecting the user's terminal to the session\n"
 120            "         emit HTML of the current state of the screen on stdout\n"
 121            "   -L log  log activity on the device to the file log\n"
 122            "   -n  hlines  the number of lines of history to store in the\n"
 123            "                 server, that are replayed on connexion\n"
 124            "   -u  don't emit utf-8 try to use ISO-2202 to the local terminal\n"
 125            "   -w W[xH]  start session with a screen of size W by H. 0<W<=132,\n"
 126            "             0<H<24, default 80 by 24\n");
 127
 128
 129   exit (1);
 130 }