aboutsummaryrefslogtreecommitdiffstats
path: root/sympathy.1
diff options
context:
space:
mode:
authorjames <>2008-03-03 06:04:42 +0000
committerjames <>2008-03-03 06:04:42 +0000
commitf2c620137fa5290d913373e5579a97f0fee25fa3 (patch)
treedfbbe3562ae58e8f540a92654cb4f4d7323d59d7 /sympathy.1
parent800cb4bdfb56dcd606216788fb023fcc23fb69bf (diff)
downloadsympathy-f2c620137fa5290d913373e5579a97f0fee25fa3.tar.gz
sympathy-f2c620137fa5290d913373e5579a97f0fee25fa3.tar.bz2
sympathy-f2c620137fa5290d913373e5579a97f0fee25fa3.zip
*** empty log message ***
Diffstat (limited to 'sympathy.1')
-rw-r--r--sympathy.150
1 files changed, 47 insertions, 3 deletions
diff --git a/sympathy.1 b/sympathy.1
index 7a7e436..f85ea8e 100644
--- a/sympathy.1
+++ b/sympathy.1
@@ -177,8 +177,22 @@ turn on flow control on the terminal device. This option adds \fICRTSCTS\fP to s
\fIc_cflag\fPs of \fICS8|CREAD|CLOCAL\fP.
.TP 5
.B \-L \fIlogfile\fP
-log activity to the file \fIlogfile\fP. If \fIlogfile\fP is `-' then log to \fIstdout\fP. Note
-that logging to \fIstdout\fP only makes sense with the \-\fBF\fP \fIserver_option\fP.
+log activity to the file \fIlogfile\fP. If \fIlogfile\fP is `-' then log to
+\fIstdout\fP. Note that logging to \fIstdout\fP only makes sense with the
+\-\fBF\fP \fIserver_option\fP.
+.TP 5
+.B \-P \fIpidfile\fP
+write the pid of the server/terminal process to \fIpidfile\fP, which is
+removed on clean exit.
+.TP 5
+.B \-R
+rotate log files. When the logfile specified with the \fB\-L\fI option
+grows large
+.I sympathy
+will rotate it and compress old logfiles.
+.I Sympathy
+will also close and reopen its log file when it receives a \fBSIGHUP\fP which
+with the \fB\-P\fP allows the use of logrotate(8).
.TP 5
.B \-w \fIwidth\fP[x\fIheight\fP]
set the initial size of the terminal emulator's frame buffer to be \fIwidth\fP columns
@@ -312,7 +326,9 @@ Commands are entered by sending the escape character, ascii(7) STX, from the out
emulator (usually by pressing CTRL\-B), typing the command and pressing return. Whilst the
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:
+emulator has placed it. Pressing the escape character whilst in command mode
+will send the escape character to the terminal and cancel command mode. Valid
+commands are:
.TP 7
.B ansi
switch from VT102 behaviour to ANSI behaviour. The most noticeable difference is
@@ -398,6 +414,34 @@ and the conclusions of the baud\-rate guessing algorithm
Invalid UTF\-8 sequences are also reported
.IP
<invalid utf\-8 sequence: \\301>
+.PP
+The log file is rotate when it gets too large if the \fI\-R\fP option
+is specified, and the log file is re-opened on recipt of a \fBSIGHUP\fP
+which together with the \fB\-P\fP allows the use of of a program such
+as logrotate(8)
+.SH SIGNALS
+.I Sympathy
+reacts to a set of signals. You can use the \fB-P\fI option
+to easily determine the PID of the
+.I sympathy
+process to which you would like to send a signal.
+.TP 8
+.B SIGINT
+.I Sympathy
+will immediately try to restore the outer terminal emulator to its original
+state and then exit.
+.TP 8
+.B SIGHUP
+.I Sympathy
+will close and reopen the log-file specified with the -L option, which allows
+the use of programs like logrotate(8)
+.B SIGWINCH
+.I Sympathy
+will redraw the display in the outer terminal emulator so that it will fit within
+the new display size.
+SIGCHLD
+.I Sympathy
+will wait for children if some were born (for example from compressing rotated logs)
.SH ENVIRONMENT
.I sympathy
uses the \fBHOME\fP environment variable to determine the default