aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjames <>2008-03-03 17:57:59 +0000
committerjames <>2008-03-03 17:57:59 +0000
commitcc8ec8a155e807055114097d4add1ca43bcb03ca (patch)
tree79c29162a74be2acf7149f4cd561794dec2eadef
parent09cfd08ef42fdbb9ee786c6916d07b2e7c75b800 (diff)
downloadsympathy-cc8ec8a155e807055114097d4add1ca43bcb03ca.tar.gz
sympathy-cc8ec8a155e807055114097d4add1ca43bcb03ca.tar.bz2
sympathy-cc8ec8a155e807055114097d4add1ca43bcb03ca.zip
*** empty log message ***
-rw-r--r--sympathy.188
1 files changed, 58 insertions, 30 deletions
diff --git a/sympathy.1 b/sympathy.1
index 00dad8b..2386d8d 100644
--- a/sympathy.1
+++ b/sympathy.1
@@ -67,7 +67,8 @@ receive errors on the terminal device.
unlike screen(1), takes care to preserve the scroll-back features
of the outer terminal emulator: lines that scroll of the top of the internal
frame buffer are scrolled off the top of the outer terminal emulator. When
-sympathy is used in client/server mode, some history is added to the outer
+.I sympathy
+is used in client/server mode, some history is added to the outer
terminal emulator when the client connects.
.PP
.I Sympathy
@@ -82,8 +83,11 @@ of any line on the frame buffer as the cursor moves off it.
.B \-t
act as terminal emulator only:
.I sympathy
-opens the terminal device and outputs into the outer terminal emulator. When sympathy exits the
-device is closed and no process remains. In this mode sympathy behaves like a traditional
+opens the terminal device and outputs into the outer terminal emulator. When
+.I sympathy exits the
+device is closed and no process remains. In this mode
+.I sympathy
+behaves like a traditional
terminal emulator such as cu(1) or minicom(1).
.TP 5
.B \-s
@@ -96,14 +100,20 @@ but can be forced to remain in the foreground with the \-\fBF\fP option.
.B \-c\fP or \fB\-r\fP \fIid\fP
act as client only:
.I sympathy
-connects to a sympathy server process and injects the history into the outer terminal
+connects to a
+.I sympathy
+server process and injects the history into the outer terminal
emulator,
and connects the user with the terminal device. One server process can support multiple
client processes. This mode can also be used to obtain a dump of the current screen
-in HTML format (see the \-\fBH\fP option). The \-\fPr\fP option connects to a server
-on the socket ~/.sympathy/\fIid\fP or if \fIid\fP is an integer
-~/.sympathy/\fIhost-name\fP.\fIid\fP mimicking the behaviour of screen(1). With the
-\-\fBc\fP option the socket must be specified with the \-\fBk\fP option.
+in HTML format (see the \-\fBH\fP option). The \-\fPr\fP option connects to a
+server process socket called \fIid\fP, or if \fIid\fP is an integer
+\fIhost-name\fP.\fIid\fP mimicking the behaviour of screen(1).
+.I Sympathy
+searches for the socket in the following directories: \fI~/.sympathy\fP,
+\fI~/sympathy\fP, \fI/etc/sympathy\fP, \fI/var/sympathy\fP.
+With the \-\fBc\fP option the socket must be specified with the \-\fBk\fP
+option.
.TP 5
.B \fP[\fB \-c \-s \fP]
act as both client and server:
@@ -140,7 +150,8 @@ By default
.I sympathy
doesn't
lock the terminal device, but checks periodically for lock files of other processes. If
-sympathy detects another lock file it displays \fBLocked\fP in the status line
+.I sympathy
+detects another lock file it displays \fBLocked\fP in the status line
and refuses I/O on the device until the lock file is removed or becomes invalid.
To lock the device use the \-\fBK\fP option.
.I Sympathy
@@ -157,7 +168,9 @@ terminal device if none is specified.
lock the terminal device specified in the \-\fBd\fP option.
.I Sympathy
generates lock files in a staggering variety of formats and places. For locks
-based on the name of the device sympathy generates lock files for all devices
+based on the name of the device
+.I sympathy
+generates lock files for all devices
with the same major and minor in /dev, /dev/usb and /dev/tts, it uses both normal
and lower case and replaces occurrences of `/' in the device name with both `.' and `_'.
.I Sympathy
@@ -167,13 +180,14 @@ names generates them in any of the following directories that are writable:
/var/spool/locks, /usr/spool/lock, /usr/spool/locks, /usr/spool/uucp/LCK, /var/lock.
Lock files are assumed to be in HDB format.
.TP 5
-.B \-b \fIbaud-rate\fP
+.B \-b \fIbaud\-rate\fP
set the baud\-rate of the terminal device specified in the \-\fBd\fP to
-\fIbaud-rate\fP, if omitted the current baud-rate of the serial port will be
+\fIbaud\-rate\fP, if omitted the current baud\-rate of the serial port will be
used.
.TP 5
.B \-f
-turn on flow control on the terminal device. This option adds \fICRTSCTS\fP to sympathy's default
+turn on flow control on the terminal device. This option adds \fICRTSCTS\fP to
+\fIsympathy\fP's default
\fIc_cflag\fPs of \fICS8|CREAD|CLOCAL\fP.
.TP 5
.B \-L \fIlogfile\fP
@@ -259,7 +273,7 @@ will be visible at the bottom of the screen. The status line shows pertinent
information. The first item on the line reminds you what the current escape character
is, the second indicates the terminal device to which
.I sympathy
-is connected, and the third shows the current baud-rate. Other messages are:
+is connected, and the third shows the current baud\-rate. Other messages are:
.TP 5
.B Flow
indicates that that RTS/CTS flow control is in operation on the terminal device.
@@ -315,7 +329,9 @@ detected by the device for 10 seconds.
.I Sympathy
thinks that you have set the wrong baud\-rate and is unable to determine the correct
one as the current baud\-rate is lower than the correct baud\-rate. Use the \fBbaud\fP command
-to set a higher baud\-rate (eg 115200) and sympathy will try again.
+to set a higher baud\-rate (eg 115200) and
+.I sympathy
+will try again.
.TP 5
.B try \fIrate\fBb
.I Sympathy
@@ -365,7 +381,9 @@ reset the terminal emulator
expand the size of the screen to fit the size of the current outer terminal emulator window
.TP 7
.B quit
-exit this instance of sympathy (disconnect from the server if present)
+exit this instance of
+.I sympathy
+(disconnect from the server if present)
.SH CHARACTER ENCODINGS
For characters between 32 and 126
.I sympathy
@@ -375,7 +393,9 @@ however the UTF\-8 is invalid they will instead be interpreted as characters
from ISO_8859-1(7). Character 155 (0x9b) when not part of a valid UTF\-8 sequence
will be interpreted as the one byte CSI character.
.PP
-For the outer terminal emulator sympathy by default issues the
+For the outer terminal emulator
+.I sympathy
+by default issues the
ESC % G sequence to select UTF\-8 mode and emits valid UTF-8. If the outer terminal
does not, however, support UTF\-8 use the \-\fBu\fP switch to force
.I sympathy
@@ -387,7 +407,8 @@ starts with the date and time at which the entry was made \- for example:
Feb 27 23:24:42.509440
.PP
.I Sympathy
-logs a line to the file whenever the cursor leaves the line. Additionally sympathy
+logs a line to the file whenever the cursor leaves the line. Additionally
+.I sympathy
logs certain other events to the file. When the baud\-rate is changed
.I sympathy
writes <baud changed to 19200>. Whenever a modem control line changes state
@@ -487,7 +508,9 @@ the null modem cable) a de-assertion of remote CTS which in turn causes the
remote DTE to cease transmission.
.SH EXAMPLES
.PP
-using sympathy to mimic screen(1):
+using
+.I sympathy
+to mimic screen(1):
.IP
[foo@barhost ~]$ sympathy
.IP
@@ -503,13 +526,13 @@ sessions are active and issues:
.IP
[foo@barhost ~]$ sympathy \-ls
.br
- barhost.2456 (Active)
+ /home/foouser/.sympathy/barhost.8843 (Active)
.br
[root@barhost ~]$
.IP
The user then issues:
.IP
-[foo@barhost ~]$ sympathy \-r 2456
+[foo@barhost ~]$ sympathy \-r 8843
.IP
and is reconnected to her session.
.PP
@@ -521,24 +544,32 @@ using sympathy to mimic minicom(1):
.I Sympathy
opens the device /dev/modem and locks it, sets the baud\-rate to 9600 baud and disables
flow control. A VT102 terminal emulator then displays the data from the modem. The user
-quits the emulator by issuing CTRL\-B quit, which unlocks the modem and exits sympathy.
+quits the emulator by issuing CTRL\-B quit, which unlocks the modem and exits
+.I sympathy.
.PP
-using sympathy to mimic consolidate(1):
+using
+.I sympathy
+to mimic consolidate(1):
.IP
.IP
-[foo@barhost ~]$ sympathy \-s \-d /dev/ttyS13 \-b 19200 \-K \-k /root/sympathy/13 \-L /root/sympathy/13.log
+[foo@barhost ~]$ sympathy \-s \-d /dev/ttyS13 \-b 19200 \-K \-k /var/sympathy/13 \-L /var/sympathy/13.log -R
.IP
.I Sympathy
becomes a daemon and detaches from the current tty. It then opens the device
/dev/ttyS13 and locks it, sets the baud\-rate to 19200 baud and disables flow
control.
.I Sympathy
-then listens for clients connecting on the socket \fI/root/sympathy/13\fP, whilst logging
-completed lines and changes in status to the file \fI/root/sympathy/13.log\fP.
+then listens for clients connecting on the socket \fI/var/sympathy/13\fP, whilst logging
+completed lines and changes in status to the file \fI/var/sympathy/13.log\fP,
+rotating the log file when it gets too large.
.IP
A user wishing to see the current status of /dev/ttyS13 issues:
.IP
-[foo@barhost ~]$ sympathy \-c \-k /root/sympathy/13
+[foo@barhost ~]$ sympathy \-c \-k /var/sympathy/13
+.br
+or
+.br
+[foo@barhost ~]$ sympathy \-r 13
.IP
and the last 200 lines of history are injected into the history of her outer
terminal emulator and she is connected to /dev/ttyS13. The user disconnects from the
@@ -554,9 +585,6 @@ The command editor and parser should support better line editing.
.IP \(bu 3
It should be possible to change the escape character.
.IP \(bu 3
-When the \-\fBc\fP \-\fBs\fP major mode is used without the \-\fBk\fP option the pid
-used in the socket is that of the client process and therefore not unique.
-.IP \(bu 3
The HTML generated with the \-\fBH\fP option is ugly.
.IP \(bu 3
No useful error message is generated if opening the terminal device fails in the