*** empty log message ***

1 files changed, 60 insertions, 22 deletions

diff --git a/sympathy.1 b/sympathy.1
index 5f795cc..2dacc6d 100644
--- a/sympathy.1
+++ b/sympathy.1
@@ -424,37 +424,75 @@ Feb 27 23:24:42.509440
 .I 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 
+.IP \(bu 3
+logs certain other events to the file: 
+.IP \(bu 3
+serial port parameter changes: baud\-rate and flow control.
+.IP \(bu 3
+serial port control line state changes.
+.IP \(bu 3
+serial port line discipline errors.
+.IP \(bu 3
+serial port errors.
+.IP \(bu 3
+suggested baud rates and bit frequency analyses.
+.IP \(bu 3
+transmission of breaks.
+.IP \(bu 3
+sending of the hangup signal (dropping the DTR line).
+.IP \(bu 3
+unknown or unhandled messages sent on the socket.
+.IP \(bu 3
+connexion and disconexion of clients.
+.IP \(bu 3
+recpetion of SIGHUP.
+.IP \(bu 3
+invalid UTF-8 sequences.
+.IP \(bu 3
+terminal size changes
+.IP \(bu 3
+unhandled terminal command sequences
+.PP
+The log file is rotated 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 AUTOMATIC BAUD RATE ALGORYTM
+If
 .I sympathy
-appends <Modem lines changed: \fI+/\-line\fP ...> to the log. Where \fI+\fP
-indicates that \fIline\fP was asserted and \fI-\fP indicates that it was de-asserted.
-.I Sympathy 
-writes a message of the form <size now nnnxnnn> whenever the screen size is
-changed, either by escape sequences, or via a user command.
-When the terminal device reports receive errors 
-.I sympathy 
-adds additional information to the log. It reports the character sequence reporting the error
+detects a framing error on the serial port it displays the count of
+errors on the status line, and logs the error. 
 .IP
 <tty reports error: \\377 \\000 \\000>
 .PP
-the observed frequencies of the different bit periods
-.IP 
+The count is reset to zero after ten seconds
+have elapsed during which no errors have occured.
+.I Sympathy 
+looks at bit patterns of the characters recevied, and
+measures the length (in units of the reciving UART's
+bit period) of any runs of '1's delimited by '0's and vice\-versa. It
+then calculates the statistics on the length of these runs, and logs these.
+.IP
 <tty_bit_analyse: 0000000001  [0,0,0,0,0,0,110,0,0,80]>
 .PP
-and the conclusions of the baud\-rate guessing algorithm
+For a typical
+stream of ASCII data, the most common run length will be the correct bit
+period. 
+.I Sympathy
+uses this togetehr with the current bit period to calculate the most probable
+correct baud\-rate, which is displayed in the status line, and logged. 
+If the correct baud\irate is higher than the current baud\-rate then the most common bit frequencey will be '0' or '1' and the correct baud\-rate cannot be
+determined. In this case sympathy will display and log the message 'try higher'.
 .IP
 <tty_analyse:     80 errors, current rate 115200b, suggest 19200b>
 .PP
-Invalid UTF\-8 sequences are also reported 
-.IP
-<invalid utf\-8 sequence: \\301>
-.PP
-The log file is rotated 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)
+The algorythm only works well if the data stream is normal. If the data stream
+is generated by the reception, at the wrong baud\-rate, of characters emited 
+by
+.I sympathy
+then the algoryhtm will be biased towards suggesting that the baud\-rate 
+is too low. Noise on the line will also result in sympathy concluding that
+the baud\-rate is too low.
 .SH SIGNALS
 .I Sympathy 
 reacts to a set of signals. You can use the \fB-P\fP option