]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
Manual pages: rename EXAMPLE section to EXAMPLES
authorMichael Kerrisk (man-pages) <mtk.manpages@gmail.com>
Mon, 25 May 2020 12:59:12 +0000 (14:59 +0200)
committerKarel Zak <kzak@redhat.com>
Thu, 28 May 2020 12:51:54 +0000 (14:51 +0200)
Earlier, I patched various pages to consistently use EXAMPLE as a
section heading, rather than EXAMPLES.  (At that time, both headings
occurred in util-linux, with roughly equal frequency.)

Since then, I've observed that EXAMPLES is the more common usage
across a large corpus of manual pages. So, in Linux the man-pages
project, I switched to using EXAMPLES also. This patch makes the same
change for util-linux.

Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
16 files changed:
misc-utils/logger.1
misc-utils/look.1
misc-utils/rename.1
misc-utils/uuidgen.1
misc-utils/whereis.1
schedutils/ionice.1
sys-utils/flock.1
sys-utils/prlimit.1
sys-utils/renice.1
sys-utils/setpriv.1
sys-utils/unshare.1
term-utils/scriptlive.1
term-utils/scriptreplay.1
text-utils/colcrt.1
text-utils/column.1
text-utils/hexdump.1

index 6dd53705d01b956dedf412da4d9eeba3962b76ce..3cf6b0b1ecded0fda999a27c32f577117955ebc4 100644 (file)
@@ -349,7 +349,7 @@ For the priority order and intended purposes of these facilities and levels, see
 The
 .B logger
 command is expected to be IEEE Std 1003.2 ("POSIX.2") compatible.
-.SH EXAMPLE
+.SH EXAMPLES
 .B logger System rebooted
 .br
 .B logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
index d33139e98ec375b282fce18c1c5e90388700ff0f..4367fa5eb3c853ed0ac96f2e7d99a23badcbafec 100644 (file)
@@ -108,7 +108,7 @@ the alternative dictionary
 The
 .B look
 utility appeared in Version 7 AT&T Unix.
-.SH EXAMPLE
+.SH EXAMPLES
 .RS
 .nf
 sort \-d /etc/passwd \-o /tmp/look.dict
index 64c70f7e4ea1c9381a0160ff4f33da5fda744bdb..701bc4f182f255f6d616f05c126e7713da74dac6 100644 (file)
@@ -84,7 +84,7 @@ nothing was renamed
 unanticipated error occurred
 .PD
 .RE
-.SH EXAMPLE
+.SH EXAMPLES
 Given the files
 .IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
 the commands
index 07d6461042c37f4ec32029aa28c8a9a29959a74d..0189587a3104153682d98210381e4d7067d750f4 100644 (file)
@@ -89,7 +89,7 @@ Generate the hash of the \fIname\fR.
 Interpret name \fIname\fR as a hexadecimal string.
 .SH CONFORMING TO
 OSF DCE 1.1
-.SH EXAMPLE
+.SH EXAMPLES
 uuidgen \-\-sha1 \-\-namespace @dns \-\-name "www.example.com"
 .SH AUTHORS
 .B uuidgen
index 8da51d8e9d5d80279071ac6c7880d2f876fa19ee..1b8c3be7cfd94e97a028be69f2e724df2c3226a1 100644 (file)
@@ -153,7 +153,7 @@ are displayed with
 .SH ENVIRONMENT
 .IP WHEREIS_DEBUG=all
 enables debug output.
-.SH EXAMPLE
+.SH EXAMPLES
 To find all files in
 .I /usr/\:bin
 which are not documented
index 415def55af7da6115fcc6e038aab12d76a411647..72dbae6af233dd9a52e9ad12996ae740e928ec4c 100644 (file)
@@ -116,7 +116,7 @@ Display version information and exit.
 .SH NOTES
 Linux supports I/O scheduling priorities and classes since 2.6.13 with the CFQ
 I/O scheduler.
-.SH EXAMPLE
+.SH EXAMPLES
 .LP
 .TP 7
 # \fBionice\fP \-c 3 \-p 89
index bea70c6be8fa94b04c5b15c82b14902d3c66ba88..def273dbd0ab4b0f390ba2b04ec581bb8d1734f4 100644 (file)
@@ -137,7 +137,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 EXAMPLE
+.SH EXAMPLES
 Note that "shell> " in examples is a command line prompt.
 .TP
 shell1> flock /tmp \-c cat
index 89933d90a1b6ddf92133d74161795d60af90b97b..0bf2db008171a59f9477e50fe559de992fd564f0 100644 (file)
@@ -93,7 +93,7 @@ Timeout for real-time tasks.
 The prlimit system call is supported since Linux 2.6.36, older kernels will
 break this program.
 
