Hi,
Attached first patch corrects "fistt" to "first" in the help text of cal,
and seizes the opportunity to clarify the text and add uppercase where
needed. The second patch corrects the short option for --timeout (from
-t to -w) in the man page of findmnt, and then fixes some markup and
spacing issues.
Most utilities use -V as the short option for --version, only a few
use -v instead; several use -v for --verbose. The third patch makes
wipefs conform to the majority now that the option is still fresh, and
adds it to the man page.
The other five patches correct typos, grammar, markup and spacing
in five other man pages.
Regards,
Benno
--
http://www.fastmail.fm - mmm... Fastmail...
From b3aabeff75e4185ebeaefdf832bf86acb69ef58d Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 1 Aug 2011 20:41:12 +0200
Subject: [PATCH 1/8] cal.c: fix typo ("fistt day") in help text, seize chance to improve it
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/cal.c | 16 ++++++++--------
1 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/misc-utils/cal.c b/misc-utils/cal.c
index f46ef14..39999ce 100644
--- a/misc-utils/cal.c
+++ b/misc-utils/cal.c
@@ -787,14 +787,14 @@ static void __attribute__ ((__noreturn__)) usage(FILE * out)
program_invocation_short_name);
fprintf(out, _("\nOptions:\n"
- " -1, --one single month\n"
- " -3, --three previous, current and next month\n"
- " -s, --sunday sunday as first day\n"
- " -m, --monday monday as fistt day\n"
- " -j, --julian julian dates\n"
- " -y, --year current year\n"
- " -V, --version output version information and exit\n"
- " -h, --help display this help and exit\n\n"));
+ " -1, --one show only current month (default)\n"
+ " -3, --three show previous, current and next month\n"
+ " -s, --sunday Sunday as first day of week\n"
+ " -m, --monday Monday as first day of week\n"
+ " -j, --julian output Julian dates\n"
+ " -y, --year show whole current year\n"
+ " -V, --version display version information and exit\n"
+ " -h, --help display this help text and exit\n\n"));
exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
}
--
1.7.0.4
From e987f5e7ca22c7b368ce2486e2dc770af3ec0daa Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 1 Aug 2011 21:31:35 +0200
Subject: [PATCH 2/8] findmnt: (man page) short option for --timeout is not -t but -w
Additionally make some formatting and spacing tweaks.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/findmnt.8 | 28 ++++++++++++++--------------
1 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/misc-utils/findmnt.8 b/misc-utils/findmnt.8
index 4f47d09..27d85c6 100644
--- a/misc-utils/findmnt.8
+++ b/misc-utils/findmnt.8
@@ -80,7 +80,7 @@ and
.BR LABEL
columns. This option disables text truncation also in all other columns.
.IP "\fB\-O, \-\-options \fIlist\fP"
-Used to limit the set of printed filesystems. More than one option
+Limit the set of printed filesystems. More than one option
may be specified in a comma-separated list. The
.B \-t
and
@@ -97,10 +97,10 @@ Define output columns. Currently supported are
.BR ACTION,
.BR SOURCE ,
.BR TARGET ,
-.RB OLD-TARGET,
+.BR OLD-TARGET,
.BR FSTYPE ,
.BR OPTIONS ,
-.RB OLD-OPTIONS,
+.BR OLD-OPTIONS,
.BR VFS-OPTIONS ,
.BR FS-OPTIONS ,
.BR LABEL
@@ -113,12 +113,12 @@ column contains tree formatting if the
or
.B \-\-raw
options are not specified.
-.IP "\fB\-p, \-\-poll[=list]\fP"
+.IP "\fB\-p, \-\-poll\fR[\fI=list\fR]\fP"
Monitor changes in the /proc/self/mountinfo file. Supported actions are: mount,
umount, remount and move. More than one action may be specified in a
comma-separated list. All actions are monitored by default.
-The time for which --poll will block could be restricted by \fB\-\-timeout\fP
+The time for which \fB--poll\fR will block can be restricted with the \fB\-\-timeout\fP
or \fB\-\-first-only\fP options.
The standard columns always use the new version of the information from the
@@ -129,7 +129,7 @@ The poll mode allows to use extra columns:
.RS
.TP
.B ACTION
-mount, umount, move or remount action name. This column is enabled by default.
+mount, umount, move or remount action name; this column is enabled by default
.TP
.B OLD-TARGET
available for umount and move actions
@@ -142,7 +142,7 @@ Use raw output format.
.IP "\fB\-a, \-\-ascii\fP"
Use ascii characters for tree formatting.
.IP "\fB\-t, \-\-types \fIlist\fP"
-Used to limit the set of printed filesystems. More than one type may be
+Limit the set of printed filesystems. More than one type may be
specified in a comma-separated list. The list of filesystem types can be
prefixed with
.I no
@@ -150,17 +150,17 @@ to specify the filesystem types on which no action should be taken. For
more details see
.BR mount (8).
.IP "\fB\-R, \-\-submounts\fP"
-Print recursively all submounts for the selected filesystems. The restrictions
+Print recursively all submounts for the selected filesystems. The restrictions
defined by options \fB\-t\fP, \fB\-O\fP, \fB\-S\fP, \fB\-T\fP and
-\fB\--direction\fP are not applied to submounts. All submounts are always
-printed in tree-like order. The option enables the tree-like output format by
-default. This option has no effect for \fB\-\-mtab\fP or \fB\-\-fstab\fP.
+\fB\--direction\fP are not applied to submounts. All submounts are always
+printed in tree-like order. The option enables the tree-like output format by
+default. This option has no effect for \fB\-\-mtab\fP or \fB\-\-fstab\fP.
.IP "\fB\-S, \-\-source \fIspec\fP"
-Explicitly define the mount source. Supported are device, LABEL= or UUID=.
-.IP "\fB\-t, \-\-timeout \fImilliseconds\fP"
-Specifies an upper limit on the time for which --poll will block, in milliseconds.
+Explicitly define the mount source. Supported are \fIdevice\fR, \fILABEL=\fR and \fIUUID=\fR.
.IP "\fB\-T, \-\-target \fIdir\fP"
Explicitly define the mount target (mountpoint directory).
+.IP "\fB\-w, \-\-timeout \fImilliseconds\fP"
+Specify an upper limit on the time for which \fB--poll\fR will block, in milliseconds.
.SH EXAMPLES
.IP "\fBfindmnt \-\-fstab \-t nfs\fP"
Prints all nfs filesystems defined in
--
1.7.0.4
From 1b6b702166bbf65c442a80de3c1d2f9432f29595 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 10:23:08 +0200
Subject: [PATCH 3/8] wipefs: change option -v to -V for --version; add it to man page
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/wipefs.8 | 6 ++++--
misc-utils/wipefs.c | 8 ++++----
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/misc-utils/wipefs.8 b/misc-utils/wipefs.8
index ebb64bd..00a406d 100644
--- a/misc-utils/wipefs.8
+++ b/misc-utils/wipefs.8
@@ -7,7 +7,7 @@
wipefs \- wipe a filesystem signature from a device
.SH SYNOPSIS
.B wipefs
-.RB [ \-ahnp ]
+.RB [ \-ahnpV ]
.RB [ \-o
.IR offset ]
.I device
@@ -36,8 +36,10 @@ 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
"KiB") or decimal (10^N) suffixes KB, MB, GB, PB and EB.
.IP "\fB\-p, \-\-parsable\fP"
-Print out in parsable instead of printable format. Encode all potentially unsafe
+Print out in parsable instead of printable format. Encode all potentially unsafe
characters of a string to the corresponding hex value prefixed by '\\x'.
+.IP "\fB\-V, \-\-version\fP"
+Output version information and exit.
.SH AUTHOR
Karel Zak <kzak@xxxxxxxxxx>.
.SH AVAILABILITY
diff --git a/misc-utils/wipefs.c b/misc-utils/wipefs.c
index 51b6fad..0ebb427 100644
--- a/misc-utils/wipefs.c
+++ b/misc-utils/wipefs.c
@@ -308,7 +308,7 @@ usage(FILE *out)
" -n, --no-act do everything except the actual write() call\n"
" -o, --offset <num> offset to erase, in bytes\n"
" -p, --parsable print out in parsable instead of printable format\n"
- " -v, --version output version information and exit\n"));
+ " -V, --version output version information and exit\n"));
fprintf(out, _("\nFor more information see wipefs(8).\n"));
@@ -329,7 +329,7 @@ main(int argc, char **argv)
{ "no-act", 0, 0, 'n' },
{ "offset", 1, 0, 'o' },
{ "parsable", 0, 0, 'p' },
- { "version", 0, 0, 'v' },
+ { "version", 0, 0, 'V' },
{ NULL, 0, 0, 0 }
};
@@ -337,7 +337,7 @@ main(int argc, char **argv)
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
- while ((c = getopt_long(argc, argv, "ahno:pv", longopts, NULL)) != -1) {
+ while ((c = getopt_long(argc, argv, "ahno:pV", longopts, NULL)) != -1) {
switch(c) {
case 'a':
all++;
@@ -355,7 +355,7 @@ main(int argc, char **argv)
case 'p':
mode = WP_MODE_PARSABLE;
break;
- case 'v':
+ case 'V':
printf(_("%s from %s\n"), program_invocation_short_name,
PACKAGE_STRING);
return EXIT_SUCCESS;
--
1.7.0.4
From 995720e730cf2152fcba3d23aab61b55a70019f3 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 11:17:11 +0200
Subject: [PATCH 4/8] chrt: adjust style of man page, alphabetize option -p
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
schedutils/chrt.1 | 60 ++++++++++++++++++++++++++++------------------------
1 files changed, 32 insertions(+), 28 deletions(-)
diff --git a/schedutils/chrt.1 b/schedutils/chrt.1
index 79750c7..e7f2c3e 100644
--- a/schedutils/chrt.1
+++ b/schedutils/chrt.1
@@ -39,9 +39,9 @@ chrt \- manipulate real-time attributes of a process
.RI [ prio ]\ pid
.SH DESCRIPTION
.PP
-.BR chrt (1)
-sets or retrieves the real-time scheduling attributes of an existing PID, or
-runs COMMAND with the given attributes. Both policy (one of
+.BR chrt
+sets or retrieves the real-time scheduling attributes of an existing \fIpid\fR,
+or runs \fIcommand\fR with the given attributes. Both policy (one of
.BR SCHED_OTHER ,
.BR SCHED_FIFO ,
.BR SCHED_RR ,
@@ -52,7 +52,7 @@ and priority can be set and retrieved.
.PP
The
.BR SCHED_BATCH
-policy is supported since Linux 2.6.16. The
+policy is supported since Linux 2.6.16. The
.BR SCHED_IDLE
policy is supported since Linux 2.6.23.
.PP
@@ -62,66 +62,70 @@ flag for policies SCHED_RR and SCHED_FIFO is supported
since Linux 2.6.31.
.SH OPTIONS
.TP
-.B -p, --pid
-operate on an existing PID and do not launch a new task
-.TP
.B -a, --all-tasks
-set or retrieve the scheduling attributes of all the tasks (threads) for a
+Set or retrieve the scheduling attributes of all the tasks (threads) for a
given PID.
.TP
.B -b, --batch
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_BATCH
-(Linux specific)
+(Linux specific).
.TP
.B -f, --fifo
-set scheduling policy to
-.BR SCHED_FIFO
+Set scheduling policy to
+.BR SCHED_FIFO .
.TP
.B -i, --idle
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_IDLE
-(Linux specific)
+(Linux specific).
.TP
.B -m, --max
-show minimum and maximum valid priorities, then exit
+Show minimum and maximum valid priorities, then exit.
.TP
.B -o, --other
-set policy scheduling policy to
-.BR SCHED_OTHER
+Set policy scheduling policy to
+.BR SCHED_OTHER .
+.TP
+.B -p, --pid
+Operate on an existing PID and do not launch a new task.
.TP
.B -r, --rr
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_RR
-(the default)
+(the default).
.TP
.B -R, --reset-on-fork
-add
+Add
.B SCHED_RESET_ON_FORK
flag to the
.B SCHED_FIFO
or
.B SCHED_RR
-scheduling policy (Linux specific)
+scheduling policy (Linux specific).
.TP
.B -v, --verbose
-show status information
+Show status information.
.TP
.B -h, --help
-display usage information and exit
+Display usage information and exit.
.TP
.B -V, --version
-display version information and exit
+Display version information and exit.
.SH USAGE
.TP
-The default behavior is to run a new command::
-chrt prio command [arguments]
+The default behavior is to run a new command:
+.B chrt
+.I prio
+.IR command\ [ arguments ]
.TP
You can also retrieve the real-time attributes of an existing task:
-chrt -p pid
+.B chrt \-p
+.I pid
.TP
Or set them:
-chrt -p prio pid
+.B chrt \-p
+.I prio pid
.SH PERMISSIONS
A user must possess
.BR CAP_SYS_NICE
--
1.7.0.4
From ca505a8c745763c7d354536842c7fc7d68038ce8 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 11:17:47 +0200
Subject: [PATCH 5/8] taskset: adjust style of man page
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
schedutils/taskset.1 | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/schedutils/taskset.1 b/schedutils/taskset.1
index 4aa5e2c..9300fb3 100644
--- a/schedutils/taskset.1
+++ b/schedutils/taskset.1
@@ -64,7 +64,7 @@ is processor #0
is processors #0 and #1
.TP
.BR 0xFFFFFFFF
-is all processors (#0 through #31)
+is all processors (#0 through #31).
.PP
When
.BR taskset
@@ -73,21 +73,21 @@ CPU.
.SH OPTIONS
.TP
.BR \-a ,\ \-\-all-tasks
-set or retrieve the CPU affinity of all the tasks (threads) for a given PID.
+Set or retrieve the CPU affinity of all the tasks (threads) for a given PID.
.TP
.BR \-p ,\ \-\-pid
-operate on an existing PID and not launch a new task
+Operate on an existing PID and do not launch a new task.
.TP
.BR \-c ,\ \-\-cpu-list
-specify a numerical list of processors instead of a bitmask. The list may
-contain multiple items, separated by comma, and ranges. For example,
+Specify a numerical list of processors instead of a bitmask. The numbers
+are separated by commas and may include ranges. For example:
.BR 0,5,7,9-11 .
.TP
.BR \-h ,\ \-\-help
-display usage information and exit
+Display usage information and exit.
.TP
.BR \-V ,\ \-\-version
-output version information and exit
+Display version information and exit.
.SH USAGE
.TP
The default behavior is to run a new command with a given affinity mask:
--
1.7.0.4
From bcfd9f9899d4e9537287a2e7834d15a357bc08a0 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 15:35:23 +0200
Subject: [PATCH 6/8] ionice: slightly improve grammar, spacing and consistency of man page
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
schedutils/ionice.1 | 72 ++++++++++++++++++++++++--------------------------
1 files changed, 35 insertions(+), 37 deletions(-)
diff --git a/schedutils/ionice.1 b/schedutils/ionice.1
index f221953..c6f0b47 100644
--- a/schedutils/ionice.1
+++ b/schedutils/ionice.1
@@ -21,78 +21,76 @@ PID
.IR COMMAND
[ ARG ]...
.SH DESCRIPTION
-This program sets or gets the io scheduling class and priority for a program.
+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
-io scheduling class and priority for that process.
+I/O scheduling class and priority for that process.
-If no class is given than
+If no class is given, then
.I COMMAND
-will be executed with "best-effort" scheduling class. The default
+will be executed with the "best-effort" scheduling class. The default
priority argument is 4.
As of this writing, a process can be in one of three scheduling classes:
.IP "\fBIdle\fP"
-A program running with idle io priority will only get disk time when no other
-program has asked for disk io for a defined grace period. The impact of idle
-io processes on normal system activity should be zero. This scheduling
-class does not take a priority argument. Presently, this scheduling class
+A program running with idle I/O priority will only get disk time when no other
+program has asked for disk I/O for a defined grace period. The impact of an
+idle I/O process on normal system activity should be zero. This scheduling
+class does not take a priority argument. Presently, this scheduling class
is permitted for an ordinary user (since kernel 2.6.25).
.IP "\fBBest-effort\fP"
This is the effective scheduling class for any process that has not asked for
-a specific io priority.
-This class takes a priority argument from \fI0-7\fR, with lower
-number being higher priority. Programs running at the same best effort
+a specific I/O priority.
+This class takes a priority argument from \fI0-7\fR, with a lower
+number being higher priority. Programs running at the same best-effort
priority are served in a round-robin fashion.
-Note that before kernel 2.6.26 a process that has not asked for an io priority
-formally uses "\fBnone\fP" as scheduling class, but the io scheduler will treat
-such processes as if it were in the best effort class. The priority within the
-best effort class will be dynamically derived from the cpu nice level of the
+Note that before kernel 2.6.26 a process that has not asked for an I/O priority
+formally uses "\fBnone\fP" as scheduling class, but the I/O scheduler will treat
+such processes as if it were in the best-effort class. The priority within the
+best-effort class will be dynamically derived from the CPU nice level of the
process: io_priority = (cpu_nice + 20) / 5.
-For kernels after 2.6.26 with CFQ io scheduler a process that has not asked for
-an io priority inherits CPU scheduling class. The io priority is derived from
-the cpu nice level of the process (same as before kernel 2.6.26).
+For kernels after 2.6.26 with the CFQ I/O scheduler, a process that has not asked
+for an I/O priority inherits its CPU scheduling class. The I/O priority is derived
+from the CPU nice level of the process (same as before kernel 2.6.26).
.IP "\fBRealtime\fP"
The RT scheduling class is given first access to the disk, regardless of
-what else is going on in the system. Thus the RT class needs to be used with
-some care, as it can starve other processes. As with the best effort class,
+what else is going on in the system. Thus the RT class needs to be used with
+some care, as it can starve other processes. As with the best-effort class,
8 priority levels are defined denoting how big a time slice a given process
-will receive on each scheduling window. This scheduling class is not
+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
+The scheduling class name or number; \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 real time and best-effort, \fI0-7\fR is valid
-data.
+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.
.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.
+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.
.TP
\fB\-t\fR, \fB\-\-ignore\fR
-Ignore failure to set requested priority. If COMMAND or PID(s) is specified, run it
-even in case it was not possible to set desired scheduling priority, what
-can happen due to insufficient privileges or old kernel version.
-.TP
-\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+Ignore failure to set the requested priority. If COMMAND or PID(s) is 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
Display help and exit.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display version information and exit.
.SH EXAMPLES
.LP
.TP 7
# \fBionice\fP -c 3 -p 89
.TP 7
-Sets process with PID 89 as an idle io process.
+Sets process with PID 89 as an idle I/O process.
.TP 7
# \fBionice\fP -c 2 -n 0 bash
.TP 7
@@ -102,8 +100,8 @@ Runs 'bash' as a best-effort program with highest priority.
.TP 7
Prints the class and priority of the processes with PID 89 and 91.
.SH NOTES
-Linux supports io scheduling priorities and classes since 2.6.13 with the CFQ
-io scheduler.
+Linux supports I/O scheduling priorities and classes since 2.6.13 with the CFQ
+I/O scheduler.
.SH AUTHORS
.nf
Jens Axboe <jens@xxxxxxxx>
--
1.7.0.4
From 0af45fcdb972c2f77052e6109f9316961a0f867e Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 15:51:02 +0200
Subject: [PATCH 7/8] isosize: improve style, grammar and spacing of man page
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
disk-utils/isosize.8 | 28 ++++++++++++++--------------
1 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/disk-utils/isosize.8 b/disk-utils/isosize.8
index 160f8eb..1951f02 100644
--- a/disk-utils/isosize.8
+++ b/disk-utils/isosize.8
@@ -1,6 +1,6 @@
.TH ISOSIZE "8" "June 2011" "util-linux" "System Administration Utilities"
.SH NAME
-isosize \- outputs the length of an iso9660 file system
+isosize \- outputs the length of an iso9660 filesystem
.SH SYNOPSIS
.B isosize
[\fIoptions\fR] \fIiso9660_image_file\fR
@@ -8,28 +8,28 @@ isosize \- outputs the length of an iso9660 file system
.\" Add any additional description here
.PP
This command outputs the length of an iso9660 file system that
-is contained in given file. That file may be a normal file or
-a block device (e.g. /dev/hdd or /dev/sr0). In the absence of
-any switches (or errors) it will output the size of the iso9660
-file system in bytes. This can now be a large number (>> 4 GB).
+is contained in the given file. That file may be a normal file or
+a block device (e.g. /dev/hdd or /dev/sr0). In the absence of
+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
-output in humanly readable form the block count and the block
-size. Output uses the term "sectors" for "blocks".
+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
-only has affect when
+Only has an effect when
.B \-x
-is not given. The number output (if no errors)
+is not given. The number shown (if no errors)
is the iso9660 file size in bytes divided by
.IR NUM .
So if
.I NUM
-is the block size then the output number will be the block count.
+is the block size then the shown number will be the block count.
.PP
-The size of the file (or block device) holding a iso9660 file
-system can be marginally larger than the actual size of the
-iso9660 file system. One reason for this is that cd writers
-are allowed to add "run out" sectors at the end of a iso9660
+The size of the file (or block device) holding an iso9660
+filesystem can be marginally larger than the actual size of the
+iso9660 filesystem. One reason for this is that cd writers
+are allowed to add "run out" sectors at the end of an iso9660
image.
--
1.7.0.4
From 7ea4920faebb7e58ee43f268dc9e9d969ec0dc3c Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Wed, 3 Aug 2011 16:10:13 +0200
Subject: [PATCH 8/8] mkfs: fix small formatting issues in man page
Also spell "filesystem" consistently as one word -- this makes
things clearer when the word is used as an adjective.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
disk-utils/mkfs.8 | 53 +++++++++++++++++++++++++----------------------------
1 files changed, 25 insertions(+), 28 deletions(-)
diff --git a/disk-utils/mkfs.8 b/disk-utils/mkfs.8
index 88699c1..09cc924 100644
--- a/disk-utils/mkfs.8
+++ b/disk-utils/mkfs.8
@@ -1,24 +1,22 @@
.\" -*- nroff -*-
-.TH MKFS 8 "Jun 1995" "Version 1.9"
.TH MKFS "8" "June 2011" "util-linux" "System Administration Utilities"
.SH NAME
-mkfs \- build a Linux file system
+mkfs \- build a Linux filesystem
.SH SYNOPSIS
.SH SYNOPSIS
.B mkfs
-[\fIoptions\fR] [\fI-t type fs-options\fR] \fIdevice \fR[\fIsize\fR]
+[\fIoptions\fR] [\fB-t\fR \fItype fs-options\fR] \fIdevice\fR [\fIsize\fR]
.SH DESCRIPTION
.B mkfs
-is used to build a Linux file system on a device, usually
-a hard disk partition.
-.I filesys
-is either the device name (e.g.
+is used to build a Linux filesystem on a device, usually
+a hard disk partition. The
+.I device
+argument is either the device name (e.g.
.IR /dev/hda1 ,
.IR /dev/sdb2 ),
-or a regular file that shall contain the file system.
-The
+or a regular file that shall contain the filesystem. The
.I size
-argument is the number of blocks to be used for the file system.
+argument is the number of blocks to be used for the filesystem.
.PP
The exit code returned by
.B mkfs
@@ -26,10 +24,10 @@ is 0 on success and 1 on failure.
.PP
In actuality,
.B mkfs
-is simply a front-end for the various file system builders
+is simply a front-end for the various filesystem builders
(\fBmkfs.\fIfstype\fR)
available under Linux.
-The file system-specific builder is searched for in a number
+The filesystem-specific builder is searched for in a number
of directories like perhaps
.IR /sbin ,
.IR /sbin/fs ,
@@ -43,42 +41,41 @@ and
.IR /sbin/fs ),
and finally in the directories
listed in the PATH environment variable.
-Please see the file system-specific builder manual pages for
+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 file system to be built.
-If not specified, the default file system type
+Specifies the type of filesystem to be built.
+If not specified, the default filesystem type
(currently ext2) is used.
.TP
.I fs-options
-File system-specific options to be passed to the real file
-system builder.
+Filesystem-specific options to be passed to the real filesystem builder.
Although not guaranteed, the following options are supported
-by most file system builders.
+by most filesystem builders.
.TP
\fB\-V\fR, \fB\-\-verbose\fR
-Produce verbose output, including all file system-specific commands
+Produce verbose output, including all filesystem-specific commands
that are executed.
Specifying this option more than once inhibits execution of any
-file system-specific commands.
+filesystem-specific commands.
This is really only useful for testing.
.TP
\fB\-V\fR, \fB\-\-version\fR
-output version information and exit
-\fB\-V\fR will output version information only when it is the
-only parameter.
+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.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help and exit.
.SH BUGS
All generic options must precede and not be combined with
-file system-specific options.
-Some file system-specific programs do not support the
-.I -V
+filesystem-specific options.
+Some filesystem-specific programs do not support the
+.B -V
(verbose) option, nor return meaningful exit codes.
-Also, some file system-specific programs do not automatically
+Also, some filesystem-specific programs do not automatically
detect the device size and require the
.I blocks
parameter to be specified.
@@ -90,7 +87,7 @@ Fred N. van Kempen (waltje@xxxxxxxxxxxxxxxxxxx)
Ron Sommeling (sommel@xxxxxxxxxx)
.br
The manual page was shamelessly adapted from Remy Card's version
-for the ext2 file system.
+for the ext2 filesystem.
.SH SEE ALSO
.BR fs (5),
.BR badblocks (8),
--
1.7.0.4
