a few more man-page improvements
PATCH 1/1 a few more man-page improvements
Attached is another small set of man-page tweaks. The second patch is a big one: it standardizes the phrases for the --help and --version options in all man pages.
By the way, when trying to build util-linux from git, I get errors for mount and getopt. The output of a second 'make -k':
make all-recursive
make[1]: Entering directory `/home/ben/UTLNX' Making all in po
make[2]: Entering directory /home/ben/UTLNX/po' make[2]: Nothing to be done for all'. make[2]: Leaving directory /home/ben/UTLNX/po' make[2]: Entering directory /home/ben/UTLNX'
rm: cannot remove 'mount': Is a directory make[2]: *** [mount] Error 1
rm: cannot remove 'getopt': Is a directory make[2]: *** [getopt] Error 1
make[2]: Target all-am' not remade because of errors. make[2]: Leaving directory /home/ben/UTLNX' make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/home/ben/UTLNX'
make: *** [all] Error 2
This has been like this for quite a while. I thought I must be doing something wrong or missing some tool, but I wonder.
Trying a 'make clean' ends in:
Making clean in .
make[1]: Entering directory `/home/ben/UTLNX'
rm -f dmesg mount umount wdctl mountpoint lsblk findmnt kill
rm: cannot remove 'mount': Is a directory
make[1]: *** [clean-binPROGRAMS] Error 1
make[1]: Leaving directory `/home/ben/UTLNX'
make: *** [clean-recursive] Error 1
Benno
Signature · 2 lines
http://www.fastmail.fm - Faster than the air-speed velocity of an
unladen european swallowFrom 1416cb95fb9be6eb21feff984c9bf9beed8a44cf Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <[email protected]>
Date: Mon, 14 Oct 2013 20:48:22 +0200
Subject: [PATCH 1/4] docs: format, grammarize, and standardize the wall man page
--- term-utils/wall.1 | 40 +++++++++++++++++++++------------------- 1 files changed, 21 insertions(+), 19 deletions(-)
term-utils/wall.1 +21 -19
@@ -38,17 +38,20 @@ wall \- write a message to users .SH SYNOPSIS .B wall -[-n] [-t TIMEOUT] [file | message] +.RB [ \-n ] +.RB [ \-t +.IR timeout ] +.RI [ message " | " file ] .SH DESCRIPTION -.B Wall +.B wall displays a .I message -or contents of +or the contents of a .I file or, by default, its standard input, on the terminals of all currently logged -in users. The command will cut over 79 character long lines to new lines. -Short lines are white space padded to have 79 characters. The command will -always put carriage return and new line at the end of each line. +in users. The command will wrap lines that are longer than 79 characters. +Short lines are whitespace padded to have 79 characters. The command will +always put a carriage return and new line at the end of each line. .PP Only the superuser can write on the terminals of users who have chosen to deny messages or are using a program which automatically denies messages.
@@ -58,25 +61,24 @@ Reading from a is refused when the invoker is not superuser and the program is suid or sgid. .SH OPTIONS .TP -\fB\-n\fR, \fB\-\-nobanner\fR -Suppress banner +.BR \-n , " \-\-nobanner" +Suppress the banner. .TP -\fB\-t\fR, \fB\-\-timeout\fR \fItimeout\fR -Write -.I timeout -to terminals in seconds. Argument must be positive integer. Default value -is 300 seconds, which is a legacy from time when people ran terminals over +.BR \-t , " \-\-timeout " \fItimeout\fR +Abandon the write attempt to the terminals after \fItimeout\fR seconds. +This \fItimeout\fR must be a positive integer. The default value +is 300 seconds, which is a legacy from the time when people ran terminals over modem lines. .TP -\fB\-V\fR, \fB\-\-version\fR -Output version and exit. +.BR \-V , " \-\-version" +Display version information and exit. .TP -\fB\-h\fR, \fB\-\-help\fR -Output help and exit. +.BR \-h , " \-\-help" +Display help text and exit. .SH NOTES -Some sessions, such as wdm, that has in beginning of +Some sessions, such as wdm, that have in the beginning of .BR utmp (5) -ut_type data ':' character will not get message from +ut_type data a ':' character will not get the message from .BR wall . This is done to avoid write errors. .SH SEE ALSO
Signature · 1 line
1.7.0.4
From 51d04dd97c2ed865f9c291d47f9f08b93db359dc Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <[email protected]>
Date: Mon, 14 Oct 2013 21:34:39 +0200
Subject: [PATCH 2/4] docs: standardize the phrases for --help and --version in all man pages
--- disk-utils/fdformat.8 | 4 ++-- disk-utils/fsck.cramfs.8 | 2 +- disk-utils/mkfs.8 | 2 +- disk-utils/mkfs.bfs.8 | 2 +- disk-utils/partx.8 | 2 +- disk-utils/raw.8 | 2 +- fdisks/sfdisk.8 | 6 ++---- login-utils/chfn.1 | 4 ++-- login-utils/chsh.1 | 4 ++-- login-utils/login.1 | 2 +- login-utils/nologin.8 | 4 ++-- login-utils/sulogin.8 | 4 ++-- login-utils/utmpdump.1 | 4 ++-- misc-utils/cal.1 | 2 +- misc-utils/findmnt.8 | 2 +- misc-utils/getopt.1 | 6 ++---- misc-utils/logger.1 | 2 +- misc-utils/look.1 | 2 +- misc-utils/lsblk.8 | 4 ++-- misc-utils/lslocks.8 | 2 +- misc-utils/mcookie.1 | 4 ++-- misc-utils/namei.1 | 4 ++-- misc-utils/wipefs.8 | 4 ++-- mount-deprecated/mount.8 | 4 ++-- schedutils/chrt.1 | 2 +- schedutils/ionice.1 | 2 +- schedutils/taskset.1 | 2 +- sys-utils/blkdiscard.8 | 2 +- sys-utils/chcpu.8 | 2 +- sys-utils/ctrlaltdel.8 | 4 ++-- sys-utils/dmesg.1 | 4 ++-- sys-utils/eject.1 | 4 ++-- sys-utils/fallocate.1 | 4 ++-- sys-utils/flock.1 | 4 ++-- sys-utils/fsfreeze.8 | 4 ++-- sys-utils/fstrim.8 | 2 +- sys-utils/hwclock.8 | 6 ++---- sys-utils/ipcmk.1 | 4 ++-- sys-utils/ipcs.1 | 2 +- sys-utils/ldattach.8 | 4 ++-- sys-utils/lscpu.1 | 2 +- sys-utils/mount.8 | 4 ++-- sys-utils/mountpoint.1 | 2 +- sys-utils/nsenter.1 | 2 +- sys-utils/pivot_root.8 | 4 ++-- sys-utils/prlimit.1 | 4 ++-- sys-utils/readprofile.8 | 6 ++---- sys-utils/renice.1 | 4 ++-- sys-utils/rtcwake.8 | 8 ++++---- sys-utils/setarch.8 | 5 +++-- sys-utils/setpriv.1 | 2 +- sys-utils/swapon.8 | 4 ++-- sys-utils/switch_root.8 | 4 ++-- sys-utils/umount.8 | 4 ++-- sys-utils/unshare.1 | 2 +- sys-utils/wdctl.8 | 6 +++--- term-utils/mesg.1 | 4 ++-- term-utils/script.1 | 4 ++-- term-utils/scriptreplay.1 | 2 +- term-utils/setterm.1 | 4 ++-- text-utils/col.1 | 4 ++-- text-utils/colcrt.1 | 4 ++-- text-utils/colrm.1 | 4 ++-- text-utils/column.1 | 2 +- text-utils/rev.1 | 4 ++-- text-utils/tailf.1 | 4 ++-- text-utils/ul.1 | 2 +- 67 files changed, 112 insertions(+), 119 deletions(-)
disk-utils/fdformat.8 +2 -2
@@ -49,10 +49,10 @@ to load the disk parameters. Skip the verification that is normally performed after the formatting. .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH "SEE ALSO" .BR fd (4), .BR setfdprm (8),
disk-utils/fsck.cramfs.8 +1 -1
@@ -29,7 +29,7 @@ This option is silently ignored. Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH "EXIT STATUS" .RS .PD 0
disk-utils/mkfs.8 +1 -1
@@ -69,7 +69,7 @@ version information only when it is the only parameter, otherwise it will work as \fB\-\-verbose\fR.) .TP .BR \-h , " \-\-help" -Display help and exit. +Display help text and exit. .SH BUGS All generic options must precede and not be combined with filesystem-specific options.
disk-utils/mkfs.bfs.8 +1 -1
@@ -41,7 +41,7 @@ This option is silently ignored. Display help text and exit. .TP .BR \-V , " \-\-version" -Output version information and exit. +Display version information and exit. Option .B \-V only works as
disk-utils/partx.8 +1 -1
@@ -48,7 +48,7 @@ Update the specified partitions. .IP "\fB\-g\fR, \fB\-\-noheadings\fP" Do not print a header line. .IP "\fB\-h\fR, \fB\-\-help\fP" -Print a help text and exit. +Display help text and exit. .IP "\fB\-l\fR, \fB\-\-list\fP" List the partitions. Note that all numbers are in 512-byte sectors. This output format is DEPRECATED in favour of
disk-utils/raw.8 +1 -1
@@ -71,7 +71,7 @@ With , specify that all bound raw devices should be queried. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .TP \fB\-V\fR, \fB\-\-version\fR Display version information and exit.
fdisks/sfdisk.8 +2 -4
@@ -168,12 +168,10 @@ There are many options. .SH OPTIONS .TP .BR \-v ", " \-\-version -Print version number of -.B sfdisk -and exit immediately. +Display version information and exit. .TP .BR \-h ", " \-\-help -Print a usage message and exit immediately. +Display help text and exit. .TP .BR \-T ", " \-\-list\-types Print the recognized types (system Id's).
login-utils/chfn.1 +2 -2
@@ -68,10 +68,10 @@ Specify your office phone number. Specify your home phone number. .TP .B "\-u, \-\-help" -Print a usage message and exit. +Display help text and exit. .TP .B "-v, \-\-version" -Print version information and exit. +Display version information and exit. .SH "EXIT STATUS" Returns 0 if operation was successful, 1 if operation failed or command syntax was not valid. .SH "SEE ALSO"
login-utils/chsh.1 +2 -2
@@ -42,10 +42,10 @@ Print the list of shells listed in and exit. .TP .B "\-u, \-\-help" -Print a usage message and exit. +Display help text and exit. .TP .B "-v, \-\-version" -Print version information and exit. +Display version information and exit. .SH "VALID SHELLS" .B chsh will accept the full pathname of any executable file on the system.
login-utils/login.1 +1 -1
@@ -132,7 +132,7 @@ to tell that printing the hostname should be suppressed in the login: prompt. .TP .B \-V -Print version and exit. +Display version information and exit. .SH CONFIG FILE ITEMS .B login reads the
login-utils/nologin.8 +2 -2
@@ -20,9 +20,9 @@ is always 1. .PP .SH OPTIONS .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB-V, \-\-version" -Print version and exit. +Display version information and exit. .SH NOTES .B nologin is per-account way to disable login (usually used for system accounts like http or ftp).
login-utils/sulogin.8 +2 -2
@@ -64,9 +64,9 @@ shell. Specify the maximum amount of time to wait for user input. By default, sulogin will wait forever. .IP "\fB\-h\fR, \fB\-\-help\fP" -Print a help message. +Display help text and exit. .IP "\fB\-V\fR, \fB\-\-version\fP" -Output version. +Display version information and exit. .SH ENVIRONMENT VARIABLES .I sulogin looks for the environment variable
login-utils/utmpdump.1 +2 -2
@@ -36,9 +36,9 @@ Undump, write back edited login information into utmp or wtmp files. .IP "\fB\-o\fR, \fB\-\-output\fP \fIfile\fR Write command output to file instead of standard output. .IP "\fB\-h\fR, \fB\-\-help\fP" -Print a help text and exit. +Display help text and exit. .IP "\fB\-V\fR, \fB\-\-version\fP" -Output version information and exit. +Display version information and exit. .SH NOTES .B utmpdump can be useful in cases of corrupted utmp or wtmp entries. It can dump
misc-utils/cal.1 +1 -1
@@ -83,7 +83,7 @@ outputs to pipe, or is called from a script. Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help screen and exit. +Display help text and exit. .SH PARAMETERS A single parameter specifies the year to be displayed; note the year must be fully specified:
misc-utils/findmnt.8 +1 -1
@@ -74,7 +74,7 @@ than once, then tree-like output is disabled (see the \fB\-\-list\fP option). Print the first matching filesystem only. .TP .BR \-h , " \-\-help" -Print help and exit. +Display help text and exit. .TP .BR \-i , " \-\-invert" Invert the sense of matching.
misc-utils/getopt.1 +2 -4
@@ -92,8 +92,7 @@ Allow long options to start with a single .RB ' \- '. .TP .BR \-h , " \-\-help" -Output a small usage guide and exit successfully. No other output is -generated. +Display help text and exit. No other output is generated. .TP .BR \-l , " \-\-longoptions \fIlongopts\fP" The long (multi\-character) options to be recognized. More than one
@@ -172,8 +171,7 @@ is set, will return and error status 0. .TP .BR \-V , " \-\-version" -Output version information and exit successfully. No other output is -generated. +Display version information and exit. No other output is generated. .SH PARSING This section specifies the format of the second part of the parameters of
misc-utils/logger.1 +1 -1
@@ -54,7 +54,7 @@ port defined in /etc/services, which is often .IR 514 . .TP \fB\-h\fR, \fB\-\-help\fR -Display a help text and exit. +Display help text and exit. .TP \fB\-i\fR, \fB\-\-id\fR Log the process ID of the logger process with each line.
misc-utils/look.1 +1 -1
@@ -81,7 +81,7 @@ are compared. Display help text and exit. .TP .BR \-V , " \-\-version" -Output version information and exit. +Display version information and exit. .PP The .B look
misc-utils/lsblk.8 +2 -2
@@ -56,7 +56,7 @@ The authoritative information about filesystems and raids is provided by the command. .TP .BR \-h , " \-\-help" -Print a help text and exit. +Display help text and exit. .TP .BR \-I , " \-\-include " \fIlist\fP Include devices specified by the comma-separated \fIlist\fR of major device numbers.
@@ -106,7 +106,7 @@ This option is equivalent to .BR -o\ NAME,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,WSAME . .TP .BR \-V , " \-\-version" -Output version information and exit. +Display version information and exit. .SH NOTES For partitions, some information (e.g. queue attributes) is inherited from the parent device.
misc-utils/lslocks.8 +1 -1
@@ -16,7 +16,7 @@ lists information about all the currently held file locks in a Linux system. .SH OPTIONS .TP .BR \-h , " \-\-help" -Print a help text and exit. +Display help text and exit. .TP .BR \-n , " \-\-noheadings" Do not print a header line.
misc-utils/mcookie.1 +2 -2
@@ -34,10 +34,10 @@ input is read from stdin. Explain what is being done. .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display this help and exit. +Display help text and exit. .SH BUGS The entropy in the generated 128-bit is probably quite small (and, therefore, vulnerable to attack) unless a non-pseudorandom number generator
misc-utils/namei.1 +2 -2
@@ -55,9 +55,9 @@ Vertically align the modes and owners. .IP "\fB\-x, \-\-mountpoints\fP" Show mountpoint directories with a 'D' rather than a 'd'. .IP "\fB\-h\fR, \fB\-\-help\fR" -Output help text and exit. +Display help text and exit. .IP "\fB\-V\fR, \fB\-\-version\fR" -Output version information and exit. +Display version information and exit. .SH AUTHOR The original .B namei
misc-utils/wipefs.8 +2 -2
@@ -49,7 +49,7 @@ Force erasure, even if the filesystem is mounted. This is required in order to erase the partition table on a block device. .TP .BR \-h , " \-\-help" -Print help and exit. +Display help text and exit. .TP .BR -n , " \-\-no\-act" Causes everything to be done except for the write() call.
@@ -78,7 +78,7 @@ can be prefixed with 'no' to specify the types on which no action should be taken. For more details see mount(8). .TP .BR -V , " \-\-version" -Output version information and exit. +Display version information and exit. .SH EXAMPLES .TP .BR "wipefs --all --backup /dev/sdb"
mount-deprecated/mount.8 +2 -2
@@ -479,9 +479,9 @@ Command line options available for the .B mount command: .IP "\fB\-V, \-\-version\fP" -Output version. +Display version information and exit. .IP "\fB\-h, \-\-help\fP" -Print a help message. +Display help text and exit. .IP "\fB\-v, \-\-verbose\fP" Verbose mode. .IP "\fB\-a, \-\-all\fP"
schedutils/chrt.1 +1 -1
@@ -109,7 +109,7 @@ scheduling policy (Linux specific). Show status information. .TP .B -h, --help -Display usage information and exit. +Display help text and exit. .TP .B -V, --version Display version information and exit.
schedutils/ionice.1 +1 -1
@@ -83,7 +83,7 @@ run it even in case it was not possible to set the desired scheduling priority, which can happen due to insufficient privileges or an old kernel version. .TP .BR \-h , " \-\-help" -Display help and exit. +Display help text and exit. .TP .BR \-V , " \-\-version" Display version information and exit.
schedutils/taskset.1 +1 -1
@@ -83,7 +83,7 @@ are separated by commas and may include ranges. For example: .BR 0,5,7,9-11 . .TP .BR \-h ,\ \-\-help -Display usage information and exit. +Display help text and exit. .TP .BR \-V ,\ \-\-version Display version information and exit.
sys-utils/blkdiscard.8 +1 -1
@@ -38,7 +38,7 @@ MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB\-o, \-\-offset\fP \fIoffset\fP" Byte offset in the device from which to discard. Provided value will be aligned to the device sector size. Default value is zero.
sys-utils/chcpu.8 +1 -1
@@ -76,7 +76,7 @@ instance runs and returns it to the CPU pool. A CPU must be offline, see \-d, before it can be deconfigured. .TP .BR \-h , " \-\-help" -Display help information and exit. +Display help text and exit. .TP .BR \-V , " \-\-version" Display version information and exit.
sys-utils/ctrlaltdel.8 +2 -2
@@ -32,10 +32,10 @@ file. .SH OPTIONS .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH FILES .I /etc/rc.local .SH "SEE ALSO"
sys-utils/dmesg.1 +2 -2
@@ -60,7 +60,7 @@ output. Enable human-readable output. See also \fB\-\-color\fR, \fB\-\-reltime\fR and \fB\-\-nopager\fR. .IP "\fB\-h\fR, \fB\-\-help\fR" -Print a help text and exit. +Display help text and exit. .IP "\fB\-k\fR, \fB\-\-kernel\fR" Print kernel messages. .IP "\fB\-L\fR, \fB\-\-color\fR[=\fIwhen\fR]"
@@ -149,7 +149,7 @@ Do not print kernel's timestamps. .IP "\fB\-u\fR, \fB\-\-userspace\fR" Print userspace messages. .IP "\fB\-V\fR, \fB\-\-version\fR" -Output version information and exit. +Display version information and exit. .IP "\fB\-w\fR, \fB\-\-follow\fR" Wait for new messages. This feature is supported only on systems with a readable /dev/kmsg (since kernel 3.5.0).
sys-utils/eject.1 +2 -2
@@ -46,7 +46,7 @@ disk eject command. .IP "\fB\-F, \-\-force\fP" Force eject, don't check device type. .IP "\fB\-h, \-\-help\fP" -Print a help text and exit. +Display help text and exit. .IP "\fB\-i, \-\-manualeject \fIon|off\fP" This option controls locking of the hardware eject button. When enabled, the drive will not be ejected when the button is pressed. This is useful when you
@@ -83,7 +83,7 @@ This option specifies that the drive should be ejected using SCSI commands. Run in verbose mode; more information is displayed about what the command is doing. .IP "\fB\-V, \-\-version\fP" -Display program version and exit. +Display version information and exit. .IP "\fB\-x, \-\-cdspeed \fI<speed>\fP" With this option the drive is given a CD-ROM select speed command. The speed argument is a number indicating the desired speed (e.g. 8 for 8X speed), or 0
sys-utils/fallocate.1 +2 -2
@@ -40,9 +40,9 @@ Specifies the beginning offset of the allocation, in bytes. .IP "\fB\-l, \-\-length\fP \fIlength\fP Specifies the length of the allocation, in bytes. .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB-V, \-\-version" -Print version and exit. +Display version information and exit. .SH AUTHORS .UR [email protected] Eric Sandeen
sys-utils/flock.1 +2 -2
@@ -104,9 +104,9 @@ without arguments, to the shell with .BR -c . .TP \fB\-h\fP, \fB\-\-help\fP -Print a help message. +Display help text and exit. .IP "\fB\-V, \-\-version\fP" -Show version number and exit. +Display version information and exit. .SH EXAMPLES .TP shell1> flock /tmp -c cat
sys-utils/fsfreeze.8 +2 -2
@@ -39,7 +39,7 @@ the traditional atime semantics (mount option strictatime, for more details see .SH OPTIONS .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB\-f, \-\-freeze\fP" This option requests the specified a filesystem to be frozen from new modifications. When this is selected, all ongoing transactions in the
@@ -57,7 +57,7 @@ This option is used to un-freeze the filesystem and allow operations to continue. Any filesystem modifications that were blocked by the freeze are unblocked and allowed to complete. .IP "\fB\-V, \-\-version\fP" -Show version number and exit. +Display version information and exit. .SH AUTHOR .PP Written by Hajime Taira.
sys-utils/fstrim.8 +1 -1
@@ -36,7 +36,7 @@ GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g. "K" has the same meaning as "KiB") or the suffixes KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB\-o, \-\-offset\fP \fIoffset\fP" Byte offset in filesystem from which to begin searching for free blocks to discard. Default value is zero, starting at the beginning of the
sys-utils/hwclock.8 +2 -4
@@ -117,12 +117,10 @@ the difference every 10 seconds. This will also print the frequency offset and tick. .TP .BR \-h , \ \-\-help -Display a help text and exit. +Display help text and exit. .TP .BR \-V , \ \-\-version -Display the version of -.B hwclock -and exit. +Display version information and exit. .SH OPTIONS .PP
sys-utils/ipcmk.1 +2 -2
@@ -32,10 +32,10 @@ Message queue. Permission for the resource. Default is 0644. .TP \fB\-h\fR, \fB\-\-help\fR -Display a short help message and exit. +Display help text and exit. .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .PP .SH "SEE ALSO" .BR ipcrm (1),
sys-utils/ipcs.1 +1 -1
@@ -21,7 +21,7 @@ Print details only on the resource identified by .IR id . .TP \fB\-h\fR, \fB\-\-help\fR -Display a help text and exit. +Display help text and exit. .TP \fB\-V\fR, \fB\-\-version\fR Display version information and exit.
sys-utils/ldattach.8 +2 -2
@@ -96,10 +96,10 @@ to stay in the foreground so that it can be interrupted or debugged, and to print verbose messages about its progress to the standard error output. .TP \fB-h\fP | \fB--help\fP -Prints a usage message and exits. +Display help text and exit. .TP \fB-V\fP | \fB--version\fP -Prints the program version. +Display version information and exit. .TP \fB-s\fP \fIvalue\fP | \fB--speed\fP \fIvalue\fP Set the speed of the serial line to the specified value.
sys-utils/lscpu.1 +1 -1
@@ -107,7 +107,7 @@ When specifying the \fIlist\fP argument, the string of option, equal sign (=), a Examples: '\fB-e=cpu,node\fP' or '\fB--extended=cpu,node\fP'. .TP .BR \-h , " \-\-help" -Display help information and exit. +Display help text and exit. .TP .BR \-p , " \-\-parse" [=\fIlist\fP] Optimize the command output for easy parsing.
sys-utils/mount.8 +2 -2
@@ -553,9 +553,9 @@ Command line options available for the .B mount command: .IP "\fB\-V, \-\-version\fP" -Output version. +Display version information and exit. .IP "\fB\-h, \-\-help\fP" -Print a help message. +Display help text and exit. .IP "\fB\-v, \-\-verbose\fP" Verbose mode. .IP "\fB\-a, \-\-all\fP"
sys-utils/mountpoint.1 +1 -1
@@ -17,7 +17,7 @@ mountpoint \- see if a directory is a mountpoint checks if the directory is mentioned in the /proc/self/mountinfo file. .SH OPTIONS .IP "\fB\-h, \-\-help\fP" -Print help and exit. +Display help text and exit. .IP "\fB\-q, \-\-quiet\fP" Be quiet - don't print anything. .IP "\fB\-d, \-\-fs\-devno\fP"
sys-utils/nsenter.1 +1 -1
@@ -150,7 +150,7 @@ any children will also be in the newly entered PID namespace. Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display a help message and exit. +Display help text and exit. .SH SEE ALSO .BR setns (2), .BR clone (2)
sys-utils/pivot_root.8 +2 -2
@@ -35,10 +35,10 @@ shell's root or not). .SH OPTIONS .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH EXAMPLES Change the root file system to /dev/hda1 from an interactive shell: .sp
sys-utils/prlimit.1 +2 -2
@@ -47,7 +47,7 @@ Specify the process id, if none is given, it will use the running process. Define the output columns to use. If no output arrangement is specified, then a default set is used. Use \fB\-\-help\fP to get list of all supported columns. .IP "\fB\-V, \-\-version\fP" -Output version information and exit. +Display version information and exit. .IP "\fB\-\-verbose\fP" Verbose mode. .IP "\fB\-\-raw\fP"
@@ -55,7 +55,7 @@ Use the raw output format. .IP "\fB\-\-noheadings\fP" Do not print a header line. .IP "\fB\-h, \-\-help\fP" -Print a help text and exit. +Display help text and exit. .SH RESOURCE OPTIONS .IP "\fB\-c, \-\-core\fP[=limits]"
sys-utils/readprofile.8 +2 -4
@@ -86,12 +86,10 @@ the second is the name of the function, the third is the number of clock ticks and the last is the normalized load. .TP \fB\-V\fR, \fB\-\-version\fR -This makes -.B readprofile -print its version number and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH EXAMPLES Browse the profiling buffer ordering by clock ticks: .nf
sys-utils/renice.1 +2 -2
@@ -73,10 +73,10 @@ Force the succeeding arguments to be interpreted as process IDs (the default). .TP .BR \-h , " \-\-help" -Display a help text. +Display help text and exit. .TP .BR \-V , " \-\-version" -Display version information. +Display version information and exit. .SH EXAMPLES The following command would change the priority of the processes with PIDs 987 and 32, plus all processes owned by the users daemon and root:
sys-utils/rtcwake.8 +4 -4
@@ -47,14 +47,14 @@ appropriate for such suspend modes. Be verbose. .TP \fB-h\fP | \fB--help\fP -Display a short help message that shows how to use the program. +Display help text and exit. .TP \fB-V\fP | \fB--version\fP -Displays version information and exists. +Display version information and exit. .TP \fB-n\fP | \fB--dry-run\fP -This option does everything but actually setup alarm, suspend system or wait -for the alarm. +This option does everything apart from actually setting up the alarm, +suspending the system, or waiting for the alarm. .TP \fB-A\fP | \fB--adjfile\fP \fIfile\fP Specifies an alternative path to the adjust file.
sys-utils/setarch.8 +3 -2
@@ -27,10 +27,11 @@ is /bin/sh. Be verbose. .TP \fB\-h\fR, \fB\-\-help\fR -Display help (it is also displayed when setarch takes no arguments). +Display help text and exit. +(The help text is also displayed when \fBsetarch\fR receives no arguments.) .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-\-uname\-2.6\fR Causes the program to see a kernel version number beginning with 2.6.
sys-utils/setpriv.1 +1 -1
@@ -123,7 +123,7 @@ to fail at AppArmor's whim. Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help and exit. +Display help text and exit. .SH NOTES If applying any specified option fails, .I program
sys-utils/swapon.8 +2 -2
@@ -120,7 +120,7 @@ match that of the current running kernel. initializes the whole device and does not check for bad blocks. .TP .B \-h, \-\-help -Provide help. +Display help text and exit. .TP .B "\-L \fIlabel\fP" Use the partition that has the specified
@@ -176,7 +176,7 @@ Use the partition that has the specified Be verbose. .TP .B "\-V, \-\-version" -Display version. +Display version information and exit. .SH NOTES You should not use .B swapon
sys-utils/switch_root.8 +2 -2
@@ -24,9 +24,9 @@ process. .SH OPTIONS .IP "\fB\-h, \-\-help\fP" -show help and exit +Display help text and exit. .IP "\fB\-V, \-\-version\fP" -show version number and exit +Display version information and exit. .SH RETURN VALUE .B switch_root
sys-utils/umount.8 +2 -2
@@ -138,10 +138,10 @@ to specify the file system types on which no action should be taken. Verbose mode. .TP \fB\-h\fR, \fB\-\-help\fR -Print help message and exit. +Display help text and exit. .TP \fB\-V\fR, \fB\-\-version\fR -Print version and exit. +Display version information and exit. .SH "THE LOOP DEVICE" The .B umount
sys-utils/unshare.1 +1 -1
@@ -44,7 +44,7 @@ See \fBclone\fR(2) for the exact semantics of the flags. .SH OPTIONS .TP .BR \-h , " \-\-help" -Display a help message and exit. +Display help text and exit. .TP .BR \-i , " \-\-ipc" Unshare the IPC namespace.
sys-utils/wdctl.8 +3 -3
@@ -36,14 +36,14 @@ output arrangement is specified, then a default set is used. Use to get list of all supported columns. .IP "\fB\-O\fR, \fB\-\-oneline\fP" Print all wanted information on one line in key="value" output format. -.IP "\fB\-V\fR, \fB\-\-version\fP" -Output version information and exit. .IP "\fB\-r\fR, \fB\-\-raw\fP" Use the raw output format. .IP "\fB\-x\fR, \fB\-\-flags-only\fP" Same as \fB\-I \-T\fP. .IP "\fB\-h\fR, \fB\-\-help\fP" -Print a help text and exit. +Display help text and exit. +.IP "\fB\-V\fR, \fB\-\-version\fP" +Display version information and exit. .SH AUTHORS .MT kzak@\:redhat\:.com Karel Zak
term-utils/mesg.1 +2 -2
@@ -73,10 +73,10 @@ Permits messages to be displayed. Explain what is being done. .TP .B \-V, \-\-verbose -Output version information and exit. +Display version information and exit. .TP .B \-h, \-\-help -Output help screen and exit. +Display help text and exit. .PP If no arguments are given, .B mesg
term-utils/script.1 +2 -2
@@ -93,10 +93,10 @@ field indicates how many characters were output this time. This information can be used to replay typescripts with realistic typing and output delays. .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Output help and exit. +Display help text and exit. .SH NOTES The script ends when the forked shell exits (a .I control-D
term-utils/scriptreplay.1 +1 -1
@@ -60,7 +60,7 @@ because it divides the timings by this factor. Display version information and exit. .TP .BR \-h , " \-\-help" -Display a help message and exit. +Display help text and exit. .SH "EXAMPLE" .nf % script --timing=file.tm script.out
term-utils/setterm.1 +2 -2
@@ -180,10 +180,10 @@ Overrides the TERM environment variable. Sets the color for underlined characters. .TP .BR \-version -Output version information and exit. +Display version information and exit. .TP .BR \-help -Output help screen and exit. +Display help text and exit. .SH "SEE ALSO" .BR tput (1), .BR stty (1),
text-utils/col.1 +2 -2
@@ -84,10 +84,10 @@ lines in memory. By default, 128 lines are buffered. .It Fl V, Fl Fl version .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-H\fR, \fB\-\-help\fR -Output help and exit. +Display help text and exit. .SH NOTES The control sequences for carriage motion that .B col
text-utils/colcrt.1 +2 -2
@@ -61,10 +61,10 @@ option is useful for sending output to the line printer when the output contains superscripts and subscripts which would otherwise be invisible. .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Output help and exit. +Display help text and exit. .SH EXAMPLES A typical use of .B colcrt
text-utils/colrm.1 +2 -2
@@ -55,10 +55,10 @@ Column numbering starts with column 1. .SH OPTIONS .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Output help and exit. +Display help text and exit. .SH SEE ALSO .BR awk (1), .BR column (1),
text-utils/column.1 +1 -1
@@ -60,7 +60,7 @@ Specify the columns delimiter for table output (default is two spaces). .IP "\fB\-x, \-\-fillrows\fP" Fill columns before filling rows. .IP "\fB\-h, \-\-help\fP" -Display a help text and exit. +Display help text and exit. .SH ENVIRONMENT The environment variable COLUMNS is used to determine the size of the screen if no other information is available.
text-utils/rev.1 +2 -2
@@ -47,10 +47,10 @@ characters in every line. If no files are specified, standard input is read. .SH OPTIONS .TP \fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Output help and exit. +Display help text and exit. .SH SEE ALSO .BR tac (1) .SH AVAILABILITY
text-utils/tailf.1 +2 -2
@@ -50,10 +50,10 @@ output the last lines, instead of the last 10. .TP \fB\-V\fR, \fB\-\-version -Output version information and exit. +Display version information and exit. .TP \fB\-h\fR, \fB\-\-help -Display help and exit. +Display help text and exit. .SH AUTHOR This program was originally written by Rik Faith ([email protected]) and may be freely
text-utils/ul.1 +1 -1
@@ -73,7 +73,7 @@ type specified in the environment with Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display a help text and exit. +Display help text and exit. .SH ENVIRONMENT The following environment variable is used: .TP
Signature · 1 line
1.7.0.4
From 2958c1436662ed0d1736f63d34cc412896e5065a Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <[email protected]>
Date: Mon, 14 Oct 2013 22:02:00 +0200
Subject: [PATCH 3/4] docs: tweak wording and formatting of unshare and nsenter man pages
--- sys-utils/nsenter.1 | 10 +++++----- sys-utils/unshare.1 | 16 +++++++++------- 2 files changed, 14 insertions(+), 12 deletions(-)
sys-utils/nsenter.1 +5 -5
@@ -1,9 +1,9 @@ -.TH NSENTER 1 "May 2013" "util-linux" "User Commands" +.TH NSENTER 1 "June 2013" "util-linux" "User Commands" .SH NAME nsenter \- run program with namespaces of other processes .SH SYNOPSIS .B nsenter -.RB [ options ] +.RI [ options ] .RI [ program .RI [ arguments ]] .SH DESCRIPTION
@@ -123,13 +123,13 @@ file. \fB\-U\fR, \fB\-\-user\fR[=\fIfile\fR] Enter the user namespace. If no file is specified, enter the user namespace of the target process. If file is specified, enter the user namespace specified by -file. See also \fB\-\-setuid\fR and \fB\-\-setgid\fR options. +file. See also the \fB\-\-setuid\fR and \fB\-\-setgid\fR options. .TP \fB\-G\fR, \fB\-\-setgid\fR \fIgid\fR -Set group ID which will be used in the entered user namespace. +Set the group ID which will be used in the entered user namespace. .TP \fB\-S\fR, \fB\-\-setuid\fR \fIuid\fR -Set user ID which will be used in the entered user namespace. +Set the user ID which will be used in the entered user namespace. .TP \fB\-r\fR, \fB\-\-root\fR[=\fIdirectory\fR] Set the root directory. If no directory is specified, set the root directory to
sys-utils/unshare.1 +9 -7
@@ -1,17 +1,18 @@ .\" Process this file with .\" groff -man -Tascii lscpu.1 .\" -.TH UNSHARE 1 "May 2013" "util-linux" "User Commands" +.TH UNSHARE 1 "July 2013" "util-linux" "User Commands" .SH NAME unshare \- run program with some namespaces unshared from parent .SH SYNOPSIS .B unshare -.RB [ options ] +.RI [ options ] .I program .RI [ arguments ] .SH DESCRIPTION Unshares the indicated namespaces from the parent process and then executes -the specified program. Unshareable namespaces are: +the specified program. The namespaces to be unshared are indicated via +options. Unshareable namespaces are: .TP .BR "mount namespace" Mounting and unmounting filesystems will not affect the rest of the system
@@ -56,7 +57,8 @@ Unshare the mount namespace. Unshare the network namespace. .TP .BR \-p , " \-\-pid" -Unshare the pid namespace. See also \fB--fork\fP and \fB--mount-proc\fP options. +Unshare the pid namespace. +See also the \fB--fork\fP and \fB--mount-proc\fP options. .TP .BR \-u , " \-\-uts" Unshare the UTS namespace.
@@ -65,10 +67,10 @@ Unshare the UTS namespace. Unshare the user namespace. .TP .BR \-f , " \-\-fork" -Fork the specified process as a child of unshare rather than running it -directly. This is useful when creating a new pid namespace. +Fork the specified \fIprogram\fR as a child process of \fBunshare\fR rather than +running it directly. This is useful when creating a new pid namespace. .TP -.BR "\fB\-\-mount-proc\fR [=\fImountpoint\fP]" +.BR \-\-mount-proc "[=\fImountpoint\fP]" Just before running the program, mount the proc filesystem at the \fImountpoint\fP (default is /proc). This is useful when creating a new pid namespace. It also implies creating a new mount namespace since the /proc mount would otherwise
Signature · 1 line
1.7.0.4
From c4ea69634fcd32fc08ed81567359035f2a29c3dc Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <[email protected]>
Date: Mon, 14 Oct 2013 22:19:03 +0200
Subject: [PATCH 4/4] docs: tweak formatting and grammar of the ipcrm man page
--- sys-utils/ipcmk.1 | 2 +- sys-utils/ipcrm.1 | 46 +++++++++++++++++++++++----------------------- 2 files changed, 24 insertions(+), 24 deletions(-)
sys-utils/ipcmk.1 +1 -1
@@ -29,7 +29,7 @@ Message queue. .SH "ADDITIONAL OPTIONS" .TP \fB\-p\fR, \fB\-\-mode\fR [\fImode\fR] -Permission for the resource. Default is 0644. +Access permissions for the resource. Default is 0644. .TP \fB\-h\fR, \fB\-\-help\fR Display help text and exit.
sys-utils/ipcrm.1 +23 -23
101 lines not on this page · raw message
Signature · 1 line
1.7.0.4
Karel Zak
maintainerQuoted 31 lines · Benno Schulenberg
Attached is another small set of man-page tweaks. The second patch is a big one: it standardizes the phrases for the --help and --version options in all man pages.
By the way, when trying to build util-linux from git, I get errors for mount and getopt. The output of a second 'make -k':
make all-recursive
make[1]: Entering directory `/home/ben/UTLNX' Making all in po
make[2]: Entering directory/home/ben/UTLNX/po' make[2]: Nothing to be done forall'. make[2]: Leaving directory/home/ben/UTLNX/po' make[2]: Entering directory/home/ben/UTLNX'
rm: cannot remove 'mount': Is a directory make[2]: *** [mount] Error 1
rm: cannot remove 'getopt': Is a directory make[2]: *** [getopt] Error 1
make[2]: Targetall-am' not remade because of errors. make[2]: Leaving directory/home/ben/UTLNX' make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/home/ben/UTLNX'
make: *** [all] Error 2This has been like this for quite a while. I thought I must be doing something wrong or missing some tool, but I wonder.
Trying a 'make clean' ends in:
Quoted 7 lines
Making clean in .
make[1]: Entering directory `/home/ben/UTLNX'
rm -f dmesg mount umount wdctl mountpoint lsblk findmnt kill
rm: cannot remove 'mount': Is a directory
make[1]: *** [clean-binPROGRAMS] Error 1
make[1]: Leaving directory `/home/ben/UTLNX'
make: *** [clean-recursive] Error 1
Oh, it seems you have very old stuff in your work tree, try:
git clean -xdf
git checkout -f
or you can delete all and git clone again ;-)
Karel
Signature · 2 lines
Karel Zak <[email protected]> http://karelzak.blogspot.com
Quoted 9 lines · Karel Zak
Quoted 4 lines · Benno Schulenberg
rm: cannot remove 'mount': Is a directory make[2]: *** [mount] Error 1
rm: cannot remove 'getopt': Is a directory make[2]: *** [getopt] Error 1Oh, it seems you have very old stuff in your work tree, try:
git clean -xdf
Thanks, that worked:
$ git clean -dxf Removing getopt/ Removing mount/
Now it compiles fine, with only those five warnings in libfdisk/src/ask.c:
«format '%zd' expects argument of type 'signed size_t', but...» and two unused variables in misc-utils/cal.c (when compiled without ncurses).
Benno
Signature · 1 line
http://www.fastmail.fm - Choose from over 50 domains or use your own
Karel Zak
maintainerQuoted 3 lines · Benno Schulenberg
Now it compiles fine, with only those five warnings in
libfdisk/src/ask.c:
«format '%zd' expects argument of type 'signedsize_t', but...» and two unused variables inmisc-utils/cal.c(when compiled without ncurses).
Thanks! Fixed.
Karel
Signature · 2 lines
Karel Zak <[email protected]> http://karelzak.blogspot.com
Quoted 2 lines · Karel Zak
Quoted 1 line · Benno Schulenberg
Now it compiles fine, with only those five warnings in libfdisk/src/ask=
.c:
Quoted 1 line
Quoted 1 line
=C2=ABformat '%zd' expects argument of type 'signed
size_t', but...=C2=
=BB and two
Quoted 3 lines
Quoted 1 line
unused variables in
misc-utils/cal.c(when compiled without ncurses).=20
Thanks! Fixed.
Well... the warnings for ask.c have gone, but now I get these three for gpt= .c:
libfdisk/src/gpt.c: In function 'gpt_verify_disklabel':libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type '= long int', but argument 3 has type 'uint64_t' [-Wformat] libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type '= long int', but argument 5 has type 'uint64_t' [-Wformat] libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type '= long int', but argument 3 has type 'uint64_t' [-Wformat]
And the ones for cal.c are still there:
misc-utils/cal.c:139:20: warning: 'term' defined but not used [-Wunused-var= iable]misc-utils/cal.c:141:13: warning: 'Slen' defined but not used [-Wunused-var= iable]
Benno
--=20
http://www.fastmail.fm - Send your email first class
Karel Zak
maintainerQuoted 7 lines · Benno Schulenberg
Quoted 5 lines · Karel Zak
Quoted 3 lines · Benno Schulenberg
Now it compiles fine, with only those five warnings in
libfdisk/src/ask.c:
«format '%zd' expects argument of type 'signedsize_t', but...» and two unused variables inmisc-utils/cal.c(when compiled without ncurses).
Quoted 8 lines
Quoted 1 line
Thanks! Fixed.
Well... the warnings for
ask.chave gone, but now I get these three forgpt.c:
libfdisk/src/gpt.c: In function 'gpt_verify_disklabel':libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type 'long int', but argument 3 has type 'uint64_t' [-Wformat]libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type 'long int', but argument 5 has type 'uint64_t' [-Wformat]libfdisk/src/gpt.c:1540:7: warning: format '%ld' expects argument of type 'long int', but argument 3 has type 'uint64_t' [-Wformat]
I have fixed this in libfdisk branch (git hub) for the next release v2.25, for v2.24 it's tricky as a real fix requires changes to translated strings too.
I'll probably do the change after po/ stuff merge rather than cast from uint64_t from long.
Quoted 4 lines
And the ones for
cal.care still there:
misc-utils/cal.c:139:20: warning: 'term' defined but not used [-Wunused-variable]misc-utils/cal.c:141:13: warning: 'Slen' defined but not used [-Wunused-variable]
Ah, so you don't have libncurses as well as libtermcap :-) Fixed.
Thanks!
Karel
Signature · 2 lines
Karel Zak <[email protected]> http://karelzak.blogspot.com