textual: tweak several manpages, mainly the blkid one

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
This commit is contained in:
Benno Schulenberg 2011-02-27 16:28:14 +01:00 committed by Karel Zak
parent 70532ede1a
commit 0791a058fa
7 changed files with 70 additions and 72 deletions

View File

@ -5,9 +5,9 @@
.\" This file may be copied under the terms of the GNU Public License. .\" This file may be copied under the terms of the GNU Public License.
.\" .\"
.\" Based on uuidgen, Mon Sep 17 10:42:12 2000, Andreas Dilger .\" Based on uuidgen, Mon Sep 17 10:42:12 2000, Andreas Dilger
.TH BLKID 8 "February 2009" "Linux" "MAINTENANCE COMMANDS" .TH BLKID 8 "February 2011" "Linux" "MAINTENANCE COMMANDS"
.SH NAME .SH NAME
blkid \- command\-line utility to locate/print block device attributes blkid \- locate/print block device attributes
.SH SYNOPSIS .SH SYNOPSIS
.B blkid .B blkid
.RB \-L .RB \-L
@ -46,8 +46,7 @@ blkid \- command\-line utility to locate/print block device attributes
.IR list ] .IR list ]
.RB [ \-u .RB [ \-u
.IR list ] .IR list ]
.I device .IR device " ... "
[\fIdevice\fR ...]
.in -9 .in -9
.B blkid .B blkid
@ -56,22 +55,21 @@ blkid \- command\-line utility to locate/print block device attributes
.IR format ] .IR format ]
.RB [ \-s .RB [ \-s
.IR tag ] .IR tag ]
.I device .IR device " ... "
[\fIdevice\fR ...]
.SH DESCRIPTION .SH DESCRIPTION
The The
.B blkid .B blkid
program is the command-line interface to working with program is the command-line interface to working with the
.BR libblkid (3) .BR libblkid (3)
library. It can determine the type of content (e.g. filesystem, swap) library. It can determine the type of content (e.g. filesystem or swap)
a block device holds, and also attributes (tokens, NAME=value pairs) that a block device holds, and also attributes (tokens, NAME=value pairs)
from the content metadata (e.g. LABEL or UUID fields). from the content metadata (e.g. LABEL or UUID fields).
.PP .PP
.B blkid .B blkid
has two main forms of operation: either searching for a device with a has two main forms of operation: either searching for a device with a
specific NAME=value pair, or displaying NAME=value pairs for one or specific NAME=value pair, or displaying NAME=value pairs for one or
more devices. more specified devices.
.SH OPTIONS .SH OPTIONS
The \fIsize\fR and \fIoffset\fR arguments may be followed by binary (2^N) The \fIsize\fR and \fIoffset\fR arguments may be followed by binary (2^N)
suffixes KiB, MiB, GiB, TiB, PiB and EiB (the "iB" is optional, e.g. "K" has the suffixes KiB, MiB, GiB, TiB, PiB and EiB (the "iB" is optional, e.g. "K" has the
@ -94,12 +92,11 @@ devices which no longer exist.
Display a usage message and exit. Display a usage message and exit.
.TP .TP
.B \-i .B \-i
Display I/O Limits (aka I/O topology) information. The 'export' output format is Display I/O Limits (aka I/O topology) information. The 'export' output format is
automatically enabled. This option could be used together with \fB-p\fR option. automatically enabled. This option can be used together with the \fB-p\fR option.
.TP .TP
.B \-l .B \-l
Look up one device that matches the search parameter specified using Look up only one device that matches the search parameter specified with the
the
.B \-t .B \-t
option. If there are multiple devices that match the specified search option. If there are multiple devices that match the specified search
parameter, then the device with the highest priority is returned, and/or parameter, then the device with the highest priority is returned, and/or
@ -109,33 +106,33 @@ block devices. If this option is not specified,
.B blkid .B blkid
will print all of the devices that match the search parameter. will print all of the devices that match the search parameter.
.TP .TP
.B \-L " label " .BI \-L " label"
Look up one device that uses the label (same as: -l -o device -t Look up the device that uses this \fIlabel\fR (equal to: -l -o device -t
LABEL=<label>). This look up method is able to reliable use /dev/disk/by-label LABEL=<label>). This lookup method is able to reliably use /dev/disk/by-label
udev symlinks (depends on setting in /etc/blkid.conf). Avoid to use the udev symlinks (dependent on a setting in /etc/blkid.conf). Avoid using the
symlinks directly. It is not reliable to use the symlinks without verification. symlinks directly; it is not reliable to use the symlinks without verification.
The \fB-L\fR option works on systems with and without udev. The \fB-L\fR option works on systems with and without udev.
Unfortunately, the original Unfortunately, the original
.B blkid(8) .B blkid(8)
from e2fsprogs use the \fB-L\fR option as a from e2fsprogs use the \fB-L\fR option as a
synonym to the \fB-o list\fR option. For better portability use "-l -o device synonym for the \fB-o list\fR option. For better portability, use \fB-l -o device
-t LABEL=<label>" and "-o list" in your scripts rather than -L option. -t LABEL=<label>\fR and \fB-o list\fR in your scripts rather than the \fB-L\fR option.
.TP .TP
.B \-n " list " .BI \-n " list "
Restrict probing functions to defined (comma separated) list of superblock types (names). Restrict the probing functions to the specified (comma-separated) \fIlist\fR of
The list can be prefixed with "no" to specify the types which should be ignored. superblock types (names).
The list items may be prefixed with "no" to specify the types which should be ignored.
For example: For example:
.sp .sp
blkid -p -n vfat,ext3,ext4 /dev/sda1 blkid -p -n vfat,ext3,ext4 /dev/sda1
.sp .sp
probes for vfat, ext3 and ext4 filesystems, and probes for vfat, ext3 and ext4 filesystems, and
.sp .sp
blkid -p -u nominix /dev/sda1 blkid -p -n nominix /dev/sda1
.sp .sp
probes for all supported formats exclude minix filesystem. This option is probes for all supported formats except minix filesystems.
useful with This option is only useful together with \fB-p\fR.
\fB-p\fR only.
.TP .TP
.BI \-o " format" .BI \-o " format"
Display Display
@ -152,29 +149,29 @@ print all tags (the default)
print the value of the tags print the value of the tags
.TP .TP
.B list .B list
print the devices in a user-friendly format, this output format is unsupported print the devices in a user-friendly format; this output format is unsupported
for low-level probing (\fB-p\fR or \fB-i\fR) for low-level probing (\fB-p\fR or \fB-i\fR)
.TP .TP
.B device .B device
print the device name only, this output format is always enabled for \fB-L\fR print the device name only; this output format is always enabled for \fB-L\fR
and \fB-U\fR options and \fB-U\fR options
.TP .TP
.B udev .B udev
print key="value" pairs for easy import into the udev environment. The keys are print key="value" pairs for easy import into the udev environment; the keys are
prefixed by ID_FS_ or ID_PART_ prefixes. prefixed by ID_FS_ or ID_PART_ prefixes
The udev output returns ID_FS_AMBIVALENT tag if more superblocks are detected, The udev output returns the ID_FS_AMBIVALENT tag if more superblocks are detected,
and ID_PART_ENTRY_* tags are always returned for all partitions including empty and ID_PART_ENTRY_* tags are always returned for all partitions including empty
partitions. partitions.
.TP .TP
.B export .B export
print key=value pairs for easy import into the environment. This output format print key=value pairs for easy import into the environment; this output format
is automatically enabled when I/O Limits (\fB-i\fR option) are requested. is automatically enabled when I/O Limits (\fB-i\fR option) are requested
.RE .RE
.TP .TP
.BI \-O " offset" .BI \-O " offset"
Probe at the given offset (only useful with \fB-p\fR). This option could be Probe at the given \fIoffset\fR (only useful with \fB-p\fR). This option can be
used together with \fB-i\fR option. used together with the \fB-i\fR option.
.TP .TP
.BI \-p .BI \-p
Switch to low-level superblock probing mode (bypass cache). Switch to low-level superblock probing mode (bypass cache).
@ -212,22 +209,22 @@ and
If there are no devices specified on the command line, all block devices If there are no devices specified on the command line, all block devices
will be searched; otherwise only the specified devices are searched. will be searched; otherwise only the specified devices are searched.
.TP .TP
.B \-u " list " .BI \-u " list "
Restrict probing functions to defined (comma separated) list of "usage" types. Restrict the probing functions to the specified (comma-separated) \fIlist\fR of "usage" types.
Supported usage types are: filesystem, raid, crypto and other. The list can be Supported usage types are: filesystem, raid, crypto and other. The list items may be
prefixed with "no" to specify the usage types which should be ignored. For example: prefixed with "no" to specify the usage types which should be ignored. For example:
.sp .sp
blkid -p -u filesystem,other /dev/sda1 blkid -p -u filesystem,other /dev/sda1
.sp .sp
probes for all filesystems and others (e.g. swap) formats, and probes for all filesystem and other (e.g. swap) formats, and
.sp .sp
blkid -p -u noraid /dev/sda1 blkid -p -u noraid /dev/sda1
.sp .sp
probes for all supported formats exclude RAIDs. This option is useful with probes for all supported formats except RAIDs.
\fB-p\fR only. This option is only useful together with \fB-p\fR.
.TP .TP
.B \-U " uuid " .BI \-U " uuid "
Look up one device that uses the uuid. For more details see the \fB-L\fR option. Look up the device that uses this \fIuuid\fR. For more details see the \fB-L\fR option.
.TP .TP
.B \-v .B \-v
Display version number and exit. Display version number and exit.
@ -237,9 +234,9 @@ Write the device cache to
.I writecachefile .I writecachefile
instead of writing it to the default cache file instead of writing it to the default cache file
.IR /etc/blkid.tab . .IR /etc/blkid.tab .
If you don't want to save the cache to the default file, specify If you don't want to save the cache at all, specify
.IR /dev/null. .IR /dev/null.
If not specified it will be the same file as that given by the If not specified, it will be the same file as that given with the
.B \-c .B \-c
option. option.
.TP .TP
@ -256,11 +253,11 @@ If the specified token was found, or if any tags were shown from (specified)
devices, 0 is returned. devices, 0 is returned.
If the specified token was not found, or no (specified) devices could be If the specified token was not found, or no (specified) devices could be
identified an exit code of 2 is returned. identified, an exit code of 2 is returned.
For usage or other errors, an exit code of 4 is returned. For usage or other errors, an exit code of 4 is returned.
If the ambivalent low-level probing result was detected an exit code of 8 is If the ambivalent low-level probing result was detected, an exit code of 8 is
returned. returned.
.SH AUTHOR .SH AUTHOR
.B blkid .B blkid

View File

@ -4,7 +4,7 @@
.\" .\"
.TH FINDFS 8 "February 2009" "Linux" "MAINTENANCE COMMANDS" .TH FINDFS 8 "February 2009" "Linux" "MAINTENANCE COMMANDS"
.SH NAME .SH NAME
findfs \- Find a filesystem by label or UUID findfs \- find a filesystem by label or UUID
.SH SYNOPSIS .SH SYNOPSIS
.B findfs .B findfs
.BI LABEL= label .BI LABEL= label
@ -24,7 +24,7 @@ be printed on stdout.
.SH AUTHOR .SH AUTHOR
.B findfs .B findfs
was originally written by Theodore Ts'o (tytso@mit.edu) and re-written for was originally written by Theodore Ts'o (tytso@mit.edu) and re-written for
util-linux package by Karel Zak (kzak@redhat.com). the util-linux package by Karel Zak (kzak@redhat.com).
.SH AVAILABILITY .SH AVAILABILITY
The findfs command is part of the util-linux package and is available from The findfs command is part of the util-linux package and is available from
ftp://ftp.kernel.org/pub/linux/utils/util-linux/. ftp://ftp.kernel.org/pub/linux/utils/util-linux/.

View File

@ -26,8 +26,8 @@ it may be necessary to use the KILL (9) signal, since this signal cannot
be caught. be caught.
.PP .PP
Most modern shells have a builtin kill function, with a usage rather similar Most modern shells have a builtin kill function, with a usage rather similar
to that of the command described here. The `-a' and `-p' options, to that of the command described here. The `-a' and `-p' options,
and the possibility to specify pids by command name is a local extension. and the possibility to specify processes by command name are a local extension.
.PP .PP
If sig is 0, then no signal is sent, but error checking is still performed. If sig is 0, then no signal is sent, but error checking is still performed.
.SH OPTIONS .SH OPTIONS

View File

@ -72,13 +72,13 @@ Options:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl d .It Fl d
Dictionary character set and order, i.e. only alphanumeric characters Dictionary character set and order, i.e. only alphanumeric characters
are compared. (On by default if no file specified). are compared. (On by default if no file is specified).
.It Fl f .It Fl f
Ignore the case of alphabetic characters. (On by default if no file specified). Ignore the case of alphabetic characters. (On by default if no file is specified).
.It Fl a .It Fl a
Use the alternate dictionary Use the alternate dictionary
.Pa /usr/share/dict/web2 .Pa /usr/share/dict/web2 .
.It Fl t .It Fl t Ar termchar
Specify a string termination character, i.e. only the characters Specify a string termination character, i.e. only the characters
in in
.Ar string .Ar string
@ -109,8 +109,9 @@ option was specified.
This was incorrect and the current man page matches the historic This was incorrect and the current man page matches the historic
implementation. implementation.
.Sh HISTORY .Sh HISTORY
.Nm Look The
appeared in Version 7 AT&T Unix. .Nm look
utility appeared in Version 7 AT&T Unix.
.Sh AVAILABILITY .Sh AVAILABILITY
The look command is part of the util-linux package and is available from The look command is part of the util-linux package and is available from
ftp://ftp.kernel.org/pub/linux/utils/util-linux/. ftp://ftp.kernel.org/pub/linux/utils/util-linux/.

View File

@ -11,7 +11,7 @@ lsblk \- list block devices
.IR device... .IR device...
.SH DESCRIPTION .SH DESCRIPTION
.B lsblk .B lsblk
lists information about all or the specified block devices. The lists information about all or the specified block devices. The
.B lsblk .B lsblk
command reads the command reads the
.I sysfs .I sysfs
@ -30,7 +30,7 @@ Print the SIZE column in bytes rather than in human-readable format.
Don't print device holders or slaves. For example "lsblk --nodeps /dev/sda" prints Don't print device holders or slaves. For example "lsblk --nodeps /dev/sda" prints
information about the sda device only. information about the sda device only.
.IP "\fB\-e, \-\-exclude \fIlist\fP .IP "\fB\-e, \-\-exclude \fIlist\fP
Exclude the devices specified by a comma-delimited list of major device numbers. Exclude the devices specified by a comma-separated \fIlist\fR of major device numbers.
Note that RAM disks (major=1) are excluded by default. Note that RAM disks (major=1) are excluded by default.
.IP "\fB\-f, \-\-fs\fP .IP "\fB\-f, \-\-fs\fP
Output info about filesystems. This option is equivalent to "-o NAME,FSTYPE,LABEL,MOUNTPOINT". Output info about filesystems. This option is equivalent to "-o NAME,FSTYPE,LABEL,MOUNTPOINT".

View File

@ -3,7 +3,7 @@
.\" .\"
.TH RENAME 1 "1 January 2000" "" "Linux Programmer's Manual" .TH RENAME 1 "1 January 2000" "" "Linux Programmer's Manual"
.SH NAME .SH NAME
rename \- Rename files rename \- rename files
.SH SYNOPSIS .SH SYNOPSIS
.B rename .B rename
.IR "from to file" ... .IR "from to file" ...
@ -19,9 +19,9 @@ in their name by
.TP .TP
.BR \-V , " \-\-version" .BR \-V , " \-\-version"
Display version information and exit. Display version information and exit.
.TP
For example, given the files .SH EXAMPLES
Given the files
.IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 , .IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
the commands the commands

View File

@ -13,13 +13,13 @@ wipefs \- wipe a filesystem signature from a device
.I device .I device
.SH DESCRIPTION .SH DESCRIPTION
.B wipefs .B wipefs
allows to erase filesystem or raid signatures (magic strings) from the can erase filesystem or raid signatures (magic strings) from the specified
.I device .I device
to make the filesystem invisible for libblkid. to make the filesystem invisible for libblkid.
.B wipefs .B wipefs
does not erase the whole filesystem or any other data from the device. does not erase the filesystem itself nor any other data from the device.
When used without options -a or -o, it lists all visible filesystems and offsets When used without options \fB-a\fR or \fB-o\fR, it lists all visible filesystems
of their signatures. and the offsets of their signatures.
.SH OPTIONS .SH OPTIONS
.IP "\fB\-a, \-\-all\fP" .IP "\fB\-a, \-\-all\fP"
Erase all available signatures. Erase all available signatures.
@ -28,9 +28,9 @@ Print help and exit.
.IP "\fB\-n, \-\-no\-act\fP" .IP "\fB\-n, \-\-no\-act\fP"
Causes everything to be done except for the write() call. Causes everything to be done except for the write() call.
.IP "\fB\-o, \-\-offset\fP \fIoffset\fP .IP "\fB\-o, \-\-offset\fP \fIoffset\fP
Specifies location (in bytes) of the signature which should be erased from the Specify the location (in bytes) of the signature which should be erased from the
device. The offset number may include a "0x" prefix, and then the number will be device. The \fIoffset\fR number may include a "0x" prefix; then the number will be
read as a hex value. It is possible to specify multiple -o options. interpreted as a hex value. It is possible to specify multiple \fB-o\fR options.
The \fIoffset\fR argument may be followed by binary (2^N) suffixes KiB, MiB, The \fIoffset\fR argument may be followed by binary (2^N) suffixes KiB, MiB,
GiB, TiB, PiB and EiB (the "iB" is optional, e.g. "K" has the same meaning as GiB, TiB, PiB and EiB (the "iB" is optional, e.g. "K" has the same meaning as