* [PATCH 1/7] docs: improve wording and formatting of the man page of setterm
@ 2014-06-29 15:49 Benno Schulenberg
2014-06-29 15:49 ` [PATCH 2/7] textual: improve formatting and wording of usage text " Benno Schulenberg
` (6 more replies)
0 siblings, 7 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
The main changes are: showing the arguments of boolean options
as optional, improving the alphabetization, and restoring the
--half-bright option that went missing in 2011.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
term-utils/setterm.1 | 147 ++++++++++++++++++++++++++------------------------
1 files changed, 76 insertions(+), 71 deletions(-)
diff --git a/term-utils/setterm.1 b/term-utils/setterm.1
index 3b91298..bc11fdb 100644
--- a/term-utils/setterm.1
+++ b/term-utils/setterm.1
@@ -27,17 +27,15 @@ 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
-.RB ( on
-or
-.BR off ),
+.RB ( on " or " off ),
the default is
.BR on .
.P
-For conciseness, an
+Below, an
.I 8-color
-below is
-.BR black ,
-.BR red ,
+can be
+.BR black ,
+.BR red ,
.BR green ,
.BR yellow ,
.BR blue ,
@@ -48,8 +46,9 @@ or
.P
A
.I 16-color
-is an
+can be an
.IR 8-color ,
+or
.BR grey ,
or
.BR bright
@@ -64,91 +63,90 @@ by
or
.BR white .
.P
-The various color options may be set independently, at least at virtual
+The various color options may be set independently, at least on virtual
consoles, though the results of setting multiple modes (for example,
.B \-\-underline
and
.BR \-\-half-bright )
are hardware-dependent.
.TP
-\fB\-\-appcursorkeys\fP \fBon\fP|\fBoff\fP (virtual consoles only)
+\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
.I vi and Cursor-Keys
section of the
.I Text-Terminal-HOWTO
-for how this can cause problems for vi users.
+for how this can cause problems for \fBvi\fR users.
.TP
-\fB\-\-append\fP [\fI1-NR_CONS\fP]
+\fB\-\-append\fP [\fIconsole_number\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
-\fB\-\-blank\fP [\fB0-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).
+automatically blanked (using APM if available). Without an argument, it gets
+the blank status (returns which vt was blanked, or zero for an unblanked vt).
.IP
The
.B force
-option keeps screen blank even if a key is pressed.
+option keeps the screen blank even if a key is pressed.
.IP
The
.B poke
-option unblank the screen.
+option unblanks the screen.
.TP
-\fB\-\-bfreq\fP [\fInumber\fP] (virtual consoles only)
-Sets the bell frequency in Hertz. Without an argument, defaults to
+\fB\-\-bfreq\fP [\fInumber\fP] (virtual consoles only)
+Sets the bell frequency in Hertz. Without an argument, it defaults to
.BR 0 .
.TP
-\fB\-\-blength\fP [\fB0-2000\fP] (virtual consoles only)
-Sets the bell duration in milliseconds. Without an argument, defaults to
+\fB\-\-blength\fP [\fB0-2000\fP] (virtual consoles only)
+Sets the bell duration in milliseconds. Without an argument, it defaults to
.BR 0 .
.TP
-\fB\-\-blink\fP \fBon\fP|\fBoff\fP
-Turns blink mode on or off. Except at a virtual console,
+.BR \-\-blink " [" on | off ]
+Turns blink mode on or off. Except on a virtual console,
.B \-\-blink off
turns off all attributes (bold, half-brightness, blink, reverse).
.TP
-\fB\-\-bold\fP \fBon\fP|\fBoff\fP
-Turns bold (extra bright) mode on or off. Except at a virtual console,
+.BR \-\-bold " [" on | off ]
+Turns bold (extra bright) mode on or off. Except on a virtual console,
.B \-\-bold off
turns off all attributes (bold, half-brightness, blink, reverse).
.TP
-\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,
+\fB\-\-clear\fP [\fBall\fP|\fBrest\fP]
+Without an argument or with the argument
+.BR all ,
+the entire screen is cleared and the cursor is set to the home position,
+just like
.BR clear (1)
-does. The argument
-.B rest
-clears from the current cursor position to the end of the screen.
+does. With the argument
+.BR rest ,
+the screen is cleared from the current cursor position to the end.
.TP
-\fB\-\-clrtabs\fP [\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
.BR 1-160 .
-Without arguments, clears all tab stops.
+Without arguments, it clears all tab stops.
.TP
-\fB\-\-cursor\fP \fBon\fP|\fBoff\fP
+.BR \-\-cursor " [" on | off ]
Turns the terminal's cursor on or off.
.TP
\fB\-\-default\fP
Sets the terminal's rendering options to the default values.
.TP
-\fB\-\-dump\fP [\fI1-NR_CONS\fP]
-Writes a snapshot of the given virtual console to the file specified in the
+\fB\-\-dump\fP [\fIconsole_number\fP]
+Writes a snapshot of the virtual console with the given number
+to the file specified with the
.B \-\-file
option, overwriting its contents; the default is
.IR screen.dump .
-Without an argument, dumps the current virtual console. Overrides
+Without an argument, it dumps the current virtual console. This overrides
.BR \-\-append .
.TP
\fB\-\-file\fP \fIfilename\fP
@@ -159,9 +157,17 @@ or
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
+in the current directory. A path name that exceeds the system maximum will be
truncated, see PATH_MAX from linux/limits.h for the value.
.TP
+\fB\-\-foreground\fP \fI8-color\fP|\fBdefault\fP
+Sets the foreground text color.
+.TP
+.BR \-\-half-bright " [" on | off ]
+Turns dim (half-brightness) mode on or off. Except on a virtual console,
+.B \-\-half-bright off
+turns off all attributes (bold, half-brightness, blink, reverse).
+.TP
\fB\-\-hbcolor\fP \fI16-color\fP
Sets the color for bold characters.
.TP
@@ -169,43 +175,39 @@ Sets the color for bold characters.
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.
+.BR \-\-inversescreen " [" on | off ]
+Swaps 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.
+.BR \-\-linewrap " [" on | off ]
+Makes the terminal continue on a new line when a line is full.
.TP
-\fB\-\-msg\fP \fBon\fP|\fBoff\fP (virtual consoles only)
+.BR \-\-msg " [" on | off "] (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)
+\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
+.B 0
has the same effect as
.B \-\-msg on
and a logging level of
-.I 8
+.B 8
will print all kernel messages.
.BR klogd (8)
may be a more convenient interface to the logging of kernel messages.
.TP
\fB\-\-powerdown\fP [\fB0-60\fP]
-Sets the VESA powerdown interval in minutes. Without an argument, defaults
+Sets the VESA powerdown interval in minutes. Without an argument, it defaults
to
-.I 0
+.B 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
-\fB\-\-underline\fP \fBon\fP|\fBoff\fP
-Turns underline mode on or off (see
-.BR \-\-ulcolor .
-.TP
\fB\-\-powersave\fP \fBoff\fP
Turns off monitor VESA powersaving features.
.TP
@@ -218,53 +220,56 @@ Puts the monitor into VESA powerdown mode.
\fB\-\-powersave\fP \fBhsync\fP
Puts the monitor into VESA hsync suspend mode.
.TP
-\fB\-\-regtabs\fP [\fB1-160\fP] (virtual consoles only)
+\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
+specified number of positions. Without an argument, it defaults to
.BR 8 .
.TP
-\fB\-\-repeat\fP \fBon\fP|\fBoff\fP (virtual consoles only)
+.BR \-\-repeat " [" on | off "] (virtual consoles only)"
Turns keyboard repeat on or off.
.TP
\fB\-\-reset\fP
Displays the terminal reset string, which typically resets the terminal to
-its power on state.
+its power-on state.
.TP
-\fB\-\-reverse\fP \fBon\fP|\fBoff\fP
-Turns reverse video mode on or off. Except at a virtual console,
+\fB\-\-reverse\fP [\fBon\fP|\fBoff\fP]
+Turns reverse video mode on or off. Except on a virtual console,
.B \-\-reverse off
turns off all attributes (bold, half-brightness, blink, reverse).
.TP
-\fB\-\-store\fP (virtual consoles only)
+\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
\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.
+Without arguments, it shows the current tab stop settings.
.TP
\fB\-\-term\fP \fIterminal_name\fP
Overrides the TERM environment variable.
.TP
-\fB\-\-ulcolor\fP \fB16-color\fP (virtual consoles only)
+\fB\-\-ulcolor\fP \fI16-color\fP (virtual consoles only)
Sets the color for underlined characters.
.TP
+.BR \-\-underline " [" on | off ]
+Turns underline mode on or off.
+.TP
\fB\-\-version\fP
-Display version information and exit.
+Displays version information and exits.
.TP
\fB\-\-help\fP
-Display help text and exit.
+Displays a help text and exits.
.SH COMPATIBILITY
-Since version 2.25 the
+Since version 2.25
.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.
+In scripts it is better to use the backward-compatible single hyphen
+rather than the double hyphen. Currently there are no plans nor good
+reasons to discontinue single-hyphen compatibility.
.SH "SEE ALSO"
.BR tput (1),
.BR stty (1),
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 2/7] textual: improve formatting and wording of usage text of setterm
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-29 15:49 ` [PATCH 3/7] docs: improve wording and formatting of the man page of lslogins Benno Schulenberg
` (5 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
Mainly: showing that the word color is a placeholder by writing
<color>, showing some numbers as optional, and message levels
and colors as not optional.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
term-utils/setterm.c | 34 +++++++++++++++++-----------------
1 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/term-utils/setterm.c b/term-utils/setterm.c
index d559957..afbd274 100644
--- a/term-utils/setterm.c
+++ b/term-utils/setterm.c
@@ -403,7 +403,7 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
_(" %s [options]\n"), program_invocation_short_name);
fputs(USAGE_OPTIONS, out);
fputs(_(" --term <terminal_name> override TERM environment variable\n"), out);
- fputs(_(" --reset reset terminal to power on state\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);
@@ -412,33 +412,33 @@ static void __attribute__((__noreturn__)) usage(FILE *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(_(" --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(_(" --tabs [<number>...] set these tab stop positions, or show them\n"), out);
+ fputs(_(" --clrtabs [<number>...] clear these tab stop positions, or all\n"), out);
+ fputs(_(" --regtabs [1-160] set a regular tab stop interval\n"), out);
+ fputs(_(" --blank [0-60|force|poke] set time of inactivity before screen blanks\n"), out);
+ fputs(_(" --dump [<number>] write vcsa<number> console dump to file\n"), out);
+ fputs(_(" --append [<number>] append vcsa<number> console dump to file\n"), out);
+ fputs(_(" --file <filename> name of the dump file\n"), out);
+ fputs(_(" --msg [on|off] send 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);
+ fputs(_(" --version show version information and exit\n"), out);
+ fputs(_(" --help display this help and exit\n"), out);
fprintf(out, USAGE_MAN_TAIL("setterm(1)"));
exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
}
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 3/7] docs: improve wording and formatting of the man page of lslogins
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
2014-06-29 15:49 ` [PATCH 2/7] textual: improve formatting and wording of usage text " Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-29 15:49 ` [PATCH 4/7] textual: improve the columns information " Benno Schulenberg
` (4 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
Some typos, spacing, line breaks, and missing optional arguments.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
login-utils/lslogins.1 | 73 ++++++++++++++++++++++++-----------------------
1 files changed, 37 insertions(+), 36 deletions(-)
diff --git a/login-utils/lslogins.1 b/login-utils/lslogins.1
index efe9c58..1552020 100644
--- a/login-utils/lslogins.1
+++ b/login-utils/lslogins.1
@@ -5,22 +5,22 @@
lslogins \- display information about known users in the system
.SH SYNOPSIS
.B lslogins
-[\fIoptions\fR] [-s|-u[\fI=UID\fR]] [-g \fIGROUPS\fR] [-l \fILOGINS\fR]
+[\fIoptions\fR] [\fB-s\fR|\fB-u\fR[=\fIUID\fR]] [\fB-g \fIgroups\fR] [\fB-l \fIlogins\fR]
.SH DESCRIPTION
.PP
Examine the wtmp and btmp logs, /etc/shadow (if necessary) and /etc/passwd
and output the desired data.
.PP
-Mandatory arguments to long options are mandatory for short options too.
-.PP
The default action is to list info about all the users in the system.
.SH OPTIONS
-.PP
-Display info about existing users.
+Mandatory arguments to long options are mandatory for short options too.
.TP
\fB\-a\fR, \fB\-\-acc\-expiration\fR
Display data about the date of last password change and the account expiration
-date (see shadow(5) for more info). (Requires root priviliges.)
+date (see \fBshadow\fR(5) for more info). (Requires root priviliges.)
+.TP
+\fB\-\-btmp\-file \fIpath\fP
+Alternate path for btmp.
.TP
\fB\-c\fR, \fB\-\-colon\-separate\fR
Separate info about each user with a colon instead of a newline.
@@ -34,15 +34,20 @@ Display data about the users' last failed login attempts.
\fB\-G\fR, \fB\-\-groups\-info\fR
Show information about groups.
.TP
-\fB\-g\fR, \fB\-\-groups\fR=\fIGROUPS\fR
-Only show data of users belonging to \fIGROUPS\fR. More than one group may be specified; the list has to be comma-separated.
+\fB\-g\fR, \fB\-\-groups\fR=\fIgroups\fR
+Only show data of users belonging to \fIgroups\fR. More than one group
+may be specified; the list has to be comma-separated.
.TP
-\fB\-l\fR, \fB\-\-logins\fR=\fILOGINS\fR
-Only show data of users with a login specified in \fILOGINS\fR. More than one login may be specified; the list has to be comma-separated.
+\fB\-h\fR, \fB\-\-help\fR
+Display help information and exit.
.TP
-\fB\-L\fR, \-\-last\fR
+\fB\-L\fR, \fB\-\-last\fR
Display data containing information about the users' last login sessions.
.TP
+\fB\-l\fR, \fB\-\-logins\fR=\fIlogins\fR
+Only show data of users with a login specified in \fIlogins\fR (user names or user
+IDS). More than one login may be specified; the list has to be comma-separated.
+.TP
\fB\-m\fR, \fB\-\-supp\-groups\fR
Show supplementary groups.
.TP
@@ -52,51 +57,47 @@ Display each piece of information on a separate line.
\fB\-\-notruncate\fR
Don't truncate output.
.TP
-\fB\-o , \-\-output \fIlist\fP
+\fB\-o\fR, \fB\-\-output \fIlist\fP
Specify which output columns to print. Use
.B \-\-help
to get a list of all supported columns.
.TP
-\fB\-p , \-\-pwd\fR
-Display information related to login by password (see also \fB\-afR).
+\fB\-p\fR, \fB\-\-pwd\fR
+Display information related to login by password (see also \fB\-afL).
.TP
\fB\-r\fR, \fB\-\-raw\fR
Raw output (no columnation).
.TP
-\fB\-s\fR, \fB\-\-system\-accs\fR
-Show system accounts. These are by the default all accounts with UID below 1000 (non-inclusive), with the exception of either nobody or nfsnobody (UID 65534). The UID
-treshold can also be specified explicitly (necessary for some distributions that allocate UIDs
-starting from 100, 500 - or an entirely different value - rather than 1000).
+\fB\-s\fR, \fB\-\-system\-accs\fR[=\fIthreshold\fR]
+Show system accounts. These are by default all accounts with a UID below 1000
+(non-inclusive), with the exception of either nobody or nfsnobody (UID 65534). The UID
+threshold can also be specified explicitly (necessary for some distributions that
+allocate UIDs starting from 100, 500 - or an entirely different value - rather than 1000).
.TP
\fB\-\-time-format\fR \fItype\fP
-Display dates in short, full or iso format. The default is short, this time
+Display dates in short, full or iso format. The default is short, this time
format is designed to be space efficient and human readable.
.TP
-\fB\-u\fR, \fB\-\-user\-accs\fR
-Show user accounts. These are by the default all accounts with UID above 1000 (inclusive), with the exception of either nobody or nfsnobody (UID 65534). The UID
-treshold can also be specified explicitly (necessary for some distributions that allocate UIDs
-starting from 100, 500 - or an entirely different value - rather than 1000).
+\fB\-u\fR, \fB\-\-user\-accs\fR[=\fIthreshold\fR]
+Show user accounts. These are by default all accounts with UID above 1000
+(inclusive), with the exception of either nobody or nfsnobody (UID 65534). The UID
+threshold can also be specified explicitly (necessary for some distributions that
+allocate UIDs starting from 100, 500 - or an entirely different value - rather than 1000).
.TP
-\fB\-z\fR, \fB\-\-print0\fR
-Delimit user entries with a nul character, instead of a newline.
-.TP
-\fB\-Z\fR, \fB\-\-context\fR
-Display the users' security context.
+\fB\-V\fR, \fB\-\-version\fR
+Display version information and exit.
.TP
\fB\-\-wtmp\-file \fIpath\fP
Alternate path for wtmp.
.TP
-\fB\-\-btmp\-file \fIpath\fP
-Alternate path for btmp.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Display help information and exit.
+\fB\-Z\fR, \fB\-\-context\fR
+Display the users' security context.
.TP
-\fB\-V\fR, \fB\-\-version\fR
-Display version information and exit.
+\fB\-z\fR, \fB\-\-print0\fR
+Delimit user entries with a nul character, instead of a newline.
.SH NOTES
-The default UID tresholds are read from /etc/login.defs.
+The default UID thresholds are read from /etc/login.defs.
.SH EXIT STATUS
.TP
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 4/7] textual: improve the columns information of lslogins
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
2014-06-29 15:49 ` [PATCH 2/7] textual: improve formatting and wording of usage text " Benno Schulenberg
2014-06-29 15:49 ` [PATCH 3/7] docs: improve wording and formatting of the man page of lslogins Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-29 15:49 ` [PATCH 5/7] docs: slightly improve wording and formatting in man page of findmnt Benno Schulenberg
` (3 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
Some fixes for typos, whitespace and wordings.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
login-utils/lslogins.c | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/login-utils/lslogins.c b/login-utils/lslogins.c
index 09cded7..4ade02c 100644
--- a/login-utils/lslogins.c
+++ b/login-utils/lslogins.c
@@ -216,13 +216,13 @@ static struct lslogins_coldesc coldescs[] =
{
[COL_USER] = { "USER", N_("user name"), N_("Username"), 0.1, SCOLS_FL_NOEXTREMES },
[COL_UID] = { "UID", N_("user ID"), "UID", 1, SCOLS_FL_RIGHT},
- [COL_PWDEMPTY] = { "PWD-EMPTY", N_("password not requiured"), N_("Password no required"), 1, SCOLS_FL_RIGHT },
+ [COL_PWDEMPTY] = { "PWD-EMPTY", N_("password not required"), N_("Password not required"), 1, SCOLS_FL_RIGHT },
[COL_PWDDENY] = { "PWD-DENY", N_("login by password disabled"), N_("Login by password disabled"), 1, SCOLS_FL_RIGHT },
[COL_PWDLOCK] = { "PWD-LOCK", N_("password defined, but locked"), N_("Password is locked"), 1, SCOLS_FL_RIGHT },
[COL_NOLOGIN] = { "NOLOGIN", N_("log in disabled by nologin(8) or pam_nologin(8)"), N_("No login"), 1, SCOLS_FL_RIGHT },
- [COL_GROUP] = { "GROUP", N_("primary group name"), N_("Primary group"), 0.1 },
- [COL_GID] = { "GID", N_("primary group ID"), "GID", 1, SCOLS_FL_RIGHT },
- [COL_SGROUPS] = { "SUPP-GROUPS", N_("supplementary group names"), N_("Supplementary groups"), 0.1 },
+ [COL_GROUP] = { "GROUP", N_("primary group name"), N_("Primary group"), 0.1 },
+ [COL_GID] = { "GID", N_("primary group ID"), "GID", 1, SCOLS_FL_RIGHT },
+ [COL_SGROUPS] = { "SUPP-GROUPS", N_("supplementary group names"), N_("Supplementary groups"), 0.1 },
[COL_SGIDS] = { "SUPP-GIDS", N_("supplementary group IDs"), N_("Supplementary group IDs"), 0.1 },
[COL_HOME] = { "HOMEDIR", N_("home directory"), N_("Home directory"), 0.1 },
[COL_SHELL] = { "SHELL", N_("login shell"), N_("Shell"), 0.1 },
@@ -236,10 +236,10 @@ static struct lslogins_coldesc coldescs[] =
[COL_PWD_WARN] = { "PWD-WARN", N_("days user is warned of password expiration"), N_("Password expiration warn interval"), 0.1, SCOLS_FL_RIGHT },
[COL_PWD_EXPIR] = { "PWD-EXPIR", N_("password expiration date"), N_("Password expiration"), 0.1, SCOLS_FL_RIGHT },
[COL_PWD_CTIME] = { "PWD-CHANGE", N_("date of last password change"), N_("Password changed"), 0.1, SCOLS_FL_RIGHT},
- [COL_PWD_CTIME_MIN] = { "PWD-MIN", N_("number of days required between changes"), N_("Minimal change time"), 0.1, SCOLS_FL_RIGHT },
- [COL_PWD_CTIME_MAX] = { "PWD-MAX", N_("max number of days a password may remain unchanged"), N_("Maximal change time"), 0.1, SCOLS_FL_RIGHT },
+ [COL_PWD_CTIME_MIN] = { "PWD-MIN", N_("number of days required between changes"), N_("Minimum change time"), 0.1, SCOLS_FL_RIGHT },
+ [COL_PWD_CTIME_MAX] = { "PWD-MAX", N_("max number of days a password may remain unchanged"), N_("Maximum change time"), 0.1, SCOLS_FL_RIGHT },
[COL_SELINUX] = { "CONTEXT", N_("the user's security context"), N_("Selinux context"), 0.1 },
- [COL_NPROCS] = { "PROC", N_("number of processes run by the user"), N_("Running process"), 1, SCOLS_FL_RIGHT },
+ [COL_NPROCS] = { "PROC", N_("number of processes run by the user"), N_("Running processes"), 1, SCOLS_FL_RIGHT },
};
struct lslogins_control {
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 5/7] docs: slightly improve wording and formatting in man page of findmnt
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
` (2 preceding siblings ...)
2014-06-29 15:49 ` [PATCH 4/7] textual: improve the columns information " Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-29 15:49 ` [PATCH 6/7] textual: minimally improve wording of usage text " Benno Schulenberg
` (2 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
---
misc-utils/findmnt.8 | 10 +++++-----
1 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/misc-utils/findmnt.8 b/misc-utils/findmnt.8
index 9c87432..ac5d908 100644
--- a/misc-utils/findmnt.8
+++ b/misc-utils/findmnt.8
@@ -1,5 +1,5 @@
.\" -*- nroff -*-
-.TH FINDMNT 8 "April 2010" "util-linux" "System Administration"
+.TH FINDMNT 8 "June 2014" "util-linux" "System Administration"
.SH NAME
findmnt \- find a filesystem
.SH SYNOPSIS
@@ -49,8 +49,8 @@ Use ascii characters for tree formatting.
Print the SIZE, USED and AVAIL column in bytes rather than in a human-readable format.
.TP
.BR \-C , " \-\-nocanonicalize"
-Do not canonicalize paths at all. This option affects paths comparation
-and tags (LABEL, UUID, etc.) evaluation.
+Do not canonicalize paths at all. This option affects the comparing of paths
+and the evaluation of tags (LABEL, UUID, etc.).
.TP
.BR \-c , " \-\-canonicalize"
Canonicalize all printed paths.
@@ -65,9 +65,9 @@ Use \fB\-\-all\fP to print all filesystems.
.TP
.BR \-d , " \-\-direction \fIword\fP"
The search direction, either
-.IR forward
+.B forward
or
-.IR backward .
+.BR backward .
.TP
.BR \-e , " \-\-evaluate"
Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the device names.
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 6/7] textual: minimally improve wording of usage text of findmnt
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
` (3 preceding siblings ...)
2014-06-29 15:49 ` [PATCH 5/7] docs: slightly improve wording and formatting in man page of findmnt Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-29 15:49 ` [PATCH 7/7] docs: slightly improve the man page of umount Benno Schulenberg
2014-06-30 8:28 ` [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Karel Zak
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
Also sort the options better and tweak whitespace.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
misc-utils/findmnt.c | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/misc-utils/findmnt.c b/misc-utils/findmnt.c
index 06fdd8f..445a9b3 100644
--- a/misc-utils/findmnt.c
+++ b/misc-utils/findmnt.c
@@ -1138,7 +1138,7 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
fputs(_(" -s, --fstab search in static table of filesystems\n"), out);
fputs(_(" -m, --mtab search in table of mounted filesystems\n"), out);
fputs(_(" -k, --kernel search in kernel table of mounted\n"
- " filesystems (default)\n"), out);
+ " filesystems (default)\n"), out);
fputc('\n', out);
fputs(_(" -p, --poll[=<list>] monitor changes in table of mounted filesystems\n"), out);
fputs(_(" -w, --timeout <num> upper limit in milliseconds that --poll will block\n"), out);
@@ -1147,8 +1147,8 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
fputs(_(" -A, --all disable all built-in filters, print all filesystems\n"), out);
fputs(_(" -a, --ascii use ASCII chars for tree formatting\n"), out);
fputs(_(" -b, --bytes print sizes in bytes rather than in human readable format\n"), out);
+ fputs(_(" -C, --nocanonicalize don't canonicalize when comparing paths\n"), out);
fputs(_(" -c, --canonicalize canonicalize printed paths\n"), out);
- fputs(_(" -C, --nocanonicalize don't canonicalize when compare paths\n"), out);
fputs(_(" -D, --df imitate the output of df(1)\n"), out);
fputs(_(" -d, --direction <word> direction of search, 'forward' or 'backward'\n"), out);
fputs(_(" -e, --evaluate convert tags (LABEL,UUID,PARTUUID,PARTLABEL) \n"
@@ -1159,18 +1159,18 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
fputs(_(" -l, --list use list format output\n"), out);
fputs(_(" -N, --task <tid> use alternative namespace (/proc/<tid>/mountinfo file)\n"), out);
fputs(_(" -n, --noheadings don't print column headings\n"), out);
- fputs(_(" -U, --uniq ignore filesystems with duplicate target\n"), out);
- fputs(_(" -u, --notruncate don't truncate text in columns\n"), out);
fputs(_(" -O, --options <list> limit the set of filesystems by mount options\n"), out);
fputs(_(" -o, --output <list> the output columns to be shown\n"), out);
fputs(_(" -P, --pairs use key=\"value\" output format\n"), out);
- fputs(_(" -r, --raw use raw output format\n"), out);
- fputs(_(" -t, --types <list> limit the set of filesystems by FS types\n"), out);
- fputs(_(" -v, --nofsroot don't print [/dir] for bind or btrfs mounts\n"), out);
fputs(_(" -R, --submounts print all submounts for the matching filesystems\n"), out);
+ fputs(_(" -r, --raw use raw output format\n"), out);
fputs(_(" -S, --source <string> the device to mount (by name, maj:min, \n"
" LABEL=, UUID=, PARTUUID=, PARTLABEL=)\n"), out);
fputs(_(" -T, --target <string> the mountpoint to use\n"), out);
+ fputs(_(" -t, --types <list> limit the set of filesystems by FS types\n"), out);
+ fputs(_(" -U, --uniq ignore filesystems with duplicate target\n"), out);
+ fputs(_(" -u, --notruncate don't truncate text in columns\n"), out);
+ fputs(_(" -v, --nofsroot don't print [/dir] for bind or btrfs mounts\n"), out);
fputs(USAGE_SEPARATOR, out);
fputs(USAGE_HELP, out);
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 7/7] docs: slightly improve the man page of umount
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
` (4 preceding siblings ...)
2014-06-29 15:49 ` [PATCH 6/7] textual: minimally improve wording of usage text " Benno Schulenberg
@ 2014-06-29 15:49 ` Benno Schulenberg
2014-06-30 8:28 ` [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Karel Zak
6 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-29 15:49 UTC (permalink / raw)
To: util-linux
Remove some stray words from option arguments.
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
sys-utils/umount.8 | 26 +++++++++++++-------------
1 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/sys-utils/umount.8 b/sys-utils/umount.8
index c9e2aca..4128d2f 100644
--- a/sys-utils/umount.8
+++ b/sys-utils/umount.8
@@ -32,7 +32,7 @@ umount \- unmount file systems
.B umount \-a
.RB [ \-dflnrv ]
.RB [ \-t
-.IR vfstype ]
+.IR fstype ]
.RB [ \-O
.IR options ]
.br
@@ -42,7 +42,7 @@ umount \- unmount file systems
.SH DESCRIPTION
The
.B umount
-command detaches the file system(s) mentioned from the file hierarchy. A
+command detaches the mentioned file system(s) from the file hierarchy. A
file system is specified by giving the directory where it has been
mounted. Giving the special device on which the file system lives may
also work, but is obsolete, mainly because it will fail in case this
@@ -58,7 +58,7 @@ files. A lazy unmount avoids this problem.
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-all\fR
-All of the file systems described in
+All of the filesystems described in
.I /etc/mtab
are unmounted. (With
.B umount
@@ -108,11 +108,11 @@ Lazy unmount. Detach the filesystem from the filesystem hierarchy now,
and cleanup all references to the filesystem as soon as it is not busy
anymore. (Requires kernel 2.4.11 or later.)
.TP
-\fB\-O\fR, \fB\-\-test\-opts\fR \fIoptions,list\fR
-Indicate that the actions should only be taken on file systems with the
-specified options in
+\fB\-O\fR, \fB\-\-test\-opts\fR \fIoption\fR
+Indicate that the actions should only be taken on filesystems with the
+specified option in
.IR /etc/fstab .
-More than one option type may be specified in a comma separated list.
+More than one option may be specified in a comma-separated list.
Each option can be prefixed with
.B no
to specify options for which no action should be taken.
@@ -127,14 +127,14 @@ is unsupported.
\fB\-r\fR, \fB\-\-read\-only\fR
In case unmounting fails, try to remount read-only.
.TP
-\fB\-t\fR, \fB\-\-types\fR \fIvfstype,ext2,ext3\fR
-Indicate that the actions should only be taken on file systems of the
+\fB\-t\fR, \fB\-\-types\fR \fItype\fR
+Indicate that the actions should only be taken on filesystems of the
specified
.IR type .
-More than one type may be specified in a comma separated list. The list
-of file system types can be prefixed with
+More than one type may be specified in a comma-separated list. The list
+of filesystem types can be prefixed with
.B no
-to specify the file system types on which no action should be taken.
+to specify the types of filesystem on which no action should be taken.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbose mode.
@@ -174,7 +174,7 @@ The helper= mount option redirects all umount requests to the
/sbin/umount.<helper> independently on UID.
.SH FILES
.I /etc/mtab
-table of mounted file systems
+table of mounted filesystems
.SH ENVIRONMENT
.IP LIBMOUNT_FSTAB=<path>
overrides the default location of the fstab file
--
1.7.0.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [PATCH 1/7] docs: improve wording and formatting of the man page of setterm
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
` (5 preceding siblings ...)
2014-06-29 15:49 ` [PATCH 7/7] docs: slightly improve the man page of umount Benno Schulenberg
@ 2014-06-30 8:28 ` Karel Zak
2014-06-30 21:17 ` Benno Schulenberg
6 siblings, 1 reply; 9+ messages in thread
From: Karel Zak @ 2014-06-30 8:28 UTC (permalink / raw)
To: Benno Schulenberg; +Cc: util-linux
On Sun, Jun 29, 2014 at 05:49:37PM +0200, Benno Schulenberg wrote:
> term-utils/setterm.1 | 147 ++++++++++++++++++++++++++------------------------
> 1 files changed, 76 insertions(+), 71 deletions(-)
All 7 patches applied. Thanks! (Nice to see regular git patches rather
than attachments!:-)
Karel
--
Karel Zak <kzak@redhat.com>
http://karelzak.blogspot.com
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 1/7] docs: improve wording and formatting of the man page of setterm
2014-06-30 8:28 ` [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Karel Zak
@ 2014-06-30 21:17 ` Benno Schulenberg
0 siblings, 0 replies; 9+ messages in thread
From: Benno Schulenberg @ 2014-06-30 21:17 UTC (permalink / raw)
To: Karel Zak; +Cc: Util-Linux
On Mon, Jun 30, 2014, at 10:28, Karel Zak wrote:
> (Nice to see regular git patches rather
> than attachments!:-)
Yeah, finally got it to work by installing msmtp, after trying
one or two other smtp packages. The basic git-email package
wasn't good enough.
Benno
--
http://www.fastmail.fm - One of many happy users:
http://www.fastmail.fm/help/overview_quotes.html
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2014-06-30 21:17 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-06-29 15:49 [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Benno Schulenberg
2014-06-29 15:49 ` [PATCH 2/7] textual: improve formatting and wording of usage text " Benno Schulenberg
2014-06-29 15:49 ` [PATCH 3/7] docs: improve wording and formatting of the man page of lslogins Benno Schulenberg
2014-06-29 15:49 ` [PATCH 4/7] textual: improve the columns information " Benno Schulenberg
2014-06-29 15:49 ` [PATCH 5/7] docs: slightly improve wording and formatting in man page of findmnt Benno Schulenberg
2014-06-29 15:49 ` [PATCH 6/7] textual: minimally improve wording of usage text " Benno Schulenberg
2014-06-29 15:49 ` [PATCH 7/7] docs: slightly improve the man page of umount Benno Schulenberg
2014-06-30 8:28 ` [PATCH 1/7] docs: improve wording and formatting of the man page of setterm Karel Zak
2014-06-30 21:17 ` Benno Schulenberg
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox