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