X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=sympathy.git;a=blobdiff_plain;f=sympathy.1;h=17beda2c2a12948828ef6704929af0a7383dba9b;hp=8e557e265abefde9103c01d25a152376bdc916f0;hb=71068879d167a5e26547d5a83d996591fe79e919;hpb=2251d7af0ca5f5f9e88cd49989c90e3333873764 diff --git a/sympathy.1 b/sympathy.1 index 8e557e2..17beda2 100644 --- a/sympathy.1 +++ b/sympathy.1 @@ -82,7 +82,7 @@ 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 +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 terminal emulator such as cu(1) or minicom(1). .TP 5 @@ -90,7 +90,7 @@ terminal emulator such as cu(1) or minicom(1). act as server only: .I sympathy opens the terminal device and renders into an internal frame buffer, listens for clients -on the socket and logs activity. By default the server will fork into a daemon processes +on the socket and logs activity. By default the server will fork into a daemon process but can be forced to remain in the foreground with the \-\fBF\fP option. .TP 5 .B \-c\fP or \fB\-r\fP \fIid\fP @@ -313,29 +313,29 @@ emulator (usually by pressing CTRL\-B), typing the command and pressing return. command is entered the status line changes to `:' and rudimentary line editing is available. Whilst the command is entered the cursor \fBdoes not move\fP but remains where the terminal emulator has placed it. Valid commands are: -.TP 5 +.TP 7 .B ansi switch from VT102 behaviour to ANSI behaviour. The most noticeable difference is the so called `xn' glitch. -.TP 5 +.TP 7 .B noansi switch from ANSI behaviour to VT102 behaviour. -.TP 5 +.TP 7 .B baud \fInnnn\fB set the current baud\-rate to nnnn -.TP 5 -.B break \fInnnn\fB +.TP 7 +.B break send the break signal by asserting the TX line for longer than a frame period. -.TP 5 +.TP 7 .B flow enable RTS/CTS flow control -.TP 5 +.TP 7 .B noflow disable RTS/CTS flow control -.TP 5 +.TP 7 .B hangup de-assert DTR for one second. -.TP 5 +.TP 7 .B quit exit this instance of sympathy (disconnect from the server if present) .SH CHARACTER ENCODINGS @@ -349,18 +349,18 @@ will be interpreted as the one byte CSI character. .PP For the outer terminal emulator 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\fI switch to force +does not, however, support UTF\-8 use the \-\fBu\fP switch to force .I sympathy to use the VT102 subset of ISO-2202. .SH LOG FILES Log files are made exclusively in the UTF\-8 encoding. Each line in the log file starts with the date and time at which the entry was made \- for example: -.br +.IP Feb 27 23:24:42.509440 -.br +.PP .I Sympathy logs a line to the file whenever the cursor leaves the line. Additionally sympathy -logs certain other events to the file when the baud\-rate is changed +logs certain other events to the file. When the baud\-rate is changed .I sympathy writes . Whenever a modem control line changes state .I sympathy @@ -384,15 +384,18 @@ Invalid UTF\-8 sequences are also reported .IP .SH ENVIRONMENT -.I sympathy uses the \fBHOME\fI environment variable to determine the default -location for sockets. .br -.I sympathy sets the value of \fBTERM\fI in pseudo-ttys spawned using the +.I sympathy +uses the \fBHOME\fP environment variable to determine the default +location for sockets. +.br +.I sympathy +sets the value of \fBTERM\fP in pseudo-ttys spawned using the \-\fBp\fP argument to `xterm' .SH EMULATION .I Sympathy completely emulates a VT102 terminal (including the VT52 emulation). .I Sympathy -also emulates a few extra sequences: the xterm(1) CSI ] ... sequences, and +also emulates a few extra sequences: the xterm(1) ESC ] ... sequences, and the ANSI CSI @ and CSI b sequences. The numeric keypad follows exactly the sequences produced by an xterm rather than the exact VT102/VT220 sequences. .I Sympathy @@ -419,9 +422,10 @@ For a \fBnull modem\fP cable local DSR and DTR are wired to remote CD, local CTS to remote RTS, and local RTS to remote CTS. Thus asserting local DTR asserts local DSR and remote CD, and asserting local RTS asserts remote CTS. .PP -When RTS/CTS flow control is in operation the operating system or the hardware -de-asserts RTS when its buffer becomes full causing (via the DCEs or the null -modem cable) a de-assertion of remote CTS which causes the remote to cease transmission. +When RTS/CTS flow control is in operation and the receive buffer becomes full, +the operating system, or the hardware, de-asserts RTS, causing (via the DCEs or +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): @@ -470,15 +474,16 @@ 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 /root/sympathy/13.log. +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. .IP -A user wishing to see the current status of the /dev/ttyS13 issues: +A user wishing to see the current status of /dev/ttyS13 issues: .IP [foo@barhost ~]$ sympathy \-c \-k /root/sympathy/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. +terminal emulator and she is connected to /dev/ttyS13. The user disconnects from the +server by issuing CTRL\-B quit. .SH SEE ALSO screen(1) minicom(1) consolidate(1) .SH STANDARDS @@ -495,5 +500,9 @@ 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 \-\fBc\fP \-\fBs\fP major mode. +.IP \(bu 3 +no facility is made for rotation of the log files. +.SH AUTHOR +James McKenzie, james@fishsoup.dhs.org .SH AUTHOR James McKenzie, james@fishsoup.dhs.org