Hi, Attached bunch of patches does some minor cleaning up of several of the man pages, mainly in wording and formatting. The first patch uniformizes the headers and footers also of the troff-formatted pages, by using some empty arguments to achieve the desired result. The third patch does the same for the forgotten vipw page. The fifth patch, apart from rewording and reformatting, removes a superfluous pair of brackets and a superfluous argument from the first synopsis line on the ionice man page, and indicates for the --pid option that multiple PIDs are allowed. The sixth patch normalizes the formatting of several pages, but also fixes some significant typos: it corrects for example "swapinfo" to "swaplabel" on the swaplabel man page, and corrects the "blocks" argument to "size" on the mkfs page. Regards, Benno -- http://www.fastmail.fm - Email service worth paying for. Try it for free
From 4d2afd6c4c74604253ddfd94a7986d205fb6ced1 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Tue, 23 Aug 2011 22:10:49 +0200 Subject: [PATCH 1/6] docs: also uniformize headers and footers of troff-formatted man pages Add two spaces as the required third argument of the date line to make the specified date get used instead of today's date. Incorporate the section number into the page title, then use an empty section number, so that specifying an explicit section/volume name will work. Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- misc-utils/logger.1 | 4 ++-- sys-utils/renice.1 | 4 ++-- term-utils/script.1 | 4 ++-- term-utils/wall.1 | 4 ++-- text-utils/col.1 | 4 ++-- text-utils/colcrt.1 | 4 ++-- text-utils/colrm.1 | 4 ++-- text-utils/hexdump.1 | 4 ++-- text-utils/more.1 | 4 ++-- text-utils/rev.1 | 4 ++-- text-utils/ul.1 | 4 ++-- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/misc-utils/logger.1 b/misc-utils/logger.1 index 98a1a06..08f3705 100644 --- a/misc-utils/logger.1 +++ b/misc-utils/logger.1 @@ -33,8 +33,8 @@ .\" .\" Section on valid facility and level strings added by .\" and1000@xxxxxxxxxx, 26 Oct 1997. -.Dd August 2011 -.Dt LOGGER 1 +.Dd August 2011 " " +.Dt LOGGER(1) "" "User Commands" .Os util-linux .Sh NAME .Nm logger diff --git a/sys-utils/renice.1 b/sys-utils/renice.1 index f283645..6b9d01a 100644 --- a/sys-utils/renice.1 +++ b/sys-utils/renice.1 @@ -31,8 +31,8 @@ .\" .\" @(#)renice.8 8.1 (Berkeley) 6/9/93 .\" -.Dd November 2010 -.Dt RENICE 1 +.Dd November 2010 " " +.Dt RENICE(1) "" "User Commands" .Os util-linux .Sh NAME .Nm renice diff --git a/term-utils/script.1 b/term-utils/script.1 index e111d08..dd1fdc5 100644 --- a/term-utils/script.1 +++ b/term-utils/script.1 @@ -31,8 +31,8 @@ .\" .\" @(#)script.1 6.5 (Berkeley) 7/27/91 .\" -.Dd February 2011 -.Dt SCRIPT 1 +.Dd February 2011 " " +.Dt SCRIPT(1) "" "User Commands" .Os util-linux .Sh NAME .Nm script diff --git a/term-utils/wall.1 b/term-utils/wall.1 index 541a8d0..24f81c5 100644 --- a/term-utils/wall.1 +++ b/term-utils/wall.1 @@ -33,8 +33,8 @@ .\" .\" Modified for Linux, Mon Mar 8 18:07:38 1993, faith@xxxxxxxxxx .\" -.Dd April 2011 -.Dt WALL 1 +.Dd April 2011 " " +.Dt WALL(1) "" "User Commands" .Os util-linux .Sh NAME .Nm wall diff --git a/text-utils/col.1 b/text-utils/col.1 index d9879d5..7f3e413 100644 --- a/text-utils/col.1 +++ b/text-utils/col.1 @@ -34,8 +34,8 @@ .\" .\" @(#)col.1 6.8 (Berkeley) 6/17/91 .\" -.Dd May 2011 -.Dt COL 1 +.Dd May 2011 " " +.Dt COL(1) "" "User Commands" .Os util-linux .Sh NAME .Nm col diff --git a/text-utils/colcrt.1 b/text-utils/colcrt.1 index e65c8e9..b7650c6 100644 --- a/text-utils/colcrt.1 +++ b/text-utils/colcrt.1 @@ -31,8 +31,8 @@ .\" .\" @(#)colcrt.1 8.1 (Berkeley) 6/30/93 .\" -.Dd May 2011 -.Dt COLCRT 1 +.Dd May 2011 " " +.Dt COLCRT(1) "" "User Commands" .Os util-linux .Sh NAME .Nm colcrt diff --git a/text-utils/colrm.1 b/text-utils/colrm.1 index 38c4f4e..f81e363 100644 --- a/text-utils/colrm.1 +++ b/text-utils/colrm.1 @@ -31,8 +31,8 @@ .\" .\" @(#)colrm.1 6.6 (Berkeley) 3/14/91 .\" -.Dd May 2011 -.Dt COLRM 1 +.Dd May 2011 " " +.Dt COLRM(1) "" "User Commands" .Os util-linux .Sh NAME .Nm colrm diff --git a/text-utils/hexdump.1 b/text-utils/hexdump.1 index 20dbad2..4ae6565 100644 --- a/text-utils/hexdump.1 +++ b/text-utils/hexdump.1 @@ -31,8 +31,8 @@ .\" .\" from: @(#)hexdump.1 8.2 (Berkeley) 4/18/94 .\" -.Dd July 2009 -.Dt HEXDUMP 1 +.Dd July 2009 " " +.Dt HEXDUMP(1) "" "User Commands" .Os util-linux .Sh NAME .Nm hexdump diff --git a/text-utils/more.1 b/text-utils/more.1 index 73f65a0..1ef71ec 100644 --- a/text-utils/more.1 +++ b/text-utils/more.1 @@ -37,8 +37,8 @@ .\" conform with the more 5.19 currently in use by the Linux community. .\" .\" .Dd July 29, 1991 (Modified December 25, 1992) -.Dd February 2011 -.Dt MORE 1 +.Dd February 2011 " " +.Dt MORE(1) "" "User Commands" .Os util-linux .Sh NAME .Nm more diff --git a/text-utils/rev.1 b/text-utils/rev.1 index 7dc6804..6ae4a86 100644 --- a/text-utils/rev.1 +++ b/text-utils/rev.1 @@ -33,8 +33,8 @@ .\" Modified for Linux by Charles Hannum (mycroft@xxxxxxxxxxxxxx) .\" and Brian Koehmstedt (bpk@xxxxxxxxxxxxxx) .\" -.Dd April 2011 -.Dt REV 1 +.Dd April 2011 " " +.Dt REV(1) "" "User Commands" .Os util-linux .Sh NAME .Nm rev diff --git a/text-utils/ul.1 b/text-utils/ul.1 index 6d93531..5827bf7 100644 --- a/text-utils/ul.1 +++ b/text-utils/ul.1 @@ -31,8 +31,8 @@ .\" .\" @(#)ul.1 8.1 (Berkeley) 6/6/93 .\" -.Dd August 2011 -.Dt UL 1 +.Dd August 2011 " " +.Dt UL(1) "" "User Commands" .Os util-linux .Sh NAME .Nm ul -- 1.7.0.4
From a2ba81910b0ddcd92da0f0b88efd75fc5adbfa9d Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Thu, 25 Aug 2011 22:26:13 +0200 Subject: [PATCH 2/6] docs: tweak the formatting and wording of some text-utils man pages Highlight the program name, use proper lowercase, remove unneeded commas and articles, and add helpful hyphenation. Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- text-utils/col.1 | 12 ++++++------ text-utils/colcrt.1 | 2 +- text-utils/colrm.1 | 2 +- text-utils/hexdump.1 | 43 +++++++++++++++++++++++++------------------ text-utils/more.1 | 9 +++++---- text-utils/rev.1 | 4 ++-- text-utils/ul.1 | 4 ++-- 7 files changed, 42 insertions(+), 34 deletions(-) diff --git a/text-utils/col.1 b/text-utils/col.1 index 7f3e413..bbec8fe 100644 --- a/text-utils/col.1 +++ b/text-utils/col.1 @@ -45,16 +45,16 @@ .Op Fl bfphx .Op Fl l Ar num .Sh DESCRIPTION -.Nm Col -filters out reverse (and half reverse) line feeds so the output is -in the correct order with only forward and half forward line +.Nm +filters out reverse (and half-reverse) line feeds so the output is +in the correct order with only forward and half-forward line feeds, and replaces white-space characters with tabs where possible. This can be useful in processing the output of .Xr nroff 1 and .Xr tbl 1 . .Pp -.Nm Col +.Nm reads from standard input and writes to standard output. .Pp The options are as follows: @@ -64,7 +64,7 @@ Do not output any backspaces, printing only the last character written to each column position. .It Fl f, Fl Fl fine Forward half line feeds are permitted (``fine'' mode). -Normally characters printed on a half line boundary are printed +Normally characters printed on a half-line boundary are printed on the following line. .It Fl p, Fl Fl pass Force unknown control sequences to be passed through unchanged. @@ -120,7 +120,7 @@ reverse line feed (11) All unrecognized control characters and escape sequences are discarded. .Pp -.Nm Col +.Nm keeps track of the character set as characters are read and makes sure the character set is correct when they are output. .Pp diff --git a/text-utils/colcrt.1 b/text-utils/colcrt.1 index b7650c6..fb4535b 100644 --- a/text-utils/colcrt.1 +++ b/text-utils/colcrt.1 @@ -43,7 +43,7 @@ .Op Fl \&2 .Op Ar .Sh DESCRIPTION -.Nm Colcrt +.Nm provides virtual half-line and reverse line feed sequences for terminals without such capability, and on which overstriking is destructive. diff --git a/text-utils/colrm.1 b/text-utils/colrm.1 index f81e363..3bc214d 100644 --- a/text-utils/colrm.1 +++ b/text-utils/colrm.1 @@ -41,7 +41,7 @@ .Nm colrm .Op Ar startcol Op Ar endcol .Sh DESCRIPTION -.Nm Colrm +.Nm removes selected columns from a file. Input is taken from standard input. Output is sent to standard output. .Pp diff --git a/text-utils/hexdump.1 b/text-utils/hexdump.1 index 4ae6565..ce783c1 100644 --- a/text-utils/hexdump.1 +++ b/text-utils/hexdump.1 @@ -36,7 +36,7 @@ .Os util-linux .Sh NAME .Nm hexdump -.Nd ascii, decimal, hexadecimal, octal dump +.Nd display file contents in ascii, decimal, hexadecimal, or octal .Sh SYNOPSIS .Nm .Op Fl bcCdovx @@ -54,8 +54,10 @@ .Ek .Ar file ... .Sh DESCRIPTION -The hexdump utility is a filter which displays the specified files, or -the standard input, if no files are specified, in a user specified +The +.Nm +utility is a filter which displays the specified files, or +standard input if no files are specified, in a user-specified format. .Pp The options are as follows: @@ -63,22 +65,22 @@ The options are as follows: .It Fl b .Em One-byte octal display . Display the input offset in hexadecimal, followed by sixteen -space-separated, three column, zero-filled, bytes of input data, +space-separated, three-column, zero-filled bytes of input data, in octal, per line. .It Fl c .Em One-byte character display . Display the input offset in hexadecimal, followed by sixteen -space-separated, three column, space-filled, characters of input +space-separated, three-column, space-filled characters of input data per line. .It Fl C .Em Canonical hex+ASCII display . Display the input offset in hexadecimal, followed by sixteen -space-separated, two column, hexadecimal bytes, followed by the +space-separated, two-column, hexadecimal bytes, followed by the same sixteen bytes in %_p format enclosed in ``|'' characters. .It Fl d .Em Two-byte decimal display . Display the input offset in hexadecimal, followed by eight -space-separated, five column, zero-filled, two-byte units +space-separated, five-column, zero-filled, two-byte units of input data, in unsigned decimal, per line. .It Fl e Ar format_string Specify a format string to be used for displaying data. @@ -94,7 +96,7 @@ bytes of input. .It Fl o .Em Two-byte octal display . Display the input offset in hexadecimal, followed by eight -space-separated, six column, zero-filled, two byte quantities of +space-separated, six-column, zero-filled, two-byte quantities of input data, in octal, per line. .It Fl s Ar offset Skip @@ -129,18 +131,20 @@ respectively. .It Fl v The .Fl v -option causes hexdump to display all input data. +option causes +.Nm +to display all input data. Without the .Fl v -option, any number of groups of output lines, which would be +option, any number of groups of output lines which would be identical to the immediately preceding group of output lines (except for the input offsets), are replaced with a line comprised of a single asterisk. .It Fl x .Em Two-byte hexadecimal display . -Display the input offset in hexadecimal, followed by eight, space -separated, four column, zero-filled, two-byte quantities of input -data, in hexadecimal, per line. +Display the input offset in hexadecimal, followed by eight +space-separated, four-column, zero-filled, two-byte quantities of +input data, in hexadecimal, per line. .El .Pp For each input file, @@ -206,7 +210,9 @@ described in the C standard are supported: .Ed .El .Pp -Hexdump also supports the following additional conversion strings: +The +.Nm +utility also supports the following additional conversion strings: .Bl -tag -width Fl .It Cm \&_a Ns Op Cm dox Display the input offset, cumulative across input files, of the @@ -225,10 +231,10 @@ conversion string except that it is only performed once, when all of the input data has been processed. .It Cm \&_c Output characters in the default character set. -Nonprinting characters are displayed in three character, zero-padded +Nonprinting characters are displayed in three-character, zero-padded octal, except for those representable by standard escape notation (see above), -which are displayed as two character strings. +which are displayed as two-character strings. .It Cm _p Output characters in the default character set. Nonprinting characters are displayed as a single @@ -278,8 +284,9 @@ not have a specified iteration count, have the iteration count incremented until the entire input block has been processed or there is not enough data remaining in the block to satisfy the format string. .Pp -If, either as a result of user specification or hexdump modifying -the iteration count as described above, an iteration count is +If, either as a result of user specification or +.Nm +modifying the iteration count as described above, an iteration count is greater than one, no trailing whitespace characters are output during the last iteration. .Pp diff --git a/text-utils/more.1 b/text-utils/more.1 index 1ef71ec..480b558 100644 --- a/text-utils/more.1 +++ b/text-utils/more.1 @@ -51,15 +51,15 @@ .Op +\fIlinenum\fP .Op Ar .Sh DESCRIPTION -.Nm More +.Nm is a filter for paging through text one screenful at a time. This version is especially primitive. Users should realize that .Xr less 1 provides .Xr more 1 -emulation and extensive enhancements. +emulation plus extensive enhancements. .Sh OPTIONS -Command line options are described below. +Command-line options are described below. Options are also taken from the environment variable .Ev MORE (make sure to precede them with a dash (``-'')) but command @@ -88,7 +88,8 @@ folded). .It Fl p Do not scroll. Instead, clear the whole screen and then display the text. .Pp -Notice that this option is switched automatically on if executable is named to `page'. +Notice that this option is switched on automatically if the executable is named +.Nm page . .It Fl c Do not scroll. Instead, paint each screen from the top, clearing the remainder of each line as it is displayed. diff --git a/text-utils/rev.1 b/text-utils/rev.1 index 6ae4a86..f8850e0 100644 --- a/text-utils/rev.1 +++ b/text-utils/rev.1 @@ -47,9 +47,9 @@ .Sh DESCRIPTION The .Nm rev -utility copies the specified files to the standard output, reversing the +utility copies the specified files to standard output, reversing the order of characters in every line. -If no files are specified, the standard input is read. +If no files are specified, standard input is read. .Bl -tag -width Ds .It Fl V, Fl Fl version Output version information and exit. diff --git a/text-utils/ul.1 b/text-utils/ul.1 index 5827bf7..dd1764e 100644 --- a/text-utils/ul.1 +++ b/text-utils/ul.1 @@ -52,8 +52,8 @@ by the environment variable The .Pa terminfo database is read to determine the appropriate sequences for underlining. -If the terminal is incapable of underlining, but is capable of -a standout mode then that is used instead. +If the terminal is incapable of underlining but is capable of +a standout mode, then that is used instead. If the terminal can overstrike, or handles underlining automatically, .Nm ul -- 1.7.0.4
From 98d74975151f1fcb002bafc31542cb7c454ee416 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Fri, 26 Aug 2011 10:54:03 +0200 Subject: [PATCH 3/6] vipw: (man page) uniformize header and footer, tweak the formatting Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- login-utils/vipw.8 | 25 +++++++++++++++---------- 1 files changed, 15 insertions(+), 10 deletions(-) diff --git a/login-utils/vipw.8 b/login-utils/vipw.8 index 6ed482d..eacf2c1 100644 --- a/login-utils/vipw.8 +++ b/login-utils/vipw.8 @@ -31,12 +31,12 @@ .\" .\" from: @(#)vipw.8 6.7 (Berkeley) 3/16/91 .\" -.Dd 7 July 1996 -.Dt VIPW 8 -.Os Util-Linux 2.6 +.Dd July 1996 " " +.Dt VIPW(8) "" "System Administration" +.Os util-linux .Sh NAME .Nm vipw, vigr -.Nd edit the password or group files +.Nd edit the password or group file .Sh SYNOPSIS .Nm vipw .Op Fl V @@ -45,22 +45,27 @@ .Op Fl V .Op Fl -version .Sh DESCRIPTION -.Nm Vipw +.Nm vipw edits the password file after setting the appropriate locks, and does any necessary processing after the password file is unlocked. If the password file is already locked for editing by another user, .Nm vipw will ask you -to try again later. The default editor for +to try again later. The default editor for .Nm vipw +and +.Nm vigr is .Xr vi 1 . -.br -.Nm Vigr -edits the group file in the same manner as vipw. +.Nm vigr +edits the group file in the same manner as +.Nm vipw +does the passwd file. .Sh ENVIRONMENT If the following environment variable exists it will be utilized by -.Nm vipw : +.Nm vipw +and +.Nm vigr : .Bl -tag -width EDITOR .It Ev EDITOR The editor specified by the string -- 1.7.0.4
From 98318ea9c7134a94fe39cb156de5517ab528d8db Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Fri, 26 Aug 2011 15:48:44 +0200 Subject: [PATCH 4/6] look: adjust the formatting and some wording of the man page Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- misc-utils/look.1 | 48 ++++++++++++++++++++++++++---------------------- 1 files changed, 26 insertions(+), 22 deletions(-) diff --git a/misc-utils/look.1 b/misc-utils/look.1 index bed3d24..fe8d8fd 100644 --- a/misc-utils/look.1 +++ b/misc-utils/look.1 @@ -36,20 +36,20 @@ look \- display lines beginning with a given string .SH SYNOPSIS .B look -[\fIoptions\fR] \fIstring \fR[\fIfile\fR] +.RI [ options ] " string " [ file ] .SH DESCRIPTION The .B look utility displays any lines in .I file which contain -.I string +.IR string . As .B look performs a binary search, the lines in .I file -must be sorted (where sort(1) got the same options \-d and/or \-f -that +must be sorted (where sort(1) got the same options +.BR "\-d " and/or " \-f " that .B look is invoked with). .PP @@ -61,51 +61,55 @@ is used, only alphanumeric characters are compared and the case of alphabetic characters is ignored. .SH OPTIONS .TP -\fB\-a\fR, \fB\-\-alternative\fR -Use alternative dictionary file. +.BR \-a , " \-\-alternative" +Use the alternative dictionary file. .TP -\fB\-d\fR, \fB\-\-alphanum\fR -Dictionary character set and order, i.e. only alphanumeric characters are -compared. (On by default if no file is specified). +.BR \-d , " \-\-alphanum" +Use normal dictionary character set and order, i.e. only alphanumeric characters +are compared. (This is on by default if no file is specified.) .TP -\fB\-f\fR, \fB\-\-ignore\-case\fR -Ignore the case of alphabetic characters. (On by default if no file is -specified). +.BR \-f , " \-\-ignore\-case" +Ignore the case of alphabetic characters. (This is on by default if no file is +specified.) .TP -\fB\-t\fR, \fB\-\-terminate\fR=\fIC\fR +.BR \-t , " \-\-terminate " \fIcharacter\fR Specify a string termination character, i.e. only the characters -in string up to and including the first occurrence of termchar +in \fIstring\fR up to and including the first occurrence of \fIcharacter\fR are compared. .TP -\fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +.BR \-h , " \-\-help" +Display help text and exit. .TP -\fB\-h\fR, \fB\-\-help\fR -Display help screen and exit. +.BR \-V , " \-\-version" +Output version information and exit. .PP -The look utility exits 0 if one or more lines were found and displayed, 1 if +The +.B look +utility exits 0 if one or more lines were found and displayed, 1 if no lines were found, and >1 if an error occurred. .SH EXAMPLE +.RS .nf sort -d /etc/passwd -o /tmp/look.dict look -t: root:foobar /tmp/look.dict .nf +.RE .SH FILES .IX Header "FILES" .IP "\fB/usr/share/dict/words\fR" 4 the dictionary .IP "\fB/usr/share/dict/web2\fR" 4 -the alternate dictionary +the alternative dictionary .SH "SEE ALSO" .BR grep (1), .BR sort (1) .SH COMPATIBILITY The original manual page stated that tabs and blank characters participated -in comparisons when the alphanum option was specified. This was incorrect +in comparisons when the alphanum option was specified. This was incorrect, and the current man page matches the historic implementation. .SH HISTORY The -look +.B look utility appeared in Version 7 AT&T Unix. .SH AVAILABILITY The look command is part of the util-linux package and is available from -- 1.7.0.4
From 4ba60add954baa3eb43772ea1df5b4462b19b519 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Fri, 26 Aug 2011 16:40:36 +0200 Subject: [PATCH 5/6] ionice: adjust synopsis and wording and formatting on the man page Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- schedutils/ionice.1 | 56 ++++++++++++++++++++++++++------------------------ 1 files changed, 29 insertions(+), 27 deletions(-) diff --git a/schedutils/ionice.1 b/schedutils/ionice.1 index acf6c92..163df1d 100644 --- a/schedutils/ionice.1 +++ b/schedutils/ionice.1 @@ -3,32 +3,33 @@ ionice \- set or get process I/O scheduling class and priority .SH SYNOPSIS .B ionice -[[ \fB\-c\fR +.RB [ \-c .IR class ] -.RB [ \fB-n\fR +.RB [ \-n .IR level ] -.RB [ \fB-t\fR ]] -.BI \fB-p\fR -PID -.RI [ PID ]... +.RB [ \-t ] +.B \-p +.IR PID ... .br .B ionice -.RB [ \fB-c\fR +.RB [ \-c .IR class ] -.RB [ \fB-n\fR +.RB [ \-n .IR level ] -.RB [ \fB-t\fR ] -.IR COMMAND -[ ARG ]... +.RB [ \-t ] +.IR "command " [ argument ...] .SH DESCRIPTION This program sets or gets the I/O scheduling class and priority for a program. If no arguments or just \fB\-p\fR is given, \fBionice\fR will query the current I/O scheduling class and priority for that process. -If no class is given, then -.I COMMAND +When \fIcommand\fR is given, +.B ionice +will run this command with the given arguments. +If no \fIclass\fR is specified, then +.I command will be executed with the "best-effort" scheduling class. The default -priority argument is 4. +priority level is 4. As of this writing, a process can be in one of three scheduling classes: .IP "\fBIdle\fP" @@ -63,27 +64,28 @@ will receive on each scheduling window. This scheduling class is not permitted for an ordinary (i.e., non-root) user. .SH OPTIONS .TP -\fB\-c\fR, \fB\-\-class\fR \fICLASS\fR -The scheduling class name or number; \fI0\fR for none, \fI1\fR for realtime, \fI2\fR for -best-effort, \fI3\fR for idle. +.BR \-c , " \-\-class " \fIclass\fR +Specify the name or number of the scheduling class to use; \fI0\fR for none, +\fI1\fR for realtime, \fI2\fR for best-effort, \fI3\fR for idle. .TP -\fB\-n\fR, \fB\-\-classdata\fR \fINUM\fR -The scheduling class data. This defines the class data, if the class -accepts an argument. For realtime and best-effort, \fI0-7\fR is valid data. +.BR \-n , " \-\-classdata " \fIlevel\fR +Specify the scheduling class data. This only has an effect if the class +accepts an argument. For realtime and best-effort, \fI0-7\fR are valid data +(priority levels). .TP -\fB\-p\fR, \fB\-\-pid\fR \fIPID\fR -Pass in process PID(s) to view or change already running processes. If this argument -is not given, \fBionice\fP will run the listed program with the given parameters. +.BR \-p , " \-\-pid " \fIPID\fR... +Specify the process IDs of running processes for which to get or set the +scheduling parameters. .TP -\fB\-t\fR, \fB\-\-ignore\fR -Ignore failure to set the requested priority. If COMMAND or PID(s) is specified, +.BR \-t , " \-\-ignore" +Ignore failure to set the requested priority. If \fIcommand\fR was specified, run it even in case it was not possible to set the desired scheduling priority, which can happen due to insufficient privileges or an old kernel version. .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h , " \-\-help" Display help and exit. .TP -\fB\-V\fR, \fB\-\-version\fR +.BR \-V , " \-\-version" Display version information and exit. .SH EXAMPLES .LP -- 1.7.0.4
From 3cd7c5408bfe3129056bbc60b0b1b59a1f25a022 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> Date: Sun, 28 Aug 2011 11:14:42 +0200 Subject: [PATCH 6/6] docs: tweak the formatting and wording of several disk-utils man pages Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx> --- disk-utils/elvtune.8 | 30 +++++++++++++------------ disk-utils/fdformat.8 | 9 +++---- disk-utils/fsck.minix.8 | 36 +++++++++++++++--------------- disk-utils/isosize.8 | 14 ++++++------ disk-utils/mkfs.8 | 22 ++++++++++-------- disk-utils/mkfs.bfs.8 | 40 ++++++++++++++++++--------------- disk-utils/mkfs.minix.8 | 12 +++++----- disk-utils/mkswap.8 | 55 +++++++++++++++++++++++++--------------------- disk-utils/raw.8 | 20 +++++++--------- disk-utils/swaplabel.8 | 35 +++++++++++++++-------------- misc-utils/rename.1 | 12 +++++----- misc-utils/uuidgen.1 | 19 +++++++-------- 12 files changed, 157 insertions(+), 147 deletions(-) diff --git a/disk-utils/elvtune.8 b/disk-utils/elvtune.8 index 6321ee1..f71b1d4 100644 --- a/disk-utils/elvtune.8 +++ b/disk-utils/elvtune.8 @@ -17,42 +17,44 @@ elvtune \- I/O elevator tuner .B elvtune \-v .SH DESCRIPTION .B elvtune -allows to tune the I/O elevator per blockdevice queue basis. The -tuning can be safely done at runtime. Tuning the elevator means -being able to change disk performance and interactiveness. In the -output of elvtune the address of the queue tuned will be shown -and it can be considered as a queue ID. -For example multiple partitions in the same harddisk will +allows to tune the I/O elevator per blockdevice queue. The +tuning can be safely done at runtime. Tuning the elevator means +being able to change disk performance and interactiveness. +In the output of +.B elvtune +the address of the queue tuned will be shown; +it can be considered as a queue ID. +Multiple partitions on the same harddisk will share the same queue and so tuning one partition will be like tuning the whole HD. .SH OPTIONS .TP .BI -r \ r_lat -set the max latency that the I/O scheduler will provide on +Set the maximum latency that the I/O scheduler will provide on each read. .TP .BI -w \ w_lat -set the max latency that the I/O scheduler will provide on +Set the maximum latency that the I/O scheduler will provide on each write. .TP .BI -b \ b_max -max coalescing factor allowed on writes when there are reads +Set the maximum coalescing factor allowed on writes when there are reads pending in the queue. .TP .BI -h -help. +Display help text and exit. .TP .BI -v -version. +Display version version information and exit. .SH NOTE -Actually the only fields tunable are those relative -to the IO scheduler. It's not possible to select +Actually, the only fields tunable are those relative +to the IO scheduler. It's not possible to select a one-way or two-way elevator yet. .PP For logical blockdevices like LVM the tuning has to be done on the .I physical -devices. Tuning the queue of the LVM logical device +devices. Tuning the queue of the LVM logical device is useless. .SH RETURN VALUE 0 on success and 1 on failure. diff --git a/disk-utils/fdformat.8 b/disk-utils/fdformat.8 index 67c5d03..d02241e 100644 --- a/disk-utils/fdformat.8 +++ b/disk-utils/fdformat.8 @@ -5,12 +5,12 @@ fdformat \- low-level format a floppy disk .SH SYNOPSIS .B fdformat -[\fIoptions\fR] \fIdevice\fR +.RI [ options ] " device" .SH DESCRIPTION .B fdformat -does a low level format on a floppy disk. +does a low-level format on a floppy disk. .I device -is usually one of the following (for floppy devices, the major = 2, and the +is usually one of the following (for floppy devices the major = 2, and the minor is shown for informational purposes only): .sp .nf @@ -46,8 +46,7 @@ to load the disk parameters. .SH OPTIONS .TP \fB\-n\fR, \fB\-\-no\-verify\fR -No verify. This option will disable the verification that is performed -after the format. +Skip the verification that is normally performed after the formatting. .TP \fB\-V\fR, \fB\-\-version\fR Output version information and exit. diff --git a/disk-utils/fsck.minix.8 b/disk-utils/fsck.minix.8 index 8f25b0b..e84b82b 100644 --- a/disk-utils/fsck.minix.8 +++ b/disk-utils/fsck.minix.8 @@ -14,13 +14,13 @@ performs a consistency check for the Linux MINIX filesystem. The current version supports the 14 character and 30 character filename options. The program -assumes the file system is quiescent. +assumes the filesystem is quiescent. .B fsck.minix should not be used on a mounted device unless you can be sure nobody is writing to it (and remember that the kernel can write to it when it searches for files). -The device will usually have the following form: +The \fIdevice\fR name will usually have the following form: .nf .RS /dev/hda[1-63] (IDE disk 1) @@ -30,7 +30,7 @@ The device will usually have the following form: .RE .fi -If the file system was changed (i.e., repaired), then +If the filesystem was changed (i.e., repaired), then .B fsck.minix will print "FILE SYSTEM HAS CHANGED" and will .BR sync (2) @@ -53,30 +53,30 @@ writing to the disk, and that no files are "zombies" waiting for deletion. .SH OPTIONS .TP .B \-l -Lists all filenames +List all filenames. .TP .B \-r -Performs interactive repairs +Perform interactive repairs. .TP .B \-a -Performs automatic repairs (this option implies -.BR \-r ), -and serves to answer all of the questions asked with the default. Note -that this can be extremely dangerous in the case of extensive file system +Perform automatic repairs. (This option implies +.B \-r +and serves to answer all of the questions asked with the default.) Note +that this can be extremely dangerous in the case of extensive filesystem damage. .TP .B \-v -Verbose +Be verbose. .TP .B \-s -Outputs super-block information +Output super-block information. .TP .B \-m -Activates MINIX-like "mode not cleared" warnings +Activate MINIX-like "mode not cleared" warnings. .TP .B \-f -Force file system check even if the file system was marked as valid (this -marking is done by the kernel when the file system is unmounted). +Force a filesystem check even if the filesystem was marked as valid (this +marking is done by the kernel when the filesystem is unmounted). .SH "SEE ALSO" .BR fsck (8), .BR fsck.ext (8), @@ -95,7 +95,7 @@ most commonly seen in normal usage. If the device does not exist, .B fsck.minix will print "unable to read super block". If the device exists, but is not -a MINIX file system, +a MINIX filesystem, .B fsck.minix will print "bad magic number in super-block". .SH "EXIT CODES" @@ -105,10 +105,10 @@ is the sum of the following: .IP 0 No errors .IP 3 -File system errors corrected, system should be rebooted if file system was +Filesystem errors corrected, system should be rebooted if filesystem was mounted .IP 4 -File system errors left uncorrected +Filesystem errors left uncorrected .IP 8 Operational error .IP 16 @@ -120,7 +120,7 @@ Linus Torvalds (torvalds@xxxxxxxxxxxxxx) .br Error code values by Rik Faith (faith@xxxxxxxxxx) .br -Added support for file system valid flag: Dr. Wettstein +Added support for filesystem valid flag: Dr. Wettstein (greg%wind.uucp@xxxxxxxxxxxxxxxx) .br Check to prevent fsck of mounted filesystem added by Daniel Quinlan diff --git a/disk-utils/isosize.8 b/disk-utils/isosize.8 index 678fd80..6cbc1ff 100644 --- a/disk-utils/isosize.8 +++ b/disk-utils/isosize.8 @@ -3,7 +3,7 @@ isosize \- output the length of an iso9660 filesystem .SH SYNOPSIS .B isosize -[\fIoptions\fR] \fIiso9660_image_file\fR +.RI [ options ] " iso9660_image_file" .SH DESCRIPTION .\" Add any additional description here .PP @@ -14,19 +14,19 @@ any switches (and errors) it will output the size of the iso9660 filesystem in bytes. This can now be a large number (>> 4 GB). .SH OPTIONS .TP -\fB\-x\fR, \fB\-\-sectors\fR +.BR \-x , " \-\-sectors" Show the block count and block size in human-readable form. The output uses the term "sectors" for "blocks". .TP -\fB\-d\fR, \fB\-\-divisor\fR=\fINUM\fR +.BR \-d , " \-\-divisor " \fInumber\fR Only has an effect when .B \-x -is not given. The number shown (if no errors) +is not given. The value shown (if no errors) is the iso9660 file size in bytes divided by -.IR NUM . +.IR number . So if -.I NUM -is the block size then the shown number will be the block count. +.I number +is the block size then the shown value will be the block count. .PP The size of the file (or block device) holding an iso9660 filesystem can be marginally larger than the actual size of the diff --git a/disk-utils/mkfs.8 b/disk-utils/mkfs.8 index 02d8b06..af9304b 100644 --- a/disk-utils/mkfs.8 +++ b/disk-utils/mkfs.8 @@ -5,7 +5,9 @@ mkfs \- build a Linux filesystem .SH SYNOPSIS .SH SYNOPSIS .B mkfs -[\fIoptions\fR] [\fB-t\fR \fItype fs-options\fR] \fIdevice\fR [\fIsize\fR] +.RI [ options ] +.RB [ \-t +.IR "type fs-options" ] " device " [ size ] .SH DESCRIPTION .B mkfs is used to build a Linux filesystem on a device, usually @@ -28,7 +30,7 @@ is simply a front-end for the various filesystem builders (\fBmkfs.\fIfstype\fR) available under Linux. The filesystem-specific builder is searched for in a number -of directories like perhaps +of directories, like perhaps .IR /sbin , .IR /sbin/fs , .IR /sbin/fs.d , @@ -45,8 +47,8 @@ Please see the filesystem-specific builder manual pages for further details. .SH OPTIONS .TP -\fB\-t\fR, \fB\-\-type\fR=\fITYPE\fR -Specifies the type of filesystem to be built. +.BR \-t , " \-\-type " \fItype\fR +Specify the \fItype\fR of filesystem to be built. If not specified, the default filesystem type (currently ext2) is used. .TP @@ -55,19 +57,19 @@ Filesystem-specific options to be passed to the real filesystem builder. Although not guaranteed, the following options are supported by most filesystem builders. .TP -\fB\-V\fR, \fB\-\-verbose\fR +.BR \-V , " \-\-verbose" Produce verbose output, including all filesystem-specific commands that are executed. Specifying this option more than once inhibits execution of any filesystem-specific commands. This is really only useful for testing. .TP -\fB\-V\fR, \fB\-\-version\fR -Display version information and exit. Option \fB\-V\fR will display +.BR \-V , " \-\-version" +Display version information and exit. (Option \fB\-V\fR will display version information only when it is the only parameter, otherwise it -will work as \fB\-\-verbose\fR. +will work as \fB\-\-verbose\fR.) .TP -\fB\-h\fR, \fB\-\-help\fR +.BR \-h , " \-\-help" Display help and exit. .SH BUGS All generic options must precede and not be combined with @@ -77,7 +79,7 @@ Some filesystem-specific programs do not support the (verbose) option, nor return meaningful exit codes. Also, some filesystem-specific programs do not automatically detect the device size and require the -.I blocks +.I size parameter to be specified. .SH AUTHORS David Engel (david@xxxxxxx) diff --git a/disk-utils/mkfs.bfs.8 b/disk-utils/mkfs.bfs.8 index 466d640..c1794e5 100644 --- a/disk-utils/mkfs.bfs.8 +++ b/disk-utils/mkfs.bfs.8 @@ -5,44 +5,48 @@ mkfs.bfs \- make an SCO bfs filesystem .SH SYNOPSIS .B mkfs.bfs -[\fIoptions\fR] \fIdevice \fR[\fIblock-count\fR] +.RI [ options ] " device " [ block-count ] .SH DESCRIPTION .B mkfs.bfs -creates an SCO bfs file-system on a block device +creates an SCO bfs filesystem on a block device (usually a disk partition or a file accessed via the loop device). .PP The .I block-count -parameter is the desired size of the file system, in blocks. +parameter is the desired size of the filesystem, in blocks. If nothing is specified, the entire partition will be used. .SH OPTIONS .TP -\fB\-N\fR, \fB\-\-inodes\fR=\fINUM\fR -Specify the desired number of inodes (at most 512). -If nothing is specified some default number in the range 48-512 is picked +.BR \-N , " \-\-inodes " \fInumber\fR +Specify the desired \fInumber\fR of inodes (at most 512). +If nothing is specified, some default number in the range 48-512 is picked depending on the size of the partition. .TP -\fB\-V\fR, \fB\-\-vname\fR=\fINAME\fR -Specify the volume label. I have no idea if/where this is used. +.BR \-V , " \-\-vname " \fIlabel\fR +Specify the volume \fIlabel\fR. I have no idea if/where this is used. .TP -\fB\-F\fR, \fB\-\-fname\fR=\fINAME\fR -Specify the fsname. I have no idea if/where this is used. +.BR \-F , " \-\-fname " \fIname\fR +Specify the filesystem \fIname\fR. I have no idea if/where this is used. .TP -\fB\-v\fR, \fB\-\-verbose\fR +.BR \-v , " \-\-verbose" Explain what is being done. .TP -\fB\-c\fR +.B \-c This option is silently ignored. .TP -\fB\-l\fR +.B \-l This option is silently ignored. .TP -\fB\-V\fR, \fB\-\-version\fR -Output version information and exit. -\fB\-V\fR works only when specified as an only option. +.BR \-h , " \-\-help" +Display help text and exit. .TP -\fB\-h\fR, \fB\-\-help\fR -Display help and exit. +.BR \-V , " \-\-version" +Output version information and exit. +Option +.B \-V +only works as +.B \-\-version +when it is the only option. .SH "EXIT CODES" The exit code returned by .B mkfs.bfs diff --git a/disk-utils/mkfs.minix.8 b/disk-utils/mkfs.minix.8 index 4ee0e81..a65a711 100644 --- a/disk-utils/mkfs.minix.8 +++ b/disk-utils/mkfs.minix.8 @@ -16,7 +16,7 @@ mkfs.minix \- make a Minix filesystem .RI [ size-in-blocks ] .SH DESCRIPTION .B mkfs.minix -creates a Linux MINIX file-system on a device (usually a disk partition). +creates a Linux MINIX filesystem on a device (usually a disk partition). The .I device @@ -41,28 +41,28 @@ Only block counts strictly greater than 10 and strictly less than .SH OPTIONS .TP .B \-c -Check the device for bad blocks before creating the file system. If any +Check the device for bad blocks before creating the filesystem. If any are found, the count is printed. .TP .BI \-n " namelength" Specify the maximum length of filenames. Currently, the only allowable values are 14 and 30. -The default is 30. Note that kernels older than 0.99p7 +The default is 30. Note that kernels older than 0.99p7 only accept namelength 14. .TP .BI \-i " inodecount" Specify the number of inodes for the filesystem. .TP .BI \-l " filename" -Read the bad blocks list from +Read the list of bad blocks from .IR filename . -The file has one bad block number per line. The count of bad blocks read +The file has one bad-block number per line. The count of bad blocks read is printed. .TP .B \-1 Make a Minix version 1 filesystem. .TP -.B \-2,\-v +.BR \-2 , " \-v" Make a Minix version 2 filesystem. .TP .B \-3 diff --git a/disk-utils/mkswap.8 b/disk-utils/mkswap.8 index 59a93dc..c653171 100644 --- a/disk-utils/mkswap.8 +++ b/disk-utils/mkswap.8 @@ -8,9 +8,9 @@ mkswap \- set up a Linux swap area .SH SYNOPSIS .B mkswap -.RB [ options ] -.IR device -.RB [ size ] +.RI [ options ] +.I device +.RI [ size ] .SH DESCRIPTION .B mkswap sets up a Linux swap area on a device or in a file. @@ -47,54 +47,59 @@ The swap header does not touch the first block. A boot loader or disk label can be there, but it is not a recommended setup. The recommended setup is to use a separate partition for a Linux swap area. -.B mkswap, like many others mkfs-like utils, erases the first block to remove -.B old on-disk filesystems. +.BR mkswap , +like many others mkfs-like utils, +.B erases the first partition block to make any previous filesystem invisible. +However, .B mkswap refuses to erase the first block on a device with a disk -label (SUN, BSD, ...) or on a whole disk (e.g. /dev/sda). +label (SUN, BSD, ...) and on a whole disk (e.g. /dev/sda). .SH OPTIONS .TP .BR \-c , " \-\-check" Check the device (if it is a block device) for bad blocks before creating the swap area. -If any are found, the count is printed. +If any bad blocks are found, the count is printed. .TP .BR \-f , " \-\-force" -Force -- go ahead even if the command is stupid. +Go ahead even if the command is stupid. This allows the creation of a swap area larger than the file or partition it resides on. -Without this option, +Also, without this option, .B mkswap -will refuse to erase the first block on a device with a partition table or on +will refuse to erase the first block on a device with a partition table and on a whole disk (e.g. /dev/sda). .TP -.BR \-L , " \-\-label" \ device-label -Specify a label, to allow +.BR \-L , " \-\-label " \fIlabel\fR +Specify a \fIlabel\fR for the device, to allow .B swapon by label. .TP -.BR \-p , " \-\-pagesize" \ SIZE -Specify the page size (in bytes) to use. This option is usually unnecessary, +.BR \-p , " \-\-pagesize " \fIsize\fR +Specify the page \fIsize\fR (in bytes) to use. This option is usually unnecessary; .B mkswap reads the size from the kernel. .TP -.BR \-U , " \-\-uuid" \ UUID -Specify the uuid to use. The default is to generate a UUID. +.BR \-U , " \-\-uuid " \fIUUID\fR +Specify the \fIUUID\fR to use. The default is to generate a UUID. .TP -.BR \-v , " \-\-swapversion" \ 1 -Specify the swap-space version. The old \-v 0 option has become obsolete -and now only \-v 1 is supported. - -The kernel has not supported v0 swap-space format since 2.5.22 (Jun 2002). -The new version v1 is supported since 2.1.117 (Aug 1998). +.BR \-v , " \-\-swapversion 1" +Specify the swap-space version. (This option is currently pointless, as the old +.B \-v 0 +option has become obsolete and now only +.B \-v 1 +is supported. +The kernel has not supported v0 swap-space format since 2.5.22 (June 2002). +The new version v1 is supported since 2.1.117 (August 1998).) .TP -.BR \-V , " \-\-version" -Output version information and exit. .BR \-h , " \-\-help" -Output help screen and exit. +Display help text and exit. +.TP +.BR \-V , " \-\-version" +Display version information and exit. .SH NOTES The maximum useful size of a swap area depends on the architecture and diff --git a/disk-utils/raw.8 b/disk-utils/raw.8 index b85080a..0e47843 100644 --- a/disk-utils/raw.8 +++ b/disk-utils/raw.8 @@ -9,12 +9,10 @@ raw \- bind a Linux raw character device .B raw .I /dev/raw/raw<N> /dev/<blockdev> .PP -.B raw -.B \-q +.B raw \-q .I /dev/raw/raw<N> .PP -.B raw -.B \-qa +.B raw \-qa .SH DESCRIPTION .B raw is used to bind a Linux raw character device to a block device. Any @@ -38,7 +36,7 @@ to an existing block device file. .PP The bindings already in existence can be queried with the .I \-q -option, with is used either with a raw device filename to query that one +option, which is used either with a raw device filename to query that one device, or with the .I \-a option to query all bound raw devices. @@ -70,16 +68,16 @@ will query an existing binding instead of setting a new one. .B -a With .B -q -, specifies that all bound raw devices should be queried. +, specify that all bound raw devices should be queried. .TP .B -h -provides a usage summary. +Provide a usage summary. .SH BUGS The Linux -.B dd -(1) command should be used without bs= option or the blocksize needs to be a -multiple of the sector size of the device (512 bytes usually) otherwise it -will fail with "Invalid Argument" messages (EINVAL). +.BR dd (1) +command should be used without the \fBbs=\fR option, or the blocksize +needs to be a multiple of the sector size of the device (512 bytes usually), +otherwise it will fail with "Invalid Argument" messages (EINVAL). .PP Raw I/O devices do not maintain cache coherency with the Linux block diff --git a/disk-utils/swaplabel.8 b/disk-utils/swaplabel.8 index 327a65f..0d47456 100644 --- a/disk-utils/swaplabel.8 +++ b/disk-utils/swaplabel.8 @@ -22,35 +22,36 @@ If the optional arguments .B \-L and .B \-U -are not present, +are not given, .B swaplabel -will simply display the swap area label and UUID of +will simply display the current swap-area label and UUID of .IR device . .PP If an optional argument is present, then .B swaplabel -will change the appropriate value of +will change the appropriate value on .IR device . These values can also be set during swap creation using .BR mkswap (8). The .B swaplabel -utility allows to change the label or UUID on actively used swap device. +utility allows to change the label or UUID on an actively used swap device. .SH OPTIONS -.IP "\fB\-h, \-\-help\fP" -Print help and exit. -.IP "\fB\-L, \-\-label\fP \fIlabel\fP" -Specify a new label for -.IR device . +.TP +.BR \-h , " \-\-help" +Display help text and exit. +.TP +.BR \-L , " \-\-label " \fIlabel\fR +Specify a new \fIlabel\fR for the device. Swap partition labels can be at most 16 characters long. If -.IR label +.I label is longer than 16 characters, -.B swapinfo +.B swaplabel will truncate it and print a warning message. -.IP "\fB\-U, \-\-uuid\fP \fIuuid\fP" -Specify a new UUID for -.IR device . -.IR UUID +.TP +.BR \-U , " \-\-uuid " \fIUUID\fR +Specify a new \fIUUID\fR for the device. +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 @@ -58,8 +59,8 @@ must be in the standard 8-4-4-4-12 character format, such as is output by .B swaplabel was written by Jason Borden <jborden@xxxxxxxxxxxx> and Karel Zak <kzak@xxxxxxxxxx>. .SH AVAILABILITY -.B swaplabel -is part of the util-linux package and is available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +The swaplabel command is part of the util-linux package and is available from +ftp://ftp.kernel.org/pub/linux/utils/util-linux/. .SH SEE ALSO .BR mkswap (8), .BR swapon (8), diff --git a/misc-utils/rename.1 b/misc-utils/rename.1 index 0cfe381..5f86b23 100644 --- a/misc-utils/rename.1 +++ b/misc-utils/rename.1 @@ -6,7 +6,7 @@ rename \- rename files .SH SYNOPSIS .B rename -[\fIoptions\fR] \fIexpression replacement file\fR... +.RI [ options ] " expression replacement file" ... .SH DESCRIPTION .B rename will rename the specified files by replacing the first occurrence of @@ -22,7 +22,7 @@ Give visual feedback which files where renamed, if any. Display version information and exit. .TP \fB\-h\fR, \fB\-\-help\fR -Display help screen and exit. +Display help text and exit. .SH EXAMPLES Given the files .IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 , @@ -47,10 +47,10 @@ rename .htm .html *.htm .RE will fix the extension of your html files. .SH WARNING -The rename has no safeguards. If user has permission to rewrite file names -the command will perform the action without any questions. For example -result can be quite drastic when the command is ran as root in /lib -directory. Make always a backup before running the command, unless you truly +The renaming has no safeguards. If the user has permission to rewrite file names, +the command will perform the action without any questions. For example, the +result can be quite drastic when the command is run as root in the /lib +directory. Always make a backup before running the command, unless you truly know what you are doing. .SH "SEE ALSO" .BR mmv (1), diff --git a/misc-utils/uuidgen.1 b/misc-utils/uuidgen.1 index 6349b3a..ad409b9 100644 --- a/misc-utils/uuidgen.1 +++ b/misc-utils/uuidgen.1 @@ -24,12 +24,11 @@ and in the future. .PP There are two types of UUIDs which .B uuidgen -can generate: time-based UUIDs and random-based UUIDs. By -default +can generate: time-based UUIDs and random-based UUIDs. By default .B uuidgen will generate a random-based UUID if a high-quality random number -generator is present. Otherwise, it will chose a time-based UUID. It -is possible to force the generation of one of these two +generator is present. Otherwise, it will choose a time-based UUID. +It is possible to force the generation of one of these two UUID types by using the .B \-r or @@ -37,21 +36,21 @@ or options. .SH OPTIONS .TP -\fB\-r\fR, \fB\-\-random\fR +.BR \-r , " \-\-random" Generate a random-based UUID. This method creates a UUID consisting mostly of random bits. It requires that the operating system have a high quality random number generator, such as .IR /dev/random . .TP -\fB\-t\fR, \fB\-\-time\fR +.BR \-t , " \-\-time" Generate a time-based UUID. This method creates a UUID based on the system clock plus the system's ethernet hardware address, if present. .TP -\fB\-V\fR, \fB\-\-version\fR -Output version information and exit. +.BR \-h , " \-\-help" +Display help text and exit. .TP -\fB\-h\fR, \fB\-\-help\fR -Output help screen and exit. +.BR \-V , " \-\-version" +Display version information and exit. .SH "CONFORMING TO" OSF DCE 1.1 .SH AUTHOR -- 1.7.0.4
