ericonr
/
util-linux
mirror of https://github.com/ericonr/util-linux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Manual pages: Standardize on EXAMPLE 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 EXAMPLE (10) or EXAMPLES (23).
Let's standardize on the EXAMPLE (which is also what is
suggested in man-pages(7)) and used consistently across
a large number of pages in the Linux man-pages project.

(I realize the choice to go EXAMPLE, rather than EXAMPLES,
may be debatable. If necessary, I'd write a patch that instead
goes the other way, but I'd prefer to follow man-pages(7).)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk (man-pages) 2020-05-19 14:51:48 +02:00 committed by Karel Zak
parent a8d0d330cf
commit bc281b0991
21 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
disk-utils/partx.8
View File

@ -144,7 +144,7 @@ Display version information and exit.
.TP .TP
.BR \-h , " \-\-help" .BR \-h , " \-\-help"
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
.TP .TP
partx \-\-show /dev/sdb3 partx \-\-show /dev/sdb3
.TQ .TQ

2
lib/terminal-colors.d.5
View File

@ -50,7 +50,7 @@ or
.I $HOME/.config/terminal-colors.d .I $HOME/.config/terminal-colors.d
overrides the global setting. overrides the global setting.
.SH EXAMPLES .SH EXAMPLE
Disable colors for all compatible utilities: Disable colors for all compatible utilities:
.RS .RS
.br .br

2
misc-utils/findmnt.8
View File

@ -260,7 +260,7 @@ It's possible to specify source (device) or target (mountpoint) to filter mount
.TP .TP
.B \-\-verbose .B \-\-verbose
Force findmnt to print more information (\fB\-\-verify\fP only for now). Force findmnt to print more information (\fB\-\-verify\fP only for now).
.SH EXAMPLES .SH EXAMPLE
.IP "\fBfindmnt \-\-fstab \-t nfs\fP" .IP "\fBfindmnt \-\-fstab \-t nfs\fP"
Prints all NFS filesystems defined in Prints all NFS filesystems defined in
.IR /etc/fstab . .IR /etc/fstab .

2
misc-utils/logger.1
View File

@ -345,7 +345,7 @@ l l.
.PP .PP
For the priority order and intended purposes of these facilities and levels, see For the priority order and intended purposes of these facilities and levels, see
.BR syslog (3). .BR syslog (3).
.SH EXAMPLES .SH EXAMPLE
.B logger System rebooted .B logger System rebooted
.br .br
.B logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc .B logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc

2
misc-utils/rename.1
View File

@ -40,7 +40,7 @@ Display version information and exit.
.TP .TP
.BR \-h , " \-\-help" .BR \-h , " \-\-help"
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
Given the files Given the files
.IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 , .IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
the commands the commands

2
misc-utils/uuidgen.1
View File

@ -89,7 +89,7 @@ Generate the hash of the \fIname\fR.
Interpret name \fIname\fR as a hexadecimal string. Interpret name \fIname\fR as a hexadecimal string.
.SH CONFORMING TO .SH CONFORMING TO
OSF DCE 1.1 OSF DCE 1.1
.SH EXAMPLES .SH EXAMPLE
uuidgen \-\-sha1 \-\-namespace @dns \-\-name "www.example.com" uuidgen \-\-sha1 \-\-namespace @dns \-\-name "www.example.com"
.SH AUTHORS .SH AUTHORS
.B uuidgen .B uuidgen

4
misc-utils/wipefs.8
View File

@ -65,7 +65,7 @@ restricted with the \fB\-t\fR option.
.TP .TP
.BR \-b , " \-\-backup" .BR \-b , " \-\-backup"
Create a signature backup to the file $HOME/wipefs-<devname>-<offset>.bak. Create a signature backup to the file $HOME/wipefs-<devname>-<offset>.bak.
For more details see the \fBEXAMPLES\fR section. For more details see the \fBEXAMPLE\fR section.
.TP .TP
.BR \-f , " \-\-force" .BR \-f , " \-\-force"
Force erasure, even if the filesystem is mounted. This is required in Force erasure, even if the filesystem is mounted. This is required in
@ -112,7 +112,7 @@ taken. For more details see mount(8).
.TP .TP
.BR \-V , " \-\-version" .BR \-V , " \-\-version"
Display version information and exit. Display version information and exit.
.SH EXAMPLES .SH EXAMPLE
.TP .TP
.B wipefs /dev/sda* .B wipefs /dev/sda*
Prints information about sda and all partitions on sda. Prints information about sda and all partitions on sda.

2
schedutils/ionice.1
View File

@ -113,7 +113,7 @@ scheduling parameters.
.TP .TP
.BR \-V , " \-\-version" .BR \-V , " \-\-version"
Display version information and exit. Display version information and exit.
.SH EXAMPLES .SH EXAMPLE
.LP .LP
.TP 7 .TP 7
# \fBionice\fP \-c 3 \-p 89 # \fBionice\fP \-c 3 \-p 89

2
sys-utils/chmem.8
View File

@ -91,7 +91,7 @@ failure
.TP .TP
.B 64 .B 64
partial success partial success
.SH EXAMPLES .SH EXAMPLE
.TP .TP
.B chmem \-\-enable 1024 .B chmem \-\-enable 1024
This command requests 1024 MiB of memory to be set online. This command requests 1024 MiB of memory to be set online.

2
sys-utils/flock.1
View File

@ -124,7 +124,7 @@ Display version information and exit.
.TP .TP
.BR \-h , " \-\-help" .BR \-h , " \-\-help"
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
Note that "shell> " in examples is a command line prompt. Note that "shell> " in examples is a command line prompt.
.TP .TP
shell1> flock /tmp \-c cat shell1> flock /tmp \-c cat

2
sys-utils/pivot_root.8
View File

@ -39,7 +39,7 @@ Display version information and exit.
.TP .TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
Change the root file system to /dev/hda1 from an interactive shell: Change the root file system to /dev/hda1 from an interactive shell:
.sp .sp
.nf .nf

2
sys-utils/prlimit.1
View File

@ -89,7 +89,7 @@ Maximum number of file locks held.
.IP "\fB\-y, \-\-rttime\fP[=\fIlimits\fR]" .IP "\fB\-y, \-\-rttime\fP[=\fIlimits\fR]"
Timeout for real-time tasks. Timeout for real-time tasks.
.SH EXAMPLES .SH EXAMPLE
.IP "\fBprlimit \-\-pid 13134\fP" .IP "\fBprlimit \-\-pid 13134\fP"
Display limit values for all current resources. Display limit values for all current resources.
.IP "\fBprlimit \-\-pid 13134 \-\-rss \-\-nofile=1024:4095\fP" .IP "\fBprlimit \-\-pid 13134 \-\-rss \-\-nofile=1024:4095\fP"

2
sys-utils/readprofile.8
View File

@ -90,7 +90,7 @@ Display version information and exit.
.TP .TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
Browse the profiling buffer ordering by clock ticks: Browse the profiling buffer ordering by clock ticks:
.nf .nf
readprofile | sort \-nr | less readprofile | sort \-nr | less

2
sys-utils/renice.1
View File

@ -77,7 +77,7 @@ Display version information and exit.
.TP .TP
.BR \-h , " \-\-help" .BR \-h , " \-\-help"
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
The following command would change the priority of the processes with 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: PIDs 987 and 32, plus all processes owned by the users daemon and root:
.TP .TP

2
sys-utils/rfkill.8
View File

@ -74,7 +74,7 @@ Disable the corresponding device.
Enable the corresponding device. If the device is hard\-blocked, for example Enable the corresponding device. If the device is hard\-blocked, for example
via a hardware switch, it will remain unavailable though it is now via a hardware switch, it will remain unavailable though it is now
soft\-unblocked. soft\-unblocked.
.SH EXAMPLES .SH EXAMPLE
rfkill --output ID,TYPE rfkill --output ID,TYPE
.br .br
rfkill block all rfkill block all

2
sys-utils/setarch.8
View File

@ -113,7 +113,7 @@ Display version information and exit.
.TP .TP
.BR \-h , " \-\-help" .BR \-h , " \-\-help"
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
setarch \-\-addr-no-randomize mytestprog setarch \-\-addr-no-randomize mytestprog
.br .br
setarch ppc32 rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm setarch ppc32 rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm

4
sys-utils/unshare.1
View File

@ -18,7 +18,7 @@ even after the \fIprogram\fR terminates (except PID namespaces where
permanently running init process is required). permanently running init process is required).
Once a persistent \%namespace is no longer needed, it can be unpersisted with Once a persistent \%namespace is no longer needed, it can be unpersisted with
.BR umount (8). .BR umount (8).
See the \fBEXAMPLES\fR section for more details. See the \fBEXAMPLE\fR section for more details.
.PP .PP
.B unshare .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 since util-linux version 2.36 uses /\fIproc/[pid]/ns/pid_for_children\fP and \fI/proc/[pid]/ns/time_for_children\fP
@ -259,7 +259,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 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 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. and sysfs is as close to a bind mount as possible.
.SH EXAMPLES .SH EXAMPLE
.TP .TP
.B # unshare \-\-fork \-\-pid \-\-mount-proc readlink /proc/self .B # unshare \-\-fork \-\-pid \-\-mount-proc readlink /proc/self
.TQ .TQ