-.SH EXAMPLE
+.SH EXAMPLES
 .IP "\fBprlimit \-\-pid 13134\fP"
 Display limit values for all current resources.
 .IP "\fBprlimit \-\-pid 13134 \-\-rss \-\-nofile=1024:4095\fP"
index 99cc61f211c62147515f1ca53d1f84c5da49a153..cb98631432dda7a9d4d6253f02c5f96faec96d88 100644 (file)
@@ -101,7 +101,7 @@ negative (to make things go very fast).
 The
 .B renice
 command appeared in 4.0BSD.
-.SH EXAMPLE
+.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:
 .TP
index 222fa6388abf5f0c05f868ff789c9e82a0a7b887..d1bd5efda95e58579c05d3219ec141182e824d00 100644 (file)
@@ -190,7 +190,7 @@ Be careful with this tool \-\- it may have unexpected security consequences.
 For example, setting no_new_privs and then execing a program that is
 SELinux\-confined (as this tool would do) may prevent the SELinux
 restrictions from taking effect.
-.SH EXAMPLE
+.SH EXAMPLES
 If you're looking for behaviour similar to
 .BR su (1)/ runuser "(1), or " sudo (8)
 (without the
index 679f93715a9df3b9f43e265f09a267daec3b16de..ea170b13a45a0b7c172089c59908b3bd43b8d9b6 100644 (file)
@@ -28,7 +28,7 @@ Once a persistent \%namespace is no longer needed,
 it can be unpersisted by using
 .BR umount (8)
 to remove the bind mount.
-See the \fBEXAMPLE\fR section for more details.
+See the \fBEXAMPLES\fR section for more details.
 .PP
 .B unshare
 since util-linux version 2.36 uses /\fIproc/[pid]/ns/pid_for_children\fP and \fI/proc/[pid]/ns/time_for_children\fP
@@ -243,7 +243,7 @@ The proc and sysfs filesystems mounting as root in a user namespace have to be
 restricted so that a less privileged user can not get more access to sensitive
 files that a more privileged user made unavailable. In short the rule for proc
 and sysfs is as close to a bind mount as possible.
-.SH EXAMPLE
+.SH EXAMPLES
 .PP
 The following command creates a PID namespace, using
 .B \-\-fork
index 6639c73d1cad7df696d908e6c886c7a61c30485e..78694dcbbc3d4461df2ba3b0119c23c1a0839c04 100644 (file)
@@ -65,7 +65,7 @@ Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.SH EXAMPLE
+.SH EXAMPLES
 .nf
 % script --log-timing file.tm --log-in script.in
 Script started, file is script.out
index 4505ef8362bff73c8a24471147de095cc450e899..a93b8a79067573fa35fa36fe99a550f74eaf7996 100644 (file)
@@ -110,7 +110,7 @@ Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.SH EXAMPLE
+.SH EXAMPLES
 .nf
 % script --log-timing file.tm --log-out script.out
 Script started, file is script.out
index 90ded9577f49666343d08c1a65c88cf07b19f998..46c612bb7f52c6a8a7910b4c4825bb7e8f7ee917 100644 (file)
@@ -84,7 +84,7 @@ Lines are trimmed to 132 characters.
 .PP
 Some provision should be made for processing superscripts and subscripts in
 documents which are already double-spaced.
-.SH EXAMPLE
+.SH EXAMPLES
 A typical use of
 .B colcrt
 would be:
index e43d6fee406ec63ad969d304eba0963d0cafe2b7..5e4e29e68eb7acf730016d255d2b2887158d005d 100644 (file)
@@ -157,7 +157,7 @@ has since been corrected (see above). Other implementations of
 .B column
 may continue to use the older documentation, but the behavior should be
 identical in any case.
-.SH EXAMPLE
+.SH EXAMPLES
 Print fstab with header line and align number to the right:
 .EX
 \fBsed 's/#.*//' /etc/fstab | column \-\-table \-\-table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ \-\-table-right PASS,FREQ\fR
index f5728f939d3f39c4138737aac11cdb22340f78a1..abf1b83702159349924d865e8ddaf8848cfb512b 100644 (file)
@@ -347,7 +347,7 @@ exits 0 on success and >0 if an error occurred.
 The
 .B hexdump
 utility is expected to be IEEE Std 1003.2 ("POSIX.2") compatible.
-.SH EXAMPLE
+.SH EXAMPLES
 Display the input in perusal format:
 .nf
    "%06.6_ao "  12/1 "%3_u "