setterm: recommend long options with double hyphen

While the -version style options will work for next unknown number of
years start moving towards user interface that has way of invoking long
options as most of the other commands.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>

1 files changed, 47 insertions, 47 deletions

diff --git a/term-utils/setterm.1 b/term-utils/setterm.1
index 9f5b2292d..d15fd40e7 100644
--- a/term-utils/setterm.1
+++ b/term-utils/setterm.1
@@ -39,23 +39,23 @@ by \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBmagenta\fP,
 .P
 The various color options may be set independently, at least at virtual
 consoles, though the results of setting multiple modes (for example,
-.BR \-underline " and " \-half-bright )
+.BR \-\-underline " and " \-\-half-bright )
 are hardware-dependent.
 .TP
-.BR \-appcursorkeys " [" on | off "] (virtual consoles only)"
+.BR \-\-appcursorkeys " [" on | off "] (virtual consoles only)"
 Sets Cursor Key Application Mode on or off. When on, ESC O A, ESC O B, etc.
 will be sent for the cursor keys instead of ESC [ A, ESC [ B, etc.  See the
 "vi and Cursor-Keys" section of the Text-Terminal-HOWTO for how this can
 cause problems for vi users.
 .TP
-.BR \-append " [\fI1-NR_CONS\fP]"
-Like \fB\-dump\fP, but appends to the snapshot file instead of overwriting
-it.  Only works if no \fB\-dump\fP options are given.
+.BR \-\-append " [\fI1-NR_CONS\fP]"
+Like \fB\-\-dump\fP, but appends to the snapshot file instead of overwriting
+it.  Only works if no \fB\-\-dump\fP options are given.
 .TP
-\fB\-background\fP \fI8-color\fP|\fBdefault\fP (virtual consoles only)
+\fB\-\-background\fP \fI8-color\fP|\fBdefault\fP (virtual consoles only)
 Sets the background text color.
 .TP
-.BR \-blank " [\fI0-60\fP|\fBforce\fP|\fBpoke\fP] (virtual consoles only)"
+.BR \-\-blank " [\fI0-60\fP|\fBforce\fP|\fBpoke\fP] (virtual consoles only)"
 Sets the interval of inactivity, in minutes, after which the screen will be
 automatically blanked (using APM if available).  Without an argument, gets the
 blank status (returns which vt was blanked or zero for unblanked vt).
@@ -68,121 +68,121 @@ The
 .B poke
 option unblank the screen.
 .TP
-.BR \-bfreq " [\fIfreqnumber\fP]"
+.BR \-\-bfreq " [\fIfreqnumber\fP]"
 Sets the bell frequency in Hz.  Without an argument, defaults to 0.
 .TP
-.BR \-blength " [\fI0-2000\fP]"
+.BR \-\-blength " [\fI0-2000\fP]"
 Sets the bell duration in milliseconds.  Without an argument, defaults to 0.
 .TP
-.BR \-blink " [" on | off ]
-Turns blink mode on or off.  Except at a virtual console, \fB\-blink off\fP
+.BR \-\-blink " [" on | off ]
+Turns blink mode on or off.  Except at a virtual console, \fB\-\-blink off\fP
 turns off all attributes (bold, half-brightness, blink, reverse).
 .TP
-.BR \-bold " [" on | off ]
+.BR \-\-bold " [" on | off ]
 Turns bold (extra bright) mode on or off.  Except at a virtual console,
-\fB\-bold off\fP turns off all attributes (bold, half-brightness, blink,
+\fB\-\-bold off\fP turns off all attributes (bold, half-brightness, blink,
 reverse).
 .TP
-.BR \-clear " [" all ]
+.BR \-\-clear " [" all ]
 Clears the screen and "homes" the cursor, as
 .BR clear (1).
 .TP
-.B \-clear rest
+.B \-\-clear rest
 Clears from the current cursor position to the end of the screen.
 .TP
-.BR \-clrtabs " [\fItab1 tab2 tab3\fP ...] (virtual consoles only)"
+.BR \-\-clrtabs " [\fItab1 tab2 tab3\fP ...] (virtual consoles only)"
 Clears tab stops from the given horizontal cursor positions, in the range
 1-160.  Without arguments, clears all tab stops.
 .TP
-.BR \-cursor " [" on | off ]
+.BR \-\-cursor " [" on | off ]
 Turns the terminal's cursor on or off.
 .TP
-.B \-default
+.B \-\-default
 Sets the terminal's rendering options to the default values.
 .TP
-.BR \-dump " [\fI1-NR_CONS\fP]"
+.BR \-\-dump " [\fI1-NR_CONS\fP]"
 Writes a snapshot of the given virtual console to the file
-specified in the \fB\-file\fP option, overwriting its contents; the default
+specified in the \fB\-\-file\fP option, overwriting its contents; the default
 is screen.dump.  Without an argument, dumps the current virtual console.
-Overrides \fB\-append\fP.
+Overrides \fB\-\-append\fP.
 .TP
