[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_rmmount.pod

=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/.example.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/example.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.
Commit	Line	Data
805e021f CE	1	=head1 NAME
	2
	3	fs_rmmount - Removes a mount point
	4
	5	=head1 SYNOPSIS
	6
	7	=for html
	8	<div class="synopsis">
	9
	10	B<fs rmmount> S<<< B<-dir> <I<directory>>+ >>> [B<-help>]
	11
	12	B<fs rm> S<<< B<-d> <I<directory>>+ >>> [B<-h>]
	13
	14	=for html
	15	</div>
	16
	17	=head1 DESCRIPTION
	18
	19	The fs rmmount command removes the mount point named by the B<-dir>
	20	argument from the file system. The corresponding volume remains on its
	21	host partition or partitions, but is inaccessible if there are no other
	22	mount points for it.
	23
	24	=head1 OPTIONS
	25
	26	=over 4
	27
	28	=item B<-dir> <I<directory>>+
	29
	30	Names the mount point to delete from the file system. The last element in
	31	the pathname must be an actual name, not a shorthand notation such as
	32	"dot" (C<.>) or "dot dot" (C<..>).
	33
	34	Specify the read/write path to the directory, to avoid the failure that
	35	results from attempting to delete a mount point from a read-only
	36	volume. By convention, the read/write path is indicated by placing a
	37	period before the cell name at the pathname's second level (for example,
	38	F</afs/.example.com>). For further discussion of the concept of read/write and
	39	read-only paths through the filespace, see the B<fs mkmount> reference
	40	page.
	41
	42	=item B<-help>
	43
	44	Prints the online help for this command. All other valid options are
	45	ignored.
	46
	47	=back
	48
	49	=head1 EXAMPLES
	50
	51	The following command removes the mount points F<jones> and F<terry> from
	52	the current working directory (the F</afs/example.com/usr> directory).
	53
	54	% fs rmmount jones terry
	55
	56	=head1 PRIVILEGE REQUIRED
	57
	58	The issuer must have the C<d> (delete) permission on the ACL of the
	59	directory that houses each mount point.
	60
	61	=head1 SEE ALSO
	62
	63	L<fs_lsmount(1)>,
	64	L<fs_mkmount(1)>
65
66	=head1 COPYRIGHT
67
68	IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
69
70	This documentation is covered by the IBM Public License Version 1.0. It was
71	converted from HTML to POD by software written by Chas Williams and Russ
72	Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.