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.1  2008/02/16 01:30:56  james
  14  * *** empty log message ***
  15  *
  16  */
  17
  18
  19 void usage(void)
  20 {
  21
  22 fprintf(stderr, "Usage:\n"
  23 "sympathy -t      [-l] [-d serialdev|-p] [-b baud] [-h]\n"
  24 "sympathy -s      [-l] [-d serialdev|-p] [-b baud] [-h] [-f] [-k socket]\n"
  25 "sympathy [-s -c] [-l] [-d serialdev|-p] [-b baud] [-h] [-k socket]\n"
  26 "sympathy -c -k socket [-H]\n"
  27 "sympathy -r id [-H]\n"
  28 "\n"
  29 "Main mode:\n"
  30 "   -t  terminal emulator mode: one process is started which reads from\n"
  31 "          the serial device or ptty and writes to the users terminal.\n"
  32 "   -s  server mode: a process is started (and daemonized unless -f is\n"
  33 "          given) which listens on a socket, and reads from the serial\n"
  34 "          device or ptty.\n"
  35 "   -c  client mode: connect to server mode process\n"
  36 "   -s -c  server and client mode. Fork a server and connect a client\n"
  37 "            incompatible with -f. This is the default mode\n"
  38 "   -r id  client mode: connect to server mode process on socket\n"
  39 "             ~/.sympathy/id\n"
  40 "\n"
  41 "Options:\n"
  42 "   -l  lock the serial device. By default sympathy checks that no\n"
  43 "          other process has create a lock file, and temporarily ceases\n"
  44 "          to access the serial port if it spots one. With this option\n"
  45 "          sympathy creates a lock file and prevents other programs\n"
  46 "          accessing the serial port. Incompatible with -p\n"
  47 "   -d serialdev  the serial device to connect to, eg /dev/ttyS0\n"
  48 "   -p   fork a login shell in a pty and connect to that rather than\n"
  49 "           connect to a serial port. This option is the default if\n"
  50 "           no -d option is specified\n"
  51 "   -b baud  the baudrate to set. If omitted sympathy does not set\n"
  52 "              a baudrate and uses the current setting\n"
  53 "   -h  set RTS/CTS flowcontrol. By default sympathy disables flow\n"
  54 "         control\n"
  55 "   -k socket  explicity set the name of the socket, by default\n"
  56 "                sympathy will use ~/.sympathy/$pid\n"
  57 "   -f  do not detach, run the server in the foreground\n"
  58 "   -H  instead of connecting the user's terminal to the session\n"
  59 "         emit HTML of the current state of the screen on stdout\n"
  60 );
  61
  62 exit(1);
  63 }