Manual pages: Standardize on EXIT STATUS 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.

Currently we have EXIT STATUS (18), EXIT CODES (3), RETURN CODE (7),
RETURN CODES (1), or RETURN VALUE (4 instances in pages that document
commands, rather than functions).

Let's standardize on the EXIT STATUS (which is also what is
suggested in man-pages(7), and is the POSIX terminology).

A subsequent patch will clean up corresponding miswordings in
manual page text.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/disk-utils/fsck.minix.8 b/disk-utils/fsck.minix.8
index 2aabd2fa3d2771db9a54a66cc068212e9bdfe8c5..600b1e2da5d88a320e6d18464c9cb9dabec8e9cc 100644 (file)
--- a/disk-utils/fsck.minix.8
+++ b/disk-utils/fsck.minix.8
@@ -92,7 +92,7 @@ will print "unable to read super block".  If the device exists, but is not
 a MINIX filesystem,
 .B fsck.minix
 will print "bad magic number in super-block".
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B fsck.minix
 is the sum of the following:

diff --git a/disk-utils/mkfs.bfs.8 b/disk-utils/mkfs.bfs.8
index 9f2e7bb8713c665e1fda6623fbed3a5eb78b2ed0..ca0847227e390415190d062cdeff56ef97fbe006 100644 (file)
--- a/disk-utils/mkfs.bfs.8
+++ b/disk-utils/mkfs.bfs.8
@@ -47,7 +47,7 @@ Option
 only works as
 .B \-\-version
 when it is the only option.
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B mkfs.bfs
 is 0 when all went well, and 1 when something went wrong.

diff --git a/disk-utils/mkfs.minix.8 b/disk-utils/mkfs.minix.8
index 7486ca5bcb497b767f3bf608956df3f87feb0ad7..9a6b26c54b7bfcaad1422a9fb918d7bb6ec1f7e1 100644 (file)
--- a/disk-utils/mkfs.minix.8
+++ b/disk-utils/mkfs.minix.8
@@ -70,7 +70,7 @@ with other options.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 Display help text and exit.
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B mkfs.minix
 is one of the following:

diff --git a/misc-utils/blkid.8 b/misc-utils/blkid.8
index 6ef73f33c78f8602df07fff4d3a8a456666e8b23..6c0bbe43de5f9a16b85d591beb13af8e92a41b04 100644 (file)
--- a/misc-utils/blkid.8
+++ b/misc-utils/blkid.8
@@ -286,7 +286,7 @@ Look up the device that uses this filesystem \fIuuid\fR.  For more details see t
 .TP
 \fB\-V\fR, \fB\-\-version\fR
 Display version number and exit.
-.SH RETURN CODE
+.SH EXIT STATUS
 If the specified device or device addressed by specified token (option
 \fB\-\-match\-token\fR) was found and it's possible to gather any information about the
 device, an exit code 0 is returned.  Note the option \fB\-\-match\-tag\fR filters output

diff --git a/misc-utils/kill.1 b/misc-utils/kill.1
index 27258d293aac6b6ee75087df613197287d50626f..c0383faca487394a7c4643627cf87d731a466ad2 100644 (file)
--- a/misc-utils/kill.1
+++ b/misc-utils/kill.1
@@ -171,7 +171,7 @@ preferred in relation to the
 executable described by this manual.  Easiest way to ensure one is executing
 the executable is to use full path when calling the command, for example:
 .B "/bin/kill \-\-version"
-.SH RETURN CODES
+.SH EXIT STATUS
 .B kill
 has the following return codes:
 .PP

diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index b2f2133ae64570df9b3ac3e61723a8fbd74137ee..501ed938d9510af466dbd7aa2e8422cb2b38f9e0 100644 (file)
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -294,7 +294,7 @@ Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.SH RETURN VALUE
+.SH EXIT STATUS
 The
 .B logger
 utility exits 0 on success, and >0 if an error occurs.

