Merge branch 'setterm' of git://github.com/kerolasa/lelux-utiliteetit

* 'setterm' of git://github.com/kerolasa/lelux-utiliteetit:
  docs: setterm.1 clean up manual page groff style
  docs: setterm.1 add options compatibility note
  docs: setterm.1 add missing options to manual page and remove duplicate
  setterm: add usage() descriptions

2 files changed, 221 insertions, 137 deletions

diff --git a/term-utils/setterm.1 b/term-utils/setterm.1
index d15fd40e7..3b9129853 100644
--- a/term-utils/setterm.1
+++ b/term-utils/setterm.1
@@ -1,4 +1,4 @@
-\" Copyright 1990 Gordon Irlam (gordoni@cs.ua.oz.au)
+.\" Copyright 1990 Gordon Irlam (gordoni@cs.ua.oz.au)
 .\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
 .\" Most of this was copied from the source code.
 .\" Do not restrict distribution.
@@ -8,7 +8,7 @@
 .\" Undocumented: -snow, -softscroll, -standout; these are
 .\" commented out in the source
 .\"
-.TH SETTERM 1 "January 2000" "util-linux" "User Commands"
+.TH SETTERM 1 "May 2014" "util-linux" "User Commands"
 .SH NAME
 setterm \- set terminal attributes
 .SH SYNOPSIS
@@ -16,174 +16,255 @@ setterm \- set terminal attributes
 .RI [ options ]
 .SH DESCRIPTION
 .B setterm
-writes to standard output a character string that will invoke the
-specified terminal capabilities.  Where possible
+writes to standard output a character string that will invoke the specified
+terminal capabilities.  Where possible
 .I terminfo
-is consulted to find the string to use.  Some options however (marked
-"virtual consoles only" below) do not correspond to a
+is consulted to find the string to use.  Some options however (marked "virtual
+consoles only" below) do not correspond to a
 .BR terminfo (5)
-capability.  In this case, if the terminal type is "con" or "linux" the
-string that invokes the specified capabilities on the PC Minix virtual
-console driver is output.  Options that are not implemented by the terminal
-are ignored.
+capability.  In this case, if the terminal type is "con" or "linux" the string
+that invokes the specified capabilities on the PC Minix virtual console driver
+is output.  Options that are not implemented by the terminal are ignored.
 .SH OPTIONS
-For boolean options (\fBon\fP or \fBoff\fP), the default is \fBon\fP.
+For boolean options
+.RB ( on
+or
+.BR off ),
+the default is
+.BR on .
 .P
-For conciseness, an \fI8-color\fP below is \fBblack\fP, \fBred\fP,
-\fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBmagenta\fP, \fBcyan\fP, or
-\fBwhite\fP.
+For conciseness, an
+.I 8-color
+below is
+.BR  black ,
+.BR  red ,
+.BR green ,
+.BR yellow ,
+.BR blue ,
+.BR magenta ,
+.BR cyan ,
+or
+.BR white .
 .P
-A \fI16-color\fP is an \fI8-color\fP, \fBgrey\fP, or \fBbright\fP followed
-by \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP, \fBmagenta\fP,
-\fBcyan\fP, or \fBwhite\fP.
+A
+.I 16-color
+is an
+.IR 8-color ,
+.BR grey ,
+or
+.BR bright
+followed
+by
+.BR red ,
+.BR green ,
+.BR yellow ,
+.BR blue ,
+.BR magenta ,
+.BR cyan ,
+or
+.BR white .
 .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 )
+.B \-\-underline
+and
+.BR \-\-half-bright )
 are hardware-dependent.
 .TP
