]> err.no Git - util-linux/commitdiff
tunelp.8: formatting
authorPeter Breitenlohner <peb@mppmu.mpg.de>
Wed, 22 Jul 2009 09:29:04 +0000 (11:29 +0200)
committerKarel Zak <kzak@redhat.com>
Mon, 17 Aug 2009 10:11:07 +0000 (12:11 +0200)
Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
sys-utils/tunelp.8

index 006f6e160f71578c0df17e5c9b7a5d1c6fba65bf..06abff5d40344f5c0c11635a3a6ebcf57c498b5f 100644 (file)
@@ -9,7 +9,28 @@
 .SH NAME
 tunelp \- set various parameters for the lp device
 .SH SYNOPSIS
-\fBtunelp\fP \fI<device>\fP [-i \fI<IRQ>\fP | -t \fI<TIME>\fP | -c \fI<CHARS>\fP | -w \fI<WAIT>\fP | -a [on|off] | -o [on|off] | -C [on|off] | -r | -s | -q [on|off] | - T [on|off] ]
+.B tunelp
+.I device
+.RB [ \-i
+.IR IRQ ]
+.RB [ \-t
+.IR TIME ]
+.RB [ \-c
+.IR CHARS ]
+.RB [ \-w
+.IR WAIT ]
+.RB [ \-a
+.RB { on | off }]
+.RB [ \-o
+.RB { on | off }]
+.RB [ \-C
+.RB { on | off }]
+.RB [ \-r ]
+.RB [ \-s ]
+.RB [ \-q
+.RB { on | off }]
+.RB [ \-T
+.RB { on | off }]
 .SH DESCRIPTION
 \fBtunelp\fP sets several parameters for the /dev/lp\fI?\fP devices, for better
 performance (or for any performance at all, if your printer won't work
@@ -18,7 +39,7 @@ interrupts, and if so, which one.  With parameters, it sets the device
 characteristics accordingly.  The parameters are as follows:
 
 .TP
-.BI \-i " <IRQ>"
+.BI \-i " IRQ"
 specifies the IRQ to use for the parallel port in question.  If this
 is set to something non-zero, \-t and \-c have no effect.  If your port
 does not use interrupts, this option will make printing stop.
@@ -38,7 +59,7 @@ Read
 for more details on parport.
 
 .TP
-.BI \-t " <TIME>"
+.BI \-t " TIME"
 is the amount of time in jiffies that the driver waits if the
 printer doesn't take a character for the number of tries dictated by
 the \-c parameter.  10 is the default value.  If you want fastest
@@ -50,9 +71,9 @@ should be lower for printing graphics than text, by a factor of
 approximately 10, for best performance.
 
 .TP
-.BI \-c " <CHARS>"
+.BI \-c " CHARS"
 is the number of times to try to output a character to the
-printer before sleeping for \-t \fI<TIME>\fP.  It is the number of times around
+printer before sleeping for \-t \fITIME\fP.  It is the number of times around
 a loop that tries to send a character to the printer.  120 appears to
 be a good value for most printers in polling mode.  1000 is the default,
 because there are some printers that become jerky otherwise, but you \fImust\fP
@@ -61,11 +82,11 @@ interrupts. If you have a very fast printer, a value of 10 might make more
 sense even if in polling mode.
 If you have a \fIreally\fP old printer, you can increase this further.
 
-Setting \-t \fI<TIME>\fP to 0 is equivalent to setting \-c \fI<CHARS>\fP
+Setting \-t \fITIME\fP to 0 is equivalent to setting \-c \fICHARS\fP
 to infinity.
 
 .TP
-.BI \-w " <WAIT>"
+.BI \-w " WAIT"
 is the number of usec we wait while playing with the strobe signal.
 While most printers appear to be able to deal with an extremely
 short strobe, some printers demand a longer one.  Increasing this from
@@ -74,7 +95,7 @@ make it possible to use longer cables. It's also possible to decrease this
 value to 0 if your printer is fast enough or your machine is slow enough.
 
 .TP
-.B \-a [on|off]
+.BR \-a " {" on | off }
 This is whether to abort on printer error - the default
 is not to.  If you are sitting at your computer, you probably want to
 be able to see an error and fix it, and have the printer go on
@@ -83,7 +104,7 @@ your printer spooler find out that the printer isn't ready, quit
 trying, and send you mail about it.  The choice is yours.
 
 .TP
-.B \-o [on|off]
+.BR \-o " {" on | off }
 This option is much like \-a.  It makes any
 .I open()
 of this device check to see that the device is on-line and not reporting any
@@ -91,7 +112,7 @@ out of paper or other errors.  This is the correct setting for most
 versions of lpd.
 
 .TP
-.B \-C [on|off]
+.BR \-C " {" on | off }
 This option adds extra ("careful") error checking.  When
 this option is on, the printer driver will ensure that the printer is
 on-line and not reporting any out of paper or other errors before
@@ -103,13 +124,13 @@ or later.
 
 .TP
 .B \-s
-This option returns the current printer status, both as a 
+This option returns the current printer status, both as a
 decimal number from 0..255, and as a list of active flags.  When
 this option is specified, \-q off, turning off the display of the
 current IRQ, is implied.
 
 .TP
-.B \-T [on|off]
+.BR \-T " {" on | off }
 This option is obsolete. It was added in Linux 2.1.131,
 and removed again in Linux 2.3.10. The below is for these
 old kernels only.
@@ -134,16 +155,22 @@ This option resets the port.  It requires a Linux kernel version of
 1.1.80 or later.
 
 .TP
-.B \-q [on|off]
+.BR \-q " {" on | off }
 This option sets printing the display of the current IRQ setting.
 
 
 .SH NOTES
-\-o, \-C, and \-s all require a Linux kernel version of 1.1.76 or later.
+.BR \-o ,
+.BR \-C ,
+and
+.B \-s
+all require a Linux kernel version of 1.1.76 or later.
 
-\-C requires a Linux version prior to 2.1.131.
+.B \-C
+requires a Linux version prior to 2.1.131.
 
-\-T requires a Linux version of 2.1.131 or later.
+.B \-T
+requires a Linux version of 2.1.131 or later.
 
 .SH BUGS
 By some unfortunate coincidence the ioctl LPSTRICT of 2.0.36 has the same