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

=head1 NAME

fs_lsmount - Reports the volume for which a directory is the mount point.

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<fs lsmount> S<<< B<-dir> <I<directory>>+ >>> [B<-help>]

S<<< B<fs ls -d> <I<directory>>+ >>> [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<fs lsmount> command reports the volume for which each specified
directory is a mount point, or indicates with an error message that a
directory is not a mount point or is not in AFS.

To create a mount point, use the B<fs mkmount> command. To remove one, use
the B<fs rmmount> command.

=head1 OPTIONS

=over 4

=item B<-dir> <I<directory>>+

Names the directory that serves as a mount point for a volume. The last
element in the pathname provided must be an actual name, not a shorthand
notation such as one or two periods (C<.> or C<..>).

=item B<-help>

Prints the online help for this command. All other valid options
are ignored.

=back

=head1 OUTPUT

If the specified directory is a mount point, the output is of the
following form:

   '<directory>' is a mount point for volume '<volume name>'

where

=over 4

=item *

A number sign (C<#>) precedes the <volume name> string for a regular mount
point.

=item *

A percent sign (C<%>) precedes the <volume name> string for a read/write
mount point.

=item *

A cell name and colon (C<:>) follow the number or percent sign and precede
the <volume name> string for a cellular mount point.

=back

The B<fs mkmount> reference page explains how the Cache Manager interprets
each of the three types of mount points.

If the directory is a symbolic link to a mount point, the output is of the
form:

   '<directory>' is a symbolic link, leading to a mount point for volume
   '<volume name>'

If the directory is not a mount point or is not in AFS, the output reads:

   '<directory>' is not a mount point.

If the output is garbled, it is possible that the mount point has become
corrupted in the local AFS client cache. Use the B<fs flushmount> command
to discard it, which forces the Cache Manager to refetch the mount point.

=head1 EXAMPLES

The following example shows the mount point for the home directory of user
C<smith>:

   % fs lsmount /afs/example.com/usr/smith
   '/afs/example.com/usr/smith' is a mount point for volume '#user.smith'

The following example shows both the regular and read/write mount points
for the Example Corporation cell's C<root.cell> volume.

   % fs lsmount /afs/example.com
   '/afs/example.com' is a mount point for volume '#root.cell'

   % fs lsmount /afs/.example.com
   '/afs/.example.com' is a mount point for volume '%root.cell'

The following example shows a cellular mount point: the Example Organization
cell's C<root.cell> volume as mounted in the Example Corporation cell's tree.

   % fs lsmount /afs/example.org
   '/afs/example.org' is a mount point for volume '#example.org:root.cell'

=head1 PRIVILEGE REQUIRED

The issuer must have the C<l> (lookup) permission on the ACL of the root
directory of the volume that houses the file or directory named by the
B<-dir> argument, and on the ACL of each directory that precedes it in the
pathname.

=head1 SEE ALSO

L<fs_flushmount(1)>,
L<fs_mkmount(1)>,
L<fs_rmmount(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_lsmount - Reports the volume for which a directory is the mount point.
	4
	5	=head1 SYNOPSIS
	6
	7	=for html
	8	<div class="synopsis">
	9
	10	B<fs lsmount> S<<< B<-dir> <I<directory>>+ >>> [B<-help>]
	11
	12	S<<< B<fs ls -d> <I<directory>>+ >>> [B<-h>]
	13
	14	=for html
	15	</div>
	16
	17	=head1 DESCRIPTION
	18
	19	The B<fs lsmount> command reports the volume for which each specified
	20	directory is a mount point, or indicates with an error message that a
	21	directory is not a mount point or is not in AFS.
	22
	23	To create a mount point, use the B<fs mkmount> command. To remove one, use
	24	the B<fs rmmount> command.
	25
	26	=head1 OPTIONS
	27
	28	=over 4
	29
	30	=item B<-dir> <I<directory>>+
	31
	32	Names the directory that serves as a mount point for a volume. The last
	33	element in the pathname provided must be an actual name, not a shorthand
	34	notation such as one or two periods (C<.> or C<..>).
	35
	36	=item B<-help>
	37
	38	Prints the online help for this command. All other valid options
	39	are ignored.
	40
	41	=back
	42
	43	=head1 OUTPUT
	44
	45	If the specified directory is a mount point, the output is of the
	46	following form:
	47
	48	'<directory>' is a mount point for volume '<volume name>'
	49
	50	where
	51
	52	=over 4
	53
	54	=item *
	55
	56	A number sign (C<#>) precedes the <volume name> string for a regular mount
	57	point.
	58
	59	=item *
	60
	61	A percent sign (C<%>) precedes the <volume name> string for a read/write
	62	mount point.
	63
	64	=item *
65
66	A cell name and colon (C<:>) follow the number or percent sign and precede
67	the <volume name> string for a cellular mount point.
68
69	=back
70
71	The B<fs mkmount> reference page explains how the Cache Manager interprets
72	each of the three types of mount points.
73
74	If the directory is a symbolic link to a mount point, the output is of the
75	form:
76
77	'<directory>' is a symbolic link, leading to a mount point for volume
78	'<volume name>'
79
80	If the directory is not a mount point or is not in AFS, the output reads:
81
82	'<directory>' is not a mount point.
83
84	If the output is garbled, it is possible that the mount point has become
85	corrupted in the local AFS client cache. Use the B<fs flushmount> command
86	to discard it, which forces the Cache Manager to refetch the mount point.
87
88	=head1 EXAMPLES
89
90	The following example shows the mount point for the home directory of user
91	C<smith>:
92
93	% fs lsmount /afs/example.com/usr/smith
94	'/afs/example.com/usr/smith' is a mount point for volume '#user.smith'
95
96	The following example shows both the regular and read/write mount points
97	for the Example Corporation cell's C<root.cell> volume.
98
99	% fs lsmount /afs/example.com
100	'/afs/example.com' is a mount point for volume '#root.cell'
101
102	% fs lsmount /afs/.example.com
103	'/afs/.example.com' is a mount point for volume '%root.cell'
104
105	The following example shows a cellular mount point: the Example Organization
106	cell's C<root.cell> volume as mounted in the Example Corporation cell's tree.
107
108	% fs lsmount /afs/example.org
109	'/afs/example.org' is a mount point for volume '#example.org:root.cell'
110
111	=head1 PRIVILEGE REQUIRED
112
113	The issuer must have the C<l> (lookup) permission on the ACL of the root
114	directory of the volume that houses the file or directory named by the
115	B<-dir> argument, and on the ACL of each directory that precedes it in the
116	pathname.
117
118	=head1 SEE ALSO
119
120	L<fs_flushmount(1)>,
121	L<fs_mkmount(1)>,
122	L<fs_rmmount(1)>
123
124	=head1 COPYRIGHT
125
126	IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
127
128	This documentation is covered by the IBM Public License Version 1.0. It was
129	converted from HTML to POD by software written by Chas Williams and Russ
130	Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.