cytune.8: missing description of `-S', formatting

Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>

diff --git a/sys-utils/cytune.8 b/sys-utils/cytune.8
index 072d060a1e485b1e4157a1f89481fb0798b4c38a..379dffa67d3f262c2519eddf69283a9935a4df06 100644 (file)
--- a/sys-utils/cytune.8
+++ b/sys-utils/cytune.8
@@ -1,18 +1,18 @@
-.\" cytune.8 -- 
+.\" cytune.8 --
 .\" Created: Sat Mar  4 17:44:53 1995 by faith@cs.unc.edu
 .\" Update: Sat Mar  4 18:22:24 1995 by faith@cs.unc.edu
 .\" Update: Sun Mar  5 06:40:12 1995 by njs@scifi.emi.net
 .\" Copyright 1995 Rickard E. Faith (faith@cs.unc.edu)
-.\" 
+.\"
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
-.\" 
+.\"
 .\" Permission is granted to copy and distribute modified versions of this
 .\" manual under the conditions for verbatim copying, provided that the
 .\" entire resulting derived work is distributed under the terms of a
 .\" permission notice identical to this one
-.\" 
+.\"
 .\" Since the Linux kernel and libraries are constantly changing, this
 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
 .\" responsibility for errors or omissions, or for damages resulting from
@@ -20,7 +20,7 @@
 .\" have taken the same level of care in the production of this manual,
 .\" which is licensed free of charge, as they might when working
 .\" professionally.
-.\" 
+.\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\" "
@@ -28,8 +28,16 @@
 .SH NAME
 cytune \- Tune driver parameters for Cyclades-Z multiport serial card
 .SH SYNOPSIS
-.BI "cytune [-q [-i " interval "]] ([-s " value "]|[-S " value "]) [-g|G] "
-.BI ([-t " timeout" ]|[-T " timeout" ]) " tty" " [" tty " ...]"
+.B cytune
+.RB [ \-q
+.RB [ \-i
+.IR interval ]]
+.RB [{ \-s | \-S }
+.IR value ]
+.RB [ \-g | \-G ]
+.RB [{ \-t | \-T }
+.IR timeout ]
+.IR tty ...
 .SH DESCRIPTION
 .B cytune
 queries and modifies the interruption threshold for the Cyclades driver.
@@ -41,7 +49,7 @@ based on baud rate:
 .sp
 .RS
     Baud        Threshold
-.sp 
+.sp
 50-4800            10
 .br
 9600                8
@@ -59,15 +67,15 @@ FIFO buffer can overflow, and characters will be lost.  Slower machines,
 however, may not be able to deal with the interrupt load, and will require
 that the threshold be adjusted upwards.
 .PP
-If the cyclades driver was compiled with 
+If the cyclades driver was compiled with
 .B ENABLE_MONITORING
 defined, the cytune command can be used with the
 .B \-q
-option to report interrupts over the monitoring interval and 
-characters transferred over the monitoring interval.  It will also report 
-the state of the FIFO.  The maximum number of characters in the FIFO when 
+option to report interrupts over the monitoring interval and
+characters transferred over the monitoring interval.  It will also report
+the state of the FIFO.  The maximum number of characters in the FIFO when
 an interrupt occurred, the instantaneous count of characters in the FIFO,
-and how many characters are now in the FIFO are reported.  This output might 
+and how many characters are now in the FIFO are reported.  This output might
 look like this:
 .sp
 .RS
@@ -76,23 +84,23 @@ look like this:
    166.259866 interrupts/second, 1828.858521 characters/second
 .RE
 .PP
-This output indicates that for this monitoring period, the interrupts were 
+This output indicates that for this monitoring period, the interrupts were
 always being handled within one character time, because
 .B max
-never rose above 
+never rose above
 .BR threshold .
-This is good, and you can probably run this way, provided that a large 
-number of samples come out this way.  You will lose characters if you 
-overrun the FIFO, as the Cyclades hardware does not seem to support 
-the RTS RS-232 signal line for hardware flow control from the 
+This is good, and you can probably run this way, provided that a large
+number of samples come out this way.  You will lose characters if you
+overrun the FIFO, as the Cyclades hardware does not seem to support
+the RTS RS-232 signal line for hardware flow control from the
 DCE to the DTE.
 .PP
 In query mode
 .B cytune
-will produce a summary report when ended with 
+will produce a summary report when ended with
 a SIGINT or when the threshold or timeout is changed.
 .PP
-There may be a responsiveness vs. throughput tradeoff.  The Cyclades card, 
+There may be a responsiveness vs. throughput tradeoff.  The Cyclades card,
 at the higher speeds, is capable of putting a very high interrupt load on the
 system.  This will reduce the amount of CPU time available for other tasks
 on your system.  However, the time it takes to respond to a single character
@@ -108,9 +116,9 @@ transfer, WWW, and the like, setting the FIFO to a high value is likely to
 reduce the load on your system while not significantly affecting
 throughput.  Alternatively, see the
 .B \-t
-or 
+or
 .B \-T
-options to adjust the time that the cyclades waits before flushing its 
+options to adjust the time that the cyclades waits before flushing its
 buffer.  Units are 5ms.
 .PP
 If you are running a mouse on a Cyclades port, it is likely that you would
@@ -141,6 +149,14 @@ to zero forces the default, currently 0x20 (160ms), but soon to be 0x02
 .B \-g
 Get the current threshold and timeout.
 .TP
+.BI \-S " value"
+Set the default threshold to
+.I value
+characters.  When the
+.I tty
+is next opened, this value will be used instead of the default.
+Only values between 1 and 12, inclusive, are permitted.
+.TP
 .BI \-T " value"
 Set the default flush timeout to
 .I value
@@ -169,7 +185,7 @@ seconds.
 If you run two copies of
 .B cytune
 at the same time to report statistics about the same port,
-the 'ints', 'chars', and 'max' value will be reset 
+the 'ints', 'chars', and 'max' value will be reset
 and not reported correctly.
 .B cytune
 should prevent this, but does not.