Updated the fstab-decode manual page to explain what the utility does.

This commit is contained in:
Jesse Smith 2019-02-21 15:09:48 -04:00
parent 25191ff9aa
commit 80e83960da
2 changed files with 21 additions and 1 deletions

View File

@ -33,6 +33,7 @@ sysvinit (2.94) unreleased; urgency=low
else (it's rude and security risk). Set up "when" as its own buffer else (it's rude and security risk). Set up "when" as its own buffer
that has data from optargs and/or argv copied into it. that has data from optargs and/or argv copied into it.
* Fixed typo in init.8 manual page. * Fixed typo in init.8 manual page.
* Updated text of fstab-decode to explain what the utility does.
sysvinit (2.93) released; urgency=low sysvinit (2.93) released; urgency=low

View File

@ -27,13 +27,26 @@ fstab-decode \- run a command with fstab-encoded arguments
.SH DESCRIPTION .SH DESCRIPTION
.B fstab-decode .B fstab-decode
decodes escapes in the specified \fIARGUMENT\fRs decodes escapes (such as newline characters) in the specified \fIARGUMENT\fRs
and uses them to run \fICOMMAND\fR. and uses them to run \fICOMMAND\fR.
The argument escaping uses the same rules as path escaping in The argument escaping uses the same rules as path escaping in
\fB/etc/fstab\fR, \fB/etc/fstab\fR,
.B /etc/mtab .B /etc/mtab
and \fB/proc/mtab\fR. and \fB/proc/mtab\fR.
In essence fstab-decode can be used anytime we want to pass multiple
parameters to a command as a list of command line argments. It turns output
like this:
.nf
/root
/mnt/remote-disk
/home
Into one long list of parameters, "/root /mnt/remote-disk /home". This
can be useful when trying to work with multiple filesystems at once. For
instance, we can use it to unmount multiple NFS shares.
.SH EXIT STATUS .SH EXIT STATUS
.B fstab-decode .B fstab-decode
exits with status 127 if exits with status 127 if
@ -43,5 +56,11 @@ Otherwise it exits with the status returned by \fICOMMAND\fR.
.SH EXAMPLES .SH EXAMPLES
.nf .nf
The following example reads fstab, finds all instances of VFAT filesystems and
prints their mount points (argument 2 in the fstab file). fstab-decode then runs
the specified program, umount, and passes it the list of VFAT mountpoints.
This unmounts all VFAT partitions.
.B fstab-decode umount $(awk \[aq]$3 == \[dq]vfat\[dq] { print $2 }\[aq] /etc/fstab) .B fstab-decode umount $(awk \[aq]$3 == \[dq]vfat\[dq] { print $2 }\[aq] /etc/fstab)
.fi .fi