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