diff --git a/misc-utils/lsblk.8 b/misc-utils/lsblk.8
index 1b73e6f258c61437c8bb7146f61ce3297035b811..cca345f1a85dafae99e81fccc864e305ffc30f4c 100644 (file)
--- a/misc-utils/lsblk.8
+++ b/misc-utils/lsblk.8
@@ -180,7 +180,7 @@ This sysfs block directory appeared in kernel 2.6.27 (October 2008).
 In case of problems with a new enough kernel, check that CONFIG_SYSFS
 was enabled at the time of the kernel build.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .IP 0
 success
 .IP 1

diff --git a/sys-utils/chcpu.8 b/sys-utils/chcpu.8
index 23191e2b957a54e0882716e4a0432cd8442a4632..7f94de53564dc56829c53bbf39499e4de2f9a286 100644 (file)
--- a/sys-utils/chcpu.8
+++ b/sys-utils/chcpu.8
@@ -77,7 +77,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .B chcpu
 has the following return codes:
 .TP

diff --git a/sys-utils/chmem.8 b/sys-utils/chmem.8
index c115140072fa6ad14ffc64d1187462aca7cfb515..21a8152c0755d043ca3eeb3cd66fef616a2eabc9 100644 (file)
--- a/sys-utils/chmem.8
+++ b/sys-utils/chmem.8
@@ -79,7 +79,7 @@ progress.
 .TP
 .BR \-V ", " \-\-version
 Print the version number, then exit.
-.SH RETURN CODES
+.SH EXIT STATUS
 .B chmem
 has the following return codes:
 .TP

diff --git a/sys-utils/fstrim.8 b/sys-utils/fstrim.8
index e3857f9d09e5f1bc0b25c841118af76d120bcd37..f8e4ebc6ff557cf41591f96f3b8b49fdaf7370ee 100644 (file)
--- a/sys-utils/fstrim.8
+++ b/sys-utils/fstrim.8
@@ -115,7 +115,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .IP 0
 success
 .IP 1

diff --git a/sys-utils/losetup.8 b/sys-utils/losetup.8
index 4cf548741d940265d03d2943a69334d238df9e46..6c4f603da2553b8caed8ed6cb661e7ae97e7f7e6 100644 (file)
--- a/sys-utils/losetup.8
+++ b/sys-utils/losetup.8
@@ -170,7 +170,7 @@ Display help text and exit.
 .B Cryptoloop is no longer supported in favor of dm-crypt.
 .B For more details see cryptsetup(8).
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B losetup
 returns 0 on success, nonzero on failure.  When
 .B losetup

diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index e31660baa6a39c7c9862d6339542a98af48fd631..a9df585ce152be482d7cec7aad943f410550d876 100644 (file)
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -2501,7 +2501,7 @@ initialize a new device if the same backing file is already used for some loop
 device with the same offset and sizelimit. This is necessary to avoid
 a filesystem corruption.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .B mount
 has the following return codes (the bits can be ORed):
 .TP

diff --git a/sys-utils/switch_root.8 b/sys-utils/switch_root.8
index b194a262fdbb83402795d14395e00013a712a585..b169817e938036b55934603ec245ff05528bce41 100644 (file)
--- a/sys-utils/switch_root.8
+++ b/sys-utils/switch_root.8
@@ -28,7 +28,7 @@ Display help text and exit.
 .IP "\fB\-V, \-\-version\fP"
 Display version information and exit.
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B switch_root
 returns 0 on success and 1 on failure.
 

diff --git a/sys-utils/zramctl.8 b/sys-utils/zramctl.8
index 12983f144376d42638766787a5fa58e9d52f7820..97e3f41188d5135f6cf7239f51dcd25cafed2984 100644 (file)
--- a/sys-utils/zramctl.8
+++ b/sys-utils/zramctl.8
@@ -95,7 +95,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B zramctl
 returns 0 on success, nonzero on failure.