chiark / gitweb /
cf79d6d5b17069f7a6310b99dbdb4e984dea6a88
[sympathy.git] / 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.11  2008/02/27 01:31:38  james
14  * *** empty log message ***
15  *
16  * Revision 1.10  2008/02/27 01:31:14  james
17  * *** empty log message ***
18  *
19  * Revision 1.9  2008/02/24 00:43:55  james
20  * *** empty log message ***
21  *
22  * Revision 1.8  2008/02/24 00:42:53  james
23  * *** empty log message ***
24  *
25  * Revision 1.7  2008/02/23 11:48:52  james
26  * *** empty log message ***
27  *
28  * Revision 1.6  2008/02/20 18:49:11  staffcvs
29  * *** empty log message ***
30  *
31  * Revision 1.5  2008/02/20 18:31:44  james
32  * *** empty log message ***
33  *
34  * Revision 1.4  2008/02/20 17:18:33  james
35  * *** empty log message ***
36  *
37  * Revision 1.3  2008/02/20 02:11:35  james
38  * *** empty log message ***
39  *
40  * Revision 1.2  2008/02/16 10:58:52  james
41  * *** empty log message ***
42  *
43  * Revision 1.1  2008/02/16 01:30:56  james
44  * *** empty log message ***
45  *
46  */
47
48 #include <stdio.h>
49 #include <stdlib.h>
50
51 void
52 usage (void)
53 {
54
55   fprintf (stderr, "Usage:\n"
56            "sympathy -t      [-K] [-d serialdev|-p] [-b baud] [-f] [-L log] [-u]\n"
57            "sympathy -s      [-K] [-d serialdev|-p] [-b baud] [-f] [-L log] [-u] [-k skt]\n"
58            "                      [-n hlines] [-w width] [-F]\n"
59            "sympathy [-s -c] [-K] [-d serialdev|-p] [-b baud] [-f] [-L log] [-u] [-k skt]\n"
60            "                      [-n hlines] [-w width]\n"
61            "sympathy -c      [-H] [-u] -k skt\n"
62            "sympathy -r id   [-H] [-u]\n"
63            "sympathy {-l|-ls}\n"
64            "sympathy -h\n"
65            "\n"
66            "Main mode:\n"
67            "   -t  terminal emulator mode: one process is started which reads from\n"
68            "          the serial device or ptty and writes to the users terminal.\n"
69            "   -s  server mode: a process is started (and daemonized unless -F is\n"
70            "          given) which listens on a socket, and reads from the serial\n"
71            "          device or ptty.\n"
72            "   -s -c  server and client mode. Fork a server and connect a client\n"
73            "            incompatible with -F. This is the default mode\n"
74            "   -c     client mode: connect to server mode process\n"
75            "   -r id  client mode: connect to server mode process on socket\n"
76            "             ~/.sympathy/id\n"
77            "   -l or -ls  list active sockets in ~/.sympathy\n"
78            "\n"
79            "Options:\n"
80            "   -K  lock the serial device. By default sympathy checks that no\n"
81            "          other process has create a lock file, and temporarily ceases\n"
82            "          to access the serial port if it spots one. With this option\n"
83            "          sympathy creates a lock file and prevents other programs\n"
84            "          accessing the serial port. Incompatible with -p\n"
85            "   -d serialdev  the serial device to connect to, eg /dev/ttyS0\n"
86            "   -p   fork a login shell in a pty and connect to that rather than\n"
87            "           connect to a serial port. This option is the default if\n"
88            "           no -d option is specified\n"
89            "   -b baud  the baudrate to set. If omitted sympathy does not set\n"
90            "              a baudrate and uses the current setting\n"
91            "   -f  set RTS/CTS flowcontrol. By default sympathy disables flow\n"
92            "         control\n"
93            "   -k socket  explicity set the name of the socket, by default\n"
94            "                sympathy will use ~/.sympathy/$pid\n"
95            "   -F  do not detach, run the server in the foreground\n"
96            "   -H  instead of connecting the user's terminal to the session\n"
97            "         emit HTML of the current state of the screen on stdout\n"
98            "   -L log  log activity on the device to the file log\n"
99            "   -n  hlines  the number of lines of history to store in the\n"
100            "                 server, that are replayed on connexion\n"
101            "   -u  don't emit utf-8 try to use ISO-2202 to the local terminal\n"
102            "   -w width  start session with a screen of width width<=132\n");
103
104
105   exit (1);
106 }