openafs/doc/man-pages/pod1/fs_rmmount.pod
Russ Allbery fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00

73 lines
1.9 KiB
Plaintext

=head1 NAME
fs rmmount - Removes a mount point
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fs rmmount> S<<< B<-dir> <I<directory>>+ >>> [B<-help>]
B<fs rm> S<<< B<-d> <I<directory>>+ >>> [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The fs rmmount command removes the mount point named by the B<-dir>
argument from the file system. The corresponding volume remains on its
host partition or partitions, but is inaccessible if there are no other
mount points for it.
=head1 OPTIONS
=over 4
=item B<-dir> <I<directory>>+
Names the mount point to delete from the file system. The last element in
the pathname must be an actual name, not a shorthand notation such as
"dot" (C<.>) or "dot dot" (C<..>).
Specify the read/write path to the directory, to avoid the failure that
results from attempting to delete a mount point from a read-only
volume. By convention, the read/write path is indicated by placing a
period before the cell name at the pathname's second level (for example,
F</afs/.abc.com>). For further discussion of the concept of read/write and
read-only paths through the filespace, see the B<fs mkmount> reference
page.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command removes the mount points F<jones> and F<terry> from
the current working directory (the F</afs/abc.com/usr> directory).
% fs rmmount jones terry
=head1 PRIVILEGE REQUIRED
The issuer must have the C<d> (delete) permission on the ACL of the
directory that houses each mount point.
=head1 SEE ALSO
L<fs_lsmount(1)>,
L<fs_mkmount(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.