Manual pages: Standardize on AUTHORS as section title
PATCH 1/7 Manual pages: Standardize on AUTHORS as section title
There is quite some value (in terms of readability and user expectations) if consistent names are used for the sections within manual pages. This patch is one of a series to bring about this consistency.
In the Linux man-pages project, I long ago did away with the AUTHOR(S) section, but I realize some projects like to keep this.
But, let's make sure that the section is consistently titled across pages. Currently we have AUTHOR (47) or AUTHORS (41). Let's standardize on the latter (which is also what is suggested in man-pages(7)).
--- disk-utils/blockdev.8 | 2 +- disk-utils/cfdisk.8 | 2 +- disk-utils/fdformat.8 | 2 +- disk-utils/raw.8 | 2 +- disk-utils/sfdisk.8 | 2 +- disk-utils/swaplabel.8 | 2 +- libblkid/libblkid.3 | 2 +- libuuid/man/uuid.3 | 2 +- libuuid/man/uuid_clear.3 | 2 +- libuuid/man/uuid_compare.3 | 2 +- libuuid/man/uuid_copy.3 | 2 +- libuuid/man/uuid_generate.3 | 2 +- libuuid/man/uuid_is_null.3 | 2 +- libuuid/man/uuid_parse.3 | 2 +- libuuid/man/uuid_time.3 | 2 +- libuuid/man/uuid_unparse.3 | 2 +- login-utils/chfn.1 | 2 +- login-utils/chsh.1 | 2 +- login-utils/last.1 | 2 +- login-utils/login.1 | 2 +- login-utils/newgrp.1 | 2 +- login-utils/sulogin.8 | 2 +- login-utils/utmpdump.1 | 2 +- misc-utils/blkid.8 | 2 +- misc-utils/findfs.8 | 2 +- misc-utils/hardlink.1 | 2 +- misc-utils/namei.1 | 2 +- misc-utils/uuidgen.1 | 2 +- misc-utils/wipefs.8 | 2 +- schedutils/taskset.1 | 2 +- sys-utils/blkdiscard.8 | 2 +- sys-utils/chcpu.8 | 2 +- sys-utils/ctrlaltdel.8 | 2 +- sys-utils/flock.1 | 2 +- sys-utils/fsfreeze.8 | 2 +- sys-utils/fstrim.8 | 2 +- sys-utils/ipcmk.1 | 2 +- sys-utils/ipcs.1 | 2 +- sys-utils/ldattach.8 | 2 +- sys-utils/lscpu.1 | 2 +- sys-utils/lsmem.1 | 2 +- sys-utils/mountpoint.1 | 2 +- sys-utils/setarch.8 | 2 +- sys-utils/setpriv.1 | 2 +- sys-utils/setsid.1 | 2 +- term-utils/scriptlive.1 | 2 +- term-utils/scriptreplay.1 | 2 +- 47 files changed, 47 insertions(+), 47 deletions(-)
disk-utils/blockdev.8 +1 -1
@@ -86,7 +86,7 @@ Set read-only. The currently active access to the device may not be affected by filesystem already mounted in read-write mode will not be affected. The change applies after remount. .IP "\fB\-\-setrw\fP" Set read-write. -.SH AUTHOR +.SH AUTHORS blockdev was written by Andries E.\& Brouwer and rewritten by Karel Zak. .SH AVAILABILITY The blockdev command is part of the util-linux package and is available from
disk-utils/cfdisk.8 +1 -1
@@ -193,7 +193,7 @@ use visible padding characters. Requires enabled LIBSMARTCOLS_DEBUG. .BR partprobe (8), .BR partx (8), .BR sfdisk (8) -.SH AUTHOR +.SH AUTHORS Karel Zak <[email protected]> .PP The current cfdisk implementation is based on the original cfdisk
disk-utils/fdformat.8 +1 -1
@@ -67,7 +67,7 @@ Display help text and exit. .BR emkfs (8), .BR mkfs (8), .BR setfdprm (8) -.SH AUTHOR +.SH AUTHORS Werner Almesberger ([email protected]) .SH AVAILABILITY The fdformat command is part of the util-linux package and is available from
disk-utils/raw.8 +1 -1
@@ -92,7 +92,7 @@ but is regarded either a bug or a feature depending on who you ask! Rather than using raw devices applications should prefer .BR open (2) devices, such as /dev/sda1, with the O_DIRECT flag. -.SH AUTHOR +.SH AUTHORS Stephen Tweedie ([email protected]) .SH AVAILABILITY The raw command is part of the util-linux package and is available from
disk-utils/sfdisk.8 +1 -1
@@ -627,7 +627,7 @@ enables libsmartcols debug output. .BR partprobe (8), .BR partx (8) -.SH AUTHOR +.SH AUTHORS Karel Zak <[email protected]> .PP The current sfdisk implementation is based on the original sfdisk
disk-utils/swaplabel.8 +1 -1
@@ -55,7 +55,7 @@ The \fI UUID\fR must be in the standard 8-4-4-4-12 character format, such as is output by .BR uuidgen (1). .PP -.SH AUTHOR +.SH AUTHORS .B swaplabel was written by Jason Borden <[email protected]> and Karel Zak <[email protected]>. .SH ENVIRONMENT
libblkid/libblkid.3 +1 -1
@@ -61,7 +61,7 @@ config file can be overridden by the environment variable BLKID_CONF. For more details about the config file see .BR blkid (8) man page. -.SH AUTHOR +.SH AUTHORS .B libblkid was written by Andreas Dilger for the ext2 filesystem utilities, with input from Ted Ts'o. The library was subsequently heavily modified by Ted Ts'o.
libuuid/man/uuid.3 +1 -1
@@ -49,7 +49,7 @@ of a name clash. .SH CONFORMING TO This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with RFC-4122. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_clear.3 +1 -1
@@ -44,7 +44,7 @@ The function sets the value of the supplied uuid variable .I uu to the NULL value. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_compare.3 +1 -1
@@ -50,7 +50,7 @@ Returns an integer less than, equal to, or greater than zero if is found, respectively, to be lexicographically less than, equal, or greater than .IR uu2 . -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_copy.3 +1 -1
@@ -46,7 +46,7 @@ function copies the UUID variable .SH RETURN VALUE The copied UUID is returned in the location pointed to by .IR dst . -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_generate.3 +1 -1
@@ -118,7 +118,7 @@ returns zero if the UUID has been generated in a safe manner, \-1 otherwise. .SH CONFORMING TO This library generates UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with RFC-4122. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_is_null.3 +1 -1
@@ -45,7 +45,7 @@ function compares the value of the supplied UUID variable .I uu to the NULL value. If the value is equal to the NULL UUID, 1 is returned, otherwise 0 is returned. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_parse.3 +1 -1
@@ -67,7 +67,7 @@ otherwise \-1 is returned. .SH CONFORMING TO This library parses UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with RFC-4122. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_time.3 +1 -1
@@ -59,7 +59,7 @@ the epoch, is also stored in the location pointed to by .I ret_tv (see .BR gettimeofday "(2))." -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
libuuid/man/uuid_unparse.3 +1 -1
@@ -62,7 +62,7 @@ and may be used. .SH CONFORMING TO This library unparses UUIDs compatible with OSF DCE 1.1. -.SH AUTHOR +.SH AUTHORS Theodore Y.\& Ts'o .SH AVAILABILITY .B libuuid
login-utils/chfn.1 +1 -1
@@ -101,7 +101,7 @@ Returns 0 if operation was successful, 1 if operation failed or command syntax w .BR finger (1), .BR login.defs (5), .BR passwd (5) -.SH AUTHOR +.SH AUTHORS Salvatore Valente <[email protected]> .SH AVAILABILITY The chfn command is part of the util-linux package and is available from
login-utils/chsh.1 +1 -1
@@ -60,7 +60,7 @@ Returns 0 if operation was successful, 1 if operation failed or command syntax w .BR login.defs (5), .BR passwd (5), .BR shells (5) -.SH AUTHOR +.SH AUTHORS Salvatore Valente <[email protected]> .SH AVAILABILITY The chsh command is part of the util-linux package and is available from
login-utils/last.1 +1 -1
@@ -182,7 +182,7 @@ command (for example, /var/log/wtmp .br /var/log/btmp -.SH AUTHOR +.SH AUTHORS .MT [email protected] Miquel van Smoorenburg .ME
login-utils/login.1 +1 -1
@@ -363,7 +363,7 @@ then the surrounding shell gets killed by vhangup() because it's no longer the true owner of the tty. This can be avoided by using .B exec login in a top-level shell or xterm. -.SH AUTHOR +.SH AUTHORS Derived from BSD login 5.40 (5/9/89) by .MT glad@\:daimi.\:dk Michael Glad
login-utils/newgrp.1 +1 -1
@@ -25,7 +25,7 @@ If no group is specified, the GID is changed to the login GID. .BR login (1), .BR group (5) -.SH AUTHOR +.SH AUTHORS Originally by Michael Haardt. Currently maintained by Peter Orbaek ([email protected]).
login-utils/sulogin.8 +1 -1
@@ -84,7 +84,7 @@ will try to execute root's shell from If that fails, it will fall back to .IR /bin/sh . -.SH AUTHOR +.SH AUTHORS .B sulogin was written by Miquel van Smoorenburg for sysvinit and later ported to util-linux by Dave Reisner and Karel Zak.
login-utils/utmpdump.1 +1 -1
@@ -78,7 +78,7 @@ option, as the format for the utmp/wtmp files strongly depends on the input format. This tool was .B not written for normal use, but for debugging only. -.SH AUTHOR +.SH AUTHORS Michael Krapp .SH SEE ALSO .BR last (1),
misc-utils/blkid.8 +1 -1
@@ -327,7 +327,7 @@ a comma-separated list. Default is "udev,scan". The "udev" method uses udev symlinks and the "scan" method scans all block devices from the .I /proc/partitions file. -.SH AUTHOR +.SH AUTHORS .B blkid was written by Andreas Dilger for libblkid and improved by Theodore Ts'o and Karel Zak.
misc-utils/findfs.8 +1 -1
@@ -60,7 +60,7 @@ label or uuid cannot be found usage error, wrong number of arguments or unknown option .PD .RE -.SH AUTHOR +.SH AUTHORS .B findfs was originally written by .MT [email protected]
misc-utils/hardlink.1 +1 -1
@@ -48,7 +48,7 @@ Display help text and exit. .TP .BR \-V , " \-\-version" Display version information and exit. -.SH AUTHOR +.SH AUTHORS .PP \fBhardlink\fR was written by Jakub Jelinek <[email protected]> and later modified by Ruediger Meier <[email protected]> and Karel Zak <[email protected]> for util-linux.
misc-utils/namei.1 +1 -1
@@ -63,7 +63,7 @@ Display version information and exit. .TP .BR \-h , " \-\-help" Display help text and exit. -.SH AUTHOR +.SH AUTHORS The original .B namei program was written by Roger Southwick <[email protected]>.
misc-utils/uuidgen.1 +1 -1
@@ -91,7 +91,7 @@ Interpret name \fIname\fR as a hexadecimal string. OSF DCE 1.1 .SH EXAMPLES uuidgen \-\-sha1 \-\-namespace @dns \-\-name "www.example.com" -.SH AUTHOR +.SH AUTHORS .B uuidgen was written by Andreas Dilger for libuuid. .SH SEE ALSO
misc-utils/wipefs.8 +1 -1
@@ -123,7 +123,7 @@ file ~/wipefs-sdb-<offset>.bak for each signature. .TP .B dd if=~/wipefs-sdb-0x00000438.bak of=/dev/sdb seek=$((0x00000438)) bs=1 conv=notrunc Restores an ext2 signature from the backup file ~/wipefs-sdb-0x00000438.bak. -.SH AUTHOR +.SH AUTHORS Karel Zak <[email protected]> .SH ENVIRONMENT .IP LIBBLKID_DEBUG=all
schedutils/taskset.1 +1 -1
@@ -129,7 +129,7 @@ A user can retrieve the affinity mask of any process. See .BR sched (7) for a description of the Linux scheduling scheme. -.SH AUTHOR +.SH AUTHORS Written by Robert M. Love. .SH COPYRIGHT Copyright \(co 2004 Robert M. Love.
sys-utils/blkdiscard.8 +1 -1
@@ -77,7 +77,7 @@ Display version information and exit. .TP .BR \-h , " \-\-help" Display help text and exit. -.SH AUTHOR +.SH AUTHORS .MT [email protected] Lukas Czerner .ME
sys-utils/chcpu.8 +1 -1
@@ -89,7 +89,7 @@ failure .TP .B 64 partial success -.SH AUTHOR +.SH AUTHORS .MT [email protected] Heiko Carstens .ME
sys-utils/ctrlaltdel.8 +1 -1
@@ -47,7 +47,7 @@ Display help text and exit. .SH SEE ALSO .BR init (8), .BR systemd (1) -.SH AUTHOR +.SH AUTHORS .UR [email protected] Peter Orbaek .UE
sys-utils/flock.1 +1 -1
@@ -188,7 +188,7 @@ option, or 1 by default. .PP When using the \fIcommand\fR variant, and executing the child worked, then the exit status is that of the child command. -.SH AUTHOR +.SH AUTHORS .UR [email protected] H. Peter Anvin .UE
sys-utils/fsfreeze.8 +1 -1
@@ -75,7 +75,7 @@ and Previous list may be incomplete, as more filesystems get support. If in doubt easiest way to know if a filesystem has support is create a small loopback mount and test freezing it. -.SH AUTHOR +.SH AUTHORS .PP Written by Hajime Taira. .SH NOTES
sys-utils/fstrim.8 +1 -1
@@ -129,7 +129,7 @@ The command .B fstrim \-\-all returns 0 (all succeeded), 32 (all failed) or 64 (some failed, some succeeded). -.SH AUTHOR +.SH AUTHORS .nf Lukas Czerner <[email protected]> Karel Zak <[email protected]>
sys-utils/ipcmk.1 +1 -1
@@ -43,7 +43,7 @@ Display help text and exit. .SH SEE ALSO .BR ipcrm (1), .BR ipcs (1) -.SH AUTHOR +.SH AUTHORS .MT [email protected] Hayden A. James .ME
sys-utils/ipcs.1 +1 -1
@@ -123,7 +123,7 @@ options not defined by POSIX. A portable application shall not use the and .B \-u options. -.SH AUTHOR +.SH AUTHORS .UR [email protected] Krishna Balasubramanian .UE
sys-utils/ldattach.8 +1 -1
@@ -145,7 +145,7 @@ Display help text and exit. .SH SEE ALSO .BR inputattach (1), .BR ttys (4) -.SH AUTHOR +.SH AUTHORS .nf Tilman Schmidt ([email protected]) .fi
sys-utils/lscpu.1 +1 -1
@@ -191,7 +191,7 @@ CPU only. Sometimes in Xen Dom0 the kernel reports wrong data. On virtual hardware the number of cores per socket, etc. can be wrong. -.SH AUTHOR +.SH AUTHORS .nf Cai Qian <[email protected]> Karel Zak <[email protected]>
sys-utils/lsmem.1 +1 -1
@@ -86,7 +86,7 @@ This option controls summary lines output. The optional argument \fIwhen\fP can \fBnever\fR, \fBalways\fR or \fBonly\fR. If the \fIwhen\fR argument is omitted, it defaults to \fB"only"\fR. The summary output is suppressed for \fB\-\-raw\fR, \fB\-\-pairs\fR and \fB\-\-json\fR. -.SH AUTHOR +.SH AUTHORS .B lsmem was originally written by Gerald Schaefer for s390-tools in Perl. The C version for util-linux was written by Clemens von Mann, Heiko Carstens and Karel Zak.
sys-utils/mountpoint.1 +1 -1
@@ -43,7 +43,7 @@ Display version information and exit. Display help text and exit. .SH EXIT STATUS Zero if the directory or file is a mountpoint, non-zero if not. -.SH AUTHOR +.SH AUTHORS .PP Karel Zak <[email protected]> .SH ENVIRONMENT
sys-utils/setarch.8 +1 -1
@@ -121,7 +121,7 @@ setarch ppc32 rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm setarch ppc32 \-v \-vL3 rpmbuild \-\-target=ppc \-\-rebuild bar.src.rpm .br setarch ppc32 \-\-32bit rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm -.SH AUTHOR +.SH AUTHORS .MT [email protected] Elliot Lee .ME
sys-utils/setpriv.1 +1 -1
@@ -209,7 +209,7 @@ try: .BR su (1), .BR prctl (2), .BR capabilities (7) -.SH AUTHOR +.SH AUTHORS .MT [email protected] Andy Lutomirski .ME
sys-utils/setsid.1 +1 -1
@@ -35,7 +35,7 @@ Display version information and exit. Display help text and exit. .SH SEE ALSO .BR setsid (2) -.SH AUTHOR +.SH AUTHORS Rick Sladkey <[email protected]> .SH AVAILABILITY The setsid command is part of the util-linux package and is available from
term-utils/scriptlive.1 +1 -1
@@ -86,7 +86,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .PP Released under the GNU General Public License version 2 or later. -.SH AUTHOR +.SH AUTHORS .MT kzak@\:redhat.com Karel Zak .ME .
term-utils/scriptreplay.1 +1 -1
@@ -133,7 +133,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .PP Released under the GNU General Public License version 2 or later. -.SH AUTHOR +.SH AUTHORS The original .B scriptreplay program was written by
Signature · 6 lines
2.26.2 -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Karel Zak
maintainerQuoted 1 line · Michael Kerrisk (man-pages)
47 files changed, 47 insertions(+), 47 deletions(-)
All 7 patches applied. Thanks!
Please, use the same prefix for all patches subject line -- for example "Manual pages:" is nice. We use the prefix to generate release notes. Thanks ;-)
Karel
Signature · 2 lines
Karel Zak <[email protected]> http://karelzak.blogspot.com
Hello Karel,
Quoted 5 lines · Karel Zak
Quoted 1 line · Michael Kerrisk (man-pages)
47 files changed, 47 insertions(+), 47 deletions(-)All 7 patches applied. Thanks!
Thanks!
Quoted 2 lines
Please, use the same prefix for all patches subject line -- for example "Manual pages:" is nice. We use the prefix to generate release notes.
Got it. (I do something similar for my changelog/release notes.)
Cheers,
Michael
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/