From: Sami Kerola Date: Sun, 25 Sep 2011 20:28:51 +0000 (+0200) Subject: docs: mention long options in cytune.8 X-Git-Tag: v2.21-rc1~356^2~1 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=834eb52124d00e6bf55acd2de9886dec46d8608d;p=thirdparty%2Futil-linux.git docs: mention long options in cytune.8 Signed-off-by: Sami Kerola --- diff --git a/sys-utils/cytune.8 b/sys-utils/cytune.8 index 8a21775828..1c4de3ee46 100644 --- a/sys-utils/cytune.8 +++ b/sys-utils/cytune.8 @@ -24,31 +24,23 @@ .\" Formatted or processed versions of this manual, if unaccompanied by .\" the source, must acknowledge the copyright and authors of this work. .\" " -.TH CYTUNE 8 "March 1995" "util-linux" "System Administration" +.TH CYTUNE 8 "September 2011" "util-linux" "System Administration" .SH NAME cytune \- tune driver parameters for Cyclades-Z multiport serial card .SH SYNOPSIS .B cytune -.RB [ \-q -.RB [ \-i -.IR interval ]] -.RB [{ \-s | \-S } -.IR value ] -.RB [ \-g | \-G ] -.RB [{ \-t | \-T } -.IR timeout ] -.IR tty ... +[options] tty [...] .SH DESCRIPTION .B cytune queries and modifies the interruption threshold for the Cyclades driver. -Each serial line on a Cyclades card has a 12-byte FIFO for input (and -another 12-byte FIFO for output). The "threshold" specifies how many input +Each serial line on a Cyclades card has a 12-byte FIFO for input (and another +12-byte FIFO for output). The "threshold" specifies how many input characters must be present in the FIFO before an interruption is raised. -When a Cyclades tty is opened, this threshold is set to a default value -based on baud rate: +When a Cyclades tty is opened, this threshold is set to a default value based +on baud rate: .sp .RS - Baud Threshold +Baud Threshold .sp 50-4800 10 .br @@ -62,21 +54,21 @@ based on baud rate: .RE .PP If the threshold is set too low, the large number of interruptions can load -the machine and decrease overall system throughput. If the threshold is set too high, the -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. +the machine and decrease overall system throughput. If the threshold is set +too high, the 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 .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 -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 -look like this: +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 look like +this: .sp .RS /dev/cubC0: 830 ints, 9130 chars; fifo: 11 threshold, 11 max, 11 now @@ -89,32 +81,31 @@ always being handled within one character time, because .B max 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 -DCE to the DTE. +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 -a SIGINT or when the threshold or timeout is changed. +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, -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 -may be increased if you increase the threshold. This might be noticed by +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 may +be increased if you increase the threshold. This might be noticed by monitoring .BR ping (8) times on a SLIP link controlled by a Cyclades card. If your SLIP link is generally used for interactive work such as .BR telnet (1), -you may want to leave the threshold low, so that characters are responded -to as quickly as possible. If your SLIP link is generally used for file +you may want to leave the threshold low, so that characters are responded to +as quickly as possible. If your SLIP link is generally used for file 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 +reduce the load on your system while not significantly affecting throughput. +Alternatively, see the .B \-t or .B \-T @@ -126,38 +117,37 @@ want to maintain the threshold and timeout at a low value. .PP .SH OPTIONS .TP -.BI \-s " value" +\fB\-s\fR, \fB\-\-set\-threshold\fR \fIvalue\fR Set the current threshold to .I value characters. Note that if the .I tty -is not being held open by another process, the threshold will be reset on -the next open. Only values between 1 and 12, inclusive, are permitted. +is not being held open by another process, the threshold will be reset on the +next open. Only values between 1 and 12, inclusive, are permitted. .TP -.BI \-t " value" +\fB\-t\fR, \fB\-\-set\-flush\fR \fIvalue\fR Set the current flush timeout to .I value units. Note that if the .I tty -is not being held open by another process, the threshold will be reset on -the next open. Only values between 0 and 255, inclusive, are permitted. -Setting +is not being held open by another process, the threshold will be reset on the +next open. Only values between 0 and 255, inclusive, are permitted. Setting .I value to zero forces the default, currently 0x20 (160ms), but soon to be 0x02 (10ms). Units are 5 ms. .TP -.B \-g +\fB\-g\fR, \fB\-\-get\-threshold\fR Get the current threshold and timeout. .TP -.BI \-S " value" +\fB\-S\fR, \fB\-\-set\-default\-threshold\fR \fIvalue\fR 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. +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" +\fB\-T\fR, \fB\-\-set\-default\-flush\fR \fIvalue\fR Set the default flush timeout to .I value units. When the @@ -167,26 +157,25 @@ is next opened, this value will be used instead of the default. If is zero, then the the value will default to 0x20 (160ms), soon to be 0x02 (10ms). .TP -.B \-G +\fB\-G\fR, \fB\-\-get\-glush\fR Get the default threshold and flush timeout values. .TP -.B \-q +\fB\-q\fR, \fB\-\-stats\fR Gather statistics about the .IR tty . The results are only valid if the Cyclades driver has been compiled with .B ENABLE_MONITORING defined. This is probably not the default. .TP -.BI \-i " interval" +\fB\-i\fR, \fB\-\-interval\fR \fIinterval\fR Statistics will be gathered every .I interval seconds. .SH BUGS 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 -and not reported correctly. +at the same time to report statistics about the same port, the 'ints', +'chars', and 'max' value will be reset and not reported correctly. .B cytune should prevent this, but does not. .\" .SH AUTHOR @@ -200,4 +189,6 @@ should prevent this, but does not. .BR setserial (8) .SH AVAILABILITY The cytune command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE .