Are you interested in reviewing patches to man pages that clean up their
troff formatting? As part of a pet project of converting troff to clean
HTML, I identify errors in man pages' troff formatting -- either actual
errors or deviations from conventional man troff markup. It's stuff like
mismatched or unbalanced .RS/.RE pairs, .nf and .fi pairs, stuff like that.
man/troff usually won't complain about them, instead choosing to produce
output with various levels of wrong-ness.
My patches correct troff markup only. No content changes. Below are my fixes
to mount(8), please look at it. If you agree to apply these kind of fixes,
I'll provide the rest of them.
The following patch cleans up mount(8), including some visible defects.
Observe the following misformatting in mount(8):
The following commands allows one to recursively change the type of all
the mounts under a given mountpoint.
mount --make-rshared mountpoint
mount --make-rslave mountpoint
mount --make-rprivate mountpoint
"mount --make-runbindable mountpoint"
The quotes don't belong there. Later, there's broken indentation due to a
misbalanced .RS/.RE:
the default) is to subtract the overhead blocks used by the ext2
file system and not available for file storage. Thus
% mount /k -o minixdf; df /k; umount /k
Filesystem 1024-blocks Used Available Capacity Mounted on
/dev/sda6 2630655 86954 2412169 3% /k
% mount /k -o bsddf; df /k; umount /k
Filesystem 1024-blocks Used Available Capacity Mounted on
/dev/sda6 2543714 13 2412169 0% /k
(Note that this example shows that one can add command line options to
the options given in /etc/fstab.)
The usage sample, and the trailing note, appears to belong at the same
indentation level as the preceding paragraph.
Here's the patch that fixes all the gremlins in mount(8). Let me know
--- sources/util-linux/util-linux-ng-2.14.1/mount/mount.8~ 2008-09-10 05:02:43.000000000 -0400
+++ sources/util-linux/util-linux-ng-2.14.1/mount/mount.8 2008-11-30 21:34:25.000000000 -0500
@@ -46,9 +46,9 @@
.BI "mount [\-lhV]"
.LP
.BI "mount \-a [\-fFnrsvw] [\-t " vfstype "] [\-O " optlist ]
-.br
+.LP
.BI "mount [\-fnrsvw] [\-o " options " [,...]] " "device " | " dir"
-.br
+.LP
.BI "mount [\-fnrsvw] [\-t " vfstype "] [\-o " options "] " "device dir"
.SH DESCRIPTION
All files accessible in a Unix system are arranged in one big
@@ -145,30 +145,23 @@
operation. Detailed semantics is documented in Documentation/sharedsubtree.txt
file in the kernel source tree.
.RS
-.br
+.nf
.B "mount --make-shared mountpoint"
-.br
.B "mount --make-slave mountpoint"
-.br
.B "mount --make-private mountpoint"
-.br
.B "mount --make-unbindable mountpoint"
-.br
+.fi
.RE
The following commands allows one to recursively change the type of all the
mounts under a given mountpoint.
.RS
-.br
+.nf
.B "mount --make-rshared mountpoint"
-.br
.B "mount --make-rslave mountpoint"
-.br
.B "mount --make-rprivate mountpoint"
-.br
-.B
-"mount --make-runbindable mountpoint"
-.br
+.B "mount --make-runbindable mountpoint"
+.fi
.RE
The
@@ -201,8 +194,9 @@
.LP
(i) The command
.RS
-.br
+.sp
.BI "mount \-a [\-t " type "] [\-O " optlist ]
+.sp
.RE
(usually given in a bootscript) causes all file systems mentioned in
.I fstab
@@ -227,19 +221,22 @@
.LP
Thus, given a line
.RS
-.br
+.sp
.B "/dev/cdrom /cd iso9660 ro,user,noauto,unhide"
+.sp
.RE
any user can mount the iso9660 file system found on his CDROM
using the command
.RS
-.br
+.sp
.B "mount /dev/cdrom"
+.sp
.RE
or
.RS
-.br
+.sp
.B "mount /cd"
+.sp
.RE
For more details, see
.BR fstab (5).
@@ -527,14 +524,12 @@
For example, the command:
.RS
-.RS
.B "mount \-a \-t nomsdos,ext"
.RE
mounts all file systems except those of type
.I msdos
and
.IR ext .
-.RE
.TP
.B \-O
Used in conjunction with
@@ -547,8 +542,9 @@
.BR \-a .
For example, the command:
.RS
-.RS
+.sp
.B "mount \-a \-O no_netdev"
+.sp
.RE
mounts all file systems except those which have the option
.I _netdev
@@ -568,11 +564,12 @@
.B \-O
options are cumulative in effect; that is, the command
.RS
+.sp
.B "mount \-a \-t ext2 \-O _netdev"
+.sp
.RE
mounts all ext2 filesystems with the _netdev option, not all filesystems
that are either ext2 or have the _netdev option specified.
-.RE
.TP
.B \-o
Options are specified with a
@@ -934,7 +931,6 @@
.B bsddf
behaviour (which is the default) is to subtract the overhead blocks
used by the ext2 file system and not available for file storage. Thus
-.RE
.nf
% mount /k -o minixdf; df /k; umount /k
@@ -1069,7 +1065,6 @@
Sync all data and metadata every
.I nrsec
seconds. The default value is 5 seconds. Zero means default.
-.RE
.TP
.BR user_xattr
Enable Extended User Attributes. See the
@@ -2098,9 +2093,9 @@
.SH NOTES
The syntax of external mount helpers is:
-.br
-.BI "/sbin/mount.<suffix> spec dir [\-sfnv] [\-o options]
-.br
+.RS
+.B "/sbin/mount.<suffix> spec dir [\-sfnv] [\-o options]
+.RE
where the <suffix> is filesystem type and \-sfnvo options have same meaning like
standard mount options.
--
To unsubscribe from this list: send the line "unsubscribe util-linux-ng" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