-.BR \-append " [\fI1-NR_CONS\fP]"
-Like \fB\-dump\fP, but appends to the snapshot file instead of overwriting
-it.  Only works if no \fB\-dump\fP options are given.
+.BR \-\-append " [\fI1-NR_CONS\fP]"
+Like \fB\-\-dump\fP, but appends to the snapshot file instead of overwriting
+it.  Only works if no \fB\-\-dump\fP options are given.
 .TP
-.BI \-file " dumpfilename"
-Sets the snapshot file name for any \fB\-dump\fP or \fB\-append\fP options
+.BI \-\-file " dumpfilename"
+Sets the snapshot file name for any \fB\-\-dump\fP or \fB\-\-append\fP options
 on the same command line.  If this option is not present, the default is
 screen.dump in the current directory.  A path name that exceeds system
 maximum will be truncated, see PATH_MAX from linux/limits.h for the value.
 .TP
-.BR \-msg " [" on | off "] (virtual consoles only)"
+.BR \-\-msg " [" on | off "] (virtual consoles only)"
 Enables or disables the sending of kernel \fBprintk()\fP messages to the
 console.
 .TP
-.BR \-msglevel " \fI1-8\fP (virtual consoles only)"
+.BR \-\-msglevel " \fI1-8\fP (virtual consoles only)"
 Sets the console logging level for kernel \fBprintk()\fP messages.  All
 messages strictly more important than this will be printed, so a logging
-level of 0 has the same effect as \fB\-msg on\fP and a logging level of 8
+level of 0 has the same effect as \fB\-\-msg on\fP and a logging level of 8
 will print all kernel messages.
 .BR klogd (8)
 may be a more convenient interface to the logging of kernel messages.
 .TP
-.BR \-powerdown " [\fI0-60\fP]"
+.BR \-\-powerdown " [\fI0-60\fP]"
 Sets the VESA powerdown interval in minutes.  Without an argument, defaults
 to 0 (disable powerdown).  If the console is blanked or the monitor is in
 suspend mode, then the monitor will go into vsync suspend mode or powerdown
 mode respectively after this period of time has elapsed.
 .TP
-.BR \-underline " [" on | off ]
-Turns underline mode on or off (see \fB\-ulcolor\fP).
+.BR \-\-underline " [" on | off ]
+Turns underline mode on or off (see \fB\-\-ulcolor\fP).
 .TP
-.BR \-powersave " [" off "]"
+.BR \-\-powersave " [" off "]"
 Turns off monitor VESA powersaving features.
 .TP
-.BR "\-powersave on" | vsync
+.BR "\-\-powersave on" | vsync
 Puts the monitor into VESA vsync suspend mode.
 .TP
-.B \-powersave powerdown
+.B \-\-powersave powerdown
 Puts the monitor into VESA powerdown mode.
 .TP
-.B \-powersave hsync
+.B \-\-powersave hsync
 Puts the monitor into VESA hsync suspend mode.
 .TP
-.BR \-regtabs " [\fI1-160\fP] (virtual consoles only)"
+.BR \-\-regtabs " [\fI1-160\fP] (virtual consoles only)"
 Clears all tab stops, then sets a regular tab stop pattern, with one tab
 every specified number of positions.  Without an argument, defaults to 8.
 .TP
-.BR \-repeat " [" on | off "] (virtual consoles only)"
+.BR \-\-repeat " [" on | off "] (virtual consoles only)"
 Turns keyboard repeat on or off.
 .TP
-.B \-reset
+.B \-\-reset
 Displays the terminal reset string, which typically resets the terminal to
 its power on state.
 .TP
-.BR \-reverse " [" on | off ]
+.BR \-\-reverse " [" on | off ]
 Turns reverse video mode on or off.  Except at a virtual console,
-\fB\-reverse off\fP turns off all attributes (bold, half-brightness, blink,
+\fB\-\-reverse off\fP turns off all attributes (bold, half-brightness, blink,
 reverse).
 .TP
-.BR \-store " (virtual consoles only)"
+.BR \-\-store " (virtual consoles only)"
 Stores the terminal's current rendering options (foreground and
 background colors) as the values to be used at reset-to-default.
 .TP
-.BR \-tabs " [\fItab1 tab2 tab3\fP ...] (virtual consoles only)"
+.BR \-\-tabs " [\fItab1 tab2 tab3\fP ...] (virtual consoles only)"
 Sets tab stops at the given horizontal cursor positions, in the range 1-160.
 Without arguments, shows the current tab stop settings.
 .TP
-.BR \-term " terminal_name"
+.BR \-\-term " terminal_name"
 Overrides the TERM environment variable.
 .TP
-\fB\-ulcolor\fP \fI16-color\fP (virtual consoles only)
+\fB\-\-ulcolor\fP \fI16-color\fP (virtual consoles only)
 Sets the color for underlined characters.
 .TP
-.BR \-version
+.BR \-\-version
 Display version information and exit.
 .TP
-.BR \-help
+.BR \-\-help
 Display help text and exit.
 .SH "SEE ALSO"
 .BR tput (1),