Update NEWS for 1.8.0pre3
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / fs_getcalleraccess.pod
blob9c7cc9c9904e4d65a845e8481daaa64e8615b720
1 =head1 NAME
3 fs_getcalleraccess - Show the current user's access to a file or directory
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<fs getcalleraccess> S<<< [B<-path> <I<path>>+] >>> [B<-help>]
12 B<fs gca> S<<< [B<-p> <I<path>>] >>> [B<-h>]
14 =for html
15 </div>
17 =head1 DESCRIPTION
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>.
23 =head1 OPTIONS
25 =over 4
27 =item B<-help>
29 Prints the online help for this command. All other valid options are
30 ignored.
32 =item B<-path> <I<path>>+
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.
38 =back
40 =head1 OUTPUT
42 For each path, B<fs getcalleraccess> outputs a line like:
44     Callers access to <directory> is <rights>
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.
50 =head1 EXAMPLES
52 The following command shows the current user's access to the path
53 F</afs/openafs.org>, which is read and lookup access.
55    % fs getcalleraccess /afs/openafs.org
56    Callers access to /afs/openafs.org is rl
57    %
59 =head1 PRIVILEGE REQUIRED
61 No special privileges are required for this command.
63 =head1 SEE ALSO
65 L<fs_listacl(1)>,
66 L<fs_setacl(1)>
68 =head1 COPYRIGHT
70 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
72 This documentation is covered by the BSD License as written in the
73 doc/LICENSE file. This man page was written by Jason Edgecombe for
74 OpenAFS.