-.BR \-\-appcursorkeys " [" on | off "] (virtual consoles only)"
-Sets Cursor Key Application Mode on or off. When on, ESC O A, ESC O B, etc.
+\fB\-\-appcursorkeys\fP \fBon\fP|\fBoff\fP (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.
-.TP
-\fB\-\-background\fP \fI8-color\fP|\fBdefault\fP (virtual consoles only)
+.I vi and Cursor-Keys
+section of the
+.I Text-Terminal-HOWTO
+for how this can cause problems for vi users.
+.TP
+\fB\-\-append\fP [\fI1-NR_CONS\fP]
+Like
+.BR \-\-dump ,
+but appends to the snapshot file instead of overwriting it.  Only works if no
+.B \-\-dump
+options are given.
+.TP
+\fB\-\-foreground\fP \fI8-color\fP|\fBdefault\fP
+Sets the foreground text color.
+.TP
+\fB\-\-background\fP \fI8-color\fP|\fBdefault\fP
 Sets the background text color.
 .TP
-.BR \-\-blank " [\fI0-60\fP|\fBforce\fP|\fBpoke\fP] (virtual consoles only)"
+\fB\-\-blank\fP [\fB0-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).
-
+.IP
 The
 .B force
 option keeps screen blank even if a key is pressed.
-
+.IP
 The
 .B poke
 option unblank the screen.
 .TP
-.BR \-\-bfreq " [\fIfreqnumber\fP]"
-Sets the bell frequency in Hz.  Without an argument, defaults to 0.
+\fB\-\-bfreq\fP [\fInumber\fP] (virtual consoles only)
+Sets the bell frequency in Hertz.  Without an argument, defaults to
+.BR 0 .
 .TP
-.BR \-\-blength " [\fI0-2000\fP]"
-Sets the bell duration in milliseconds.  Without an argument, defaults to 0.
+\fB\-\-blength\fP [\fB0-2000\fP] (virtual consoles only)
+Sets the bell duration in milliseconds.  Without an argument, defaults to
+.BR 0 .
 .TP
-.BR \-\-blink " [" on | off ]
-Turns blink mode on or off.  Except at a virtual console, \fB\-\-blink off\fP
+\fB\-\-blink\fP \fBon\fP|\fBoff\fP
+Turns blink mode on or off.  Except at a virtual console,
+.B \-\-blink off
 turns off all attributes (bold, half-brightness, blink, reverse).
 .TP
-.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,
-reverse).
-.TP
-.BR \-\-clear " [" all ]
-Clears the screen and "homes" the cursor, as
-.BR clear (1).
+\fB\-\-bold\fP \fBon\fP|\fBoff\fP
+Turns bold (extra bright) mode on or off. Except at a virtual console,
+.B \-\-bold off
+turns off all attributes (bold, half-brightness, blink, reverse).
 .TP
-.B \-\-clear rest
-Clears from the current cursor position to the end of the screen.
+\fB\-\-clear\fP \fBall\fP|\fBrest\fP
+With argument
+.B all
+the cursor is set to home position, and all output is removed from screen,
+.BR clear (1)
+does.  The argument
+.B rest
+clears from the current cursor position to the end of the screen.
 .TP
-.BR \-\-clrtabs " [\fItab1 tab2 tab3\fP ...] (virtual consoles only)"
+\fB\-\-clrtabs\fP [\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.
+.BR 1-160 .
+Without arguments, clears all tab stops.
 .TP
-.BR \-\-cursor " [" on | off ]
+\fB\-\-cursor\fP \fBon\fP|\fBoff\fP
 Turns the terminal's cursor on or off.
 .TP
-.B \-\-default
+\fB\-\-default\fP
 Sets the terminal's rendering options to the default values.
 .TP