2
term-utils/agetty.8
View File

@ -305,7 +305,7 @@ Display version information and exit.
\-\-help \-\-help
Display help text and exit. Display help text and exit.
.PP .PP
.SH EXAMPLES .SH EXAMPLE
This section shows examples for the process field of an entry in the This section shows examples for the process field of an entry in the
\fI/etc/inittab\fP file. You'll have to prepend appropriate values \fI/etc/inittab\fP file. You'll have to prepend appropriate values
for the other fields. See \fIinittab(5)\fP for more details. for the other fields. See \fIinittab(5)\fP for more details.

2
text-utils/colcrt.1
View File

@ -66,7 +66,7 @@ Display version information and exit.
.TP .TP
\fB\-h\fR, \fB\-\-help\fR \fB\-h\fR, \fB\-\-help\fR
Display help text and exit. Display help text and exit.
.SH EXAMPLES .SH EXAMPLE
A typical use of A typical use of
.B colcrt .B colcrt
would be: would be:

2
text-utils/column.1
View File

@ -126,7 +126,7 @@ Display help text and exit.
.SH ENVIRONMENT .SH ENVIRONMENT
The environment variable \fBCOLUMNS\fR is used to determine the size of The environment variable \fBCOLUMNS\fR is used to determine the size of
the screen if no other information is available. the screen if no other information is available.
.SH EXAMPLES .SH EXAMPLE
Print fstab with header line and align number to the right: Print fstab with header line and align number to the right:
.EX .EX
\fBsed 's/#.*//' /etc/fstab | column \-\-table \-\-table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ \-\-table-right PASS,FREQ\fR \fBsed 's/#.*//' /etc/fstab | column \-\-table \-\-table-columns SOURCE,TARGET,TYPE,OPTIONS,PASS,FREQ \-\-table-right PASS,FREQ\fR

2
text-utils/hexdump.1
View File

@ -343,7 +343,7 @@ used between format units than in the default output).
.SH EXIT STATUS .SH EXIT STATUS
.B hexdump .B hexdump
exits 0 on success and >0 if an error occurred. exits 0 on success and >0 if an error occurred.
.SH EXAMPLES .SH EXAMPLE
Display the input in perusal format: Display the input in perusal format:
.nf .nf
"%06.6_ao " 12/1 "%3_u " "%06.6_ao " 12/1 "%3_u "