Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_getcalleraccess.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fs_getcalleraccess - Show the current user's access to a file or directory
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fs getcalleraccess> S<<< [B<-path> <I<path>>+] >>> [B<-help>]
11
12B<fs gca> S<<< [B<-p> <I<path>>] >>> [B<-h>]
13
14=for html
15</div>
16
17=head1 DESCRIPTION
18
19The B<fs getcalleraccess> command displays the access that the current
20user has to the specified path using the same representation as B<fs
21listacl>.
22
23=head1 OPTIONS
24
25=over 4
26
27=item B<-help>
28
29Prints the online help for this command. All other valid options are
30ignored.
31
32=item B<-path> <I<path>>+
33
34The B<-path> option specifies the path on which to operate. B<-path> may
35be omitted. If this option isn't given, the default is to act on the
36current directory.
37
38=back
39
40=head1 OUTPUT
41
42For each path, B<fs getcalleraccess> outputs a line like:
43
44 Callers access to <directory> is <rights>
45
46where <directory> is the path on which it is operating and <rights> is an
47ACL string in the same format as is returned by B<fs listacl>. See
48L<fs_listacl(1)> for more information about AFS ACL strings.
49
50=head1 EXAMPLES
51
52The following command shows the current user's access to the path
53F</afs/openafs.org>, which is read and lookup access.
54
55 % fs getcalleraccess /afs/openafs.org
56 Callers access to /afs/openafs.org is rl
57 %
58
59=head1 PRIVILEGE REQUIRED
60
61No special privileges are required for this command.
62
63=head1 SEE ALSO
64
65L<fs_listacl(1)>,
66L<fs_setacl(1)>
67
68=head1 COPYRIGHT
69
70Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
71
72This documentation is covered by the BSD License as written in the
73doc/LICENSE file. This man page was written by Jason Edgecombe for
74OpenAFS.