-.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
-is screen.dump.  Without an argument, dumps the current virtual console.
-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.
-.TP
-.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)"
-Enables or disables the sending of kernel \fBprintk()\fP messages to the
-console.
-.TP
-.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
+\fB\-\-dump\fP [\fI1-NR_CONS\fP]
+Writes a snapshot of the given virtual console to the file specified in the
+.B \-\-file
+option, overwriting its contents; the default is
+.IR screen.dump .
+Without an argument, dumps the current virtual console.  Overrides
+.BR \-\-append .
+.TP
+\fB\-\-file\fP \fIfilename\fP
+Sets the snapshot file name for any
+.B \-\-dump
+or
+.B \-\-append
+options on the same command line.  If this option is not present, the default
+is
+.I 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
+\fB\-\-hbcolor\fP \fI16-color\fP
+Sets the color for bold characters.
+.TP
+\fB\-\-initialize\fP
+Displays the terminal initialization string, which typically sets the
+terminal's rendering options, and other attributes to the default values.
+.TP
+\fB\-\-inversescreen\fP \fBon\fP|\fBoff\fP
+Swap foreground and background colors for the whole screen.
+.TP
+\fB\-\-linewrap\fP \fBon\fP|\fBoff\fP
+Continue on a new line when a line is full.
+.TP
+\fB\-\-msg\fP \fBon\fP|\fBoff\fP (virtual consoles only)
+Enables or disables the sending of kernel
+.BR printk()
+messages to the console.
+.TP
+\fB\-\-msglevel\fP \fB0-8\fP (virtual consoles only)
+Sets the console logging level for kernel
+.B printk()
+messages.  All messages strictly more important than this will be printed, so a
+logging level of
+.I 0
+has the same effect as
+.B \-\-msg on
+and a logging level of
+.I 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]"
+\fB\-\-powerdown\fP [\fB0-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.
+to
+.I 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).
+\fB\-\-underline\fP \fBon\fP|\fBoff\fP
+Turns underline mode on or off (see
+.BR \-\-ulcolor .
 .TP
-.BR \-\-powersave " [" off "]"
+\fB\-\-powersave\fP \fBoff\fP
 Turns off monitor VESA powersaving features.
 .TP
-.BR "\-\-powersave on" | vsync
+\fB\-\-powersave\fP \fBon\fP|\fBvsync\fP
 Puts the monitor into VESA vsync suspend mode.
 .TP
-.B \-\-powersave powerdown
+\fB\-\-powersave\fP \fBpowerdown\fP
 Puts the monitor into VESA powerdown mode.
 .TP
-.B \-\-powersave hsync
+\fB\-\-powersave\fP \fBhsync\fP
 Puts the monitor into VESA hsync suspend mode.
 .TP
-.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.
+\fB\-\-regtabs\fP [\fB1-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
+.BR 8 .
 .TP
-.BR \-\-repeat " [" on | off "] (virtual consoles only)"
+\fB\-\-repeat\fP \fBon\fP|\fBoff\fP (virtual consoles only)
 Turns keyboard repeat on or off.
 .TP
-.B \-\-reset
+\fB\-\-reset\fP
 Displays the terminal reset string, which typically resets the terminal to
 its power on state.
 .TP
-.BR \-\-reverse " [" on | off ]
+\fB\-\-reverse\fP \fBon\fP|\fBoff\fP
 Turns reverse video mode on or off.  Except at a virtual console,
-\fB\-\-reverse off\fP turns off all attributes (bold, half-brightness, blink,
-reverse).
+.B \-\-reverse off
+turns off all attributes (bold, half-brightness, blink, reverse).
 .TP
-.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.
+\fB\-\-store\fP (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)"
-Sets tab stops at the given horizontal cursor positions, in the range 1-160.
+\fB\-\-tabs\fP [\fItab1 tab2 tab3\fP ...]
+Sets tab stops at the given horizontal cursor positions, in the range
+.BR 1-160 .
 Without arguments, shows the current tab stop settings.
 .TP
-.BR \-\-term " terminal_name"
+\fB\-\-term\fP \fIterminal_name\fP
 Overrides the TERM environment variable.
 .TP
-\fB\-\-ulcolor\fP \fI16-color\fP (virtual consoles only)
+\fB\-\-ulcolor\fP \fB16-color\fP (virtual consoles only)
 Sets the color for underlined characters.
 .TP
-.BR \-\-version
+\fB\-\-version\fP
 Display version information and exit.
 .TP
-.BR \-\-help
+\fB\-\-help\fP
 Display help text and exit.
+.SH COMPATIBILITY
+Since version 2.25 the
+.B setterm
+has support for long options with two hyphens, for example
+.BR \-\-help ,
+beside the historical long options with a single hyphen, for example
+.BR \-help .
+In scripts it is better to use the backward compatible single hyphen
+rather than the double hyphen.  Currently there are no plans or good
+reasons to discontinue single hyphen compatibility.
 .SH "SEE ALSO"
 .BR tput (1),
 .BR stty (1),
@@ -193,4 +274,6 @@ Display help text and exit.
 Differences between the Minix and Linux versions are not documented.
 .SH AVAILABILITY
 The setterm 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 .
diff --git a/term-utils/setterm.c b/term-utils/setterm.c
index 5f59a8b26..d559957d3 100644
--- a/term-utils/setterm.c
+++ b/term-utils/setterm.c
@@ -402,40 +402,41 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
 	fprintf(out,
 	      _(" %s [options]\n"), program_invocation_short_name);
 	fputs(USAGE_OPTIONS, out);
-	fputs(_(" --term <terminal_name>\n"), out);
-	fputs(_(" --reset\n"), out);
-	fputs(_(" --initialize\n"), out);
-	fputs(_(" --cursor <on|off>\n"), out);
-	fputs(_(" --repeat <on|off>\n"), out);
-	fputs(_(" --appcursorkeys <on|off>\n"), out);
-	fputs(_(" --linewrap <on|off>\n"), out);
-	fputs(_(" --default\n"), out);
-	fputs(_(" --foreground <default|color>\n"), out);
-	fputs(_(" --background <default|color>\n"), out);
-	fputs(_(" --ulcolor [bright] <color>\n"), out);
-	fputs(_(" --hbcolor [bright] <color>\n"), out);
-	fputs(_(" <color>: black blue cyan green grey magenta red white yellow\n"), out);
-	fputs(_(" --inversescreen <on|off>\n"), out);
-	fputs(_(" --bold <on|off>\n"), out);
-	fputs(_(" --half-bright <on|off>\n"), out);
-	fputs(_(" --blink <on|off>\n"), out);
-	fputs(_(" --reverse <on|off>\n"), out);
-	fputs(_(" --underline <on|off>\n"), out);
-	fputs(_(" --store\n"), out);
-	fputs(_(" --clear <all|rest>\n"), out);
-	fputs(_(" --tabs <tab1 tab2 tab3 ...>      (tabn = 1-160)\n"), out);
-	fputs(_(" --clrtabs <tab1 tab2 tab3 ...>   (tabn = 1-160)\n"), out);
-	fputs(_(" --regtabs <1-160>\n"), out);
-	fputs(_(" --blank <0-60|force|poke>\n"), out);
-	fputs(_(" --dump   <1-NR_CONSOLES>\n"), out);
-	fputs(_(" --append <1-NR_CONSOLES>\n"), out);
-	fputs(_(" --file dumpfilename\n"), out);
-	fputs(_(" --msg <on|off>\n"), out);
-	fputs(_(" --msglevel <0-8>\n"), out);
-	fputs(_(" --powersave <on|vsync|hsync|powerdown|off>\n"), out);
-	fputs(_(" --powerdown <0-60>\n"), out);
-	fputs(_(" --blength <0-2000>\n"), out);
-	fputs(_(" --bfreq freqnumber\n"), out);
+	fputs(_(" --term          <terminal_name>   override TERM environment variable\n"), out);
+	fputs(_(" --reset                           reset terminal to power on state\n"), out);
+	fputs(_(" --initialize                      display init string, and use default settings\n"), out);
+	fputs(_(" --default                         use default terminal settings\n"), out);
+	fputs(_(" --store                           save current terminal settings as default\n"), out);
+	fputs(_(" --cursor        [on|off]          display cursor\n"), out);
+	fputs(_(" --repeat        [on|off]          keyboard repeat\n"), out);
+	fputs(_(" --appcursorkeys [on|off]          cursor key application mode\n"), out);
+	fputs(_(" --linewrap      [on|off]          continue on a new line when a line is full\n"), out);
+	fputs(_(" --inversescreen [on|off]          swap colors for the whole screen\n"), out);
+	fputs(_(" --foreground    [default|color]   set foreground color\n"), out);
+	fputs(_(" --background    [default|color]   set background color\n"), out);
+	fputs(_(" --ulcolor       [bright] [color]  set underlined text color\n"), out);
+	fputs(_(" --hbcolor       [bright] [color]  set bold text color\n"), out);
+	fputs(_("                 [color]: black blue cyan green grey magenta red white yellow\n"), out);
+	fputs(_(" --bold          [on|off]          bold\n"), out);
+	fputs(_(" --half-bright   [on|off]          dim\n"), out);
+	fputs(_(" --blink         [on|off]          blink\n"), out);
+	fputs(_(" --underline     [on|off]          underline\n"), out);
+	fputs(_(" --reverse       [on|off]          swap foreground and background colors\n"), out);
+	fputs(_(" --clear         [all|rest]        clear screen and set cursor position\n"), out);
+	fputs(_(" --tabs          <number ...>      set tab stop positions\n"), out);
+	fputs(_(" --clrtabs       <number ...>      clear tab stop positions\n"), out);
+	fputs(_(" --regtabs       [1-160]           set default tab stop position\n"), out);
+	fputs(_(" --blank         [0-60|force|poke] set inactivity interval\n"), out);
+	fputs(_(" --dump          <number>          write vcsa<number> console dump to file\n"), out);
+	fputs(_(" --append        <number>          append vcsa<number> console dump\n"), out);
+	fputs(_(" --file          <file>            path to vcsa<number> dump file\n"), out);
+	fputs(_(" --msg           [on|off]          kernel messages to console\n"), out);
+	fputs(_(" --msglevel      [0-8]             kernel console log level\n"), out);
+	fputs(_(" --powersave     [on|vsync|hsync|powerdown|off]\n"), out);
+	fputs(_("                                   set vesa powersaving features\n"), out);
+	fputs(_(" --powerdown     [0-60]            set vesa powerdown interval in minutes\n"), out);
+	fputs(_(" --blength       [0-2000]          duration of the bell in milliseconds\n"), out);
+	fputs(_(" --bfreq         <number>          bell frequency in Hertz\n"), out);
 	fputs(_(" --version\n"), out);
 	fputs(_(" --help\n"), out);
 	fprintf(out, USAGE_MAN_TAIL("setterm(1)"));