From: Jason Edgecombe <jason@rampaginggeek.com>
Date: Sat, 18 Aug 2007 02:55:31 +0000 (+0000)
Subject: DEVEL15-man-page-fs-updates-20070817
X-Git-Tag: openafs-devel-1_5_23~28
X-Git-Url: http://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=5454dcadb5545c3429e931019d995cbd03557882

DEVEL15-man-page-fs-updates-20070817


Add man pages for fs flushall and fs getcalleraccess.


(cherry picked from commit 024442b020043501f14069d762ecefbf7feef59a)
---

diff --git a/doc/man-pages/README b/doc/man-pages/README
index bac4f39..cbe9baf 100644
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -198,8 +198,6 @@ Known Problems
    * The following installed commands have no man pages:
 
        copyauth
-       flushall (Windows only)
-       fs getcalleraccess
        fs rxstatpeer
        fs rxstatproc
        fs setcbaddr
diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod
index e240ace..75dce00 100644
--- a/doc/man-pages/pod1/fs.pod
+++ b/doc/man-pages/pod1/fs.pod
@@ -34,6 +34,7 @@ and L<B<fs wscell>|fs_wscell(1)>.
 Commands to administer access control lists (ACLs):
 L<B<fs cleanacl>|fs_cleanacl(1)>,
 L<B<fs copyacl>|fs_copyacl(1)>,
+L<B<fs getcalleraccess>|fs_getcalleraccess(1)>,
 L<B<fs listacl>|fs_listacl(1)>,
 and L<B<fs setacl>|fs_setacl(1)>.
 
@@ -55,6 +56,7 @@ and L<B<fs whichcell>|fs_whichcell(1)>.
 Commands to administer the local client cache and related information:
 L<B<fs checkvolumes>|fs_checkvolumes(1)>,
 L<B<fs flush>|fs_flush(1)>,
+L<B<fs flushall>|fs_flushall(1)>,
 L<B<fs flushvolume>|fs_flushvolume(1)>,
 L<B<fs getcacheparms>|fs_getcacheparms(1)>,
 L<B<fs listaliases>|fs_listaliases(1)>,
@@ -185,9 +187,11 @@ L<fs_diskfree(1)>,
 L<fs_examine(1)>,
 L<fs_exportafs(1)>,
 L<fs_flush(1)>,
+L<fs_flushall(1)>,
 L<fs_flushmount(1)>,
 L<fs_flushvolume(1)>,
 L<fs_getcacheparms(1)>,
+L<fs_getcalleraccess(1)>,
 L<fs_getcellstatus(1)>,
 L<fs_getclientaddrs(1)>,
 L<fs_getcrypt(1)>,
diff --git a/doc/man-pages/pod1/fs_flushall.pod b/doc/man-pages/pod1/fs_flushall.pod
new file mode 100644
index 0000000..3fac90f
--- /dev/null
+++ b/doc/man-pages/pod1/fs_flushall.pod
@@ -0,0 +1,62 @@
+=head1 NAME
+
+fs flushall - Force the AFS Cache Manager to discard all data
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs flushall> [B<-help>]
+
+B<fs flusha> [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs flushall> command flushes all data from the AFS cache.
+
+=head1 CAUTIONS
+
+This command is only available on Windows.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command.
+
+=back
+
+=head1 OUTPUT
+
+This command has no output.
+
+=head1 EXAMPLES
+
+Aside from the help, there is only one way to run B<fs flushall>, which is
+as follows:
+
+   % fs flushall
+   %
+
+=head1 PRIVILEGE REQUIRED
+
+No special privileges are required for this command.
+
+=head1 SEE ALSO
+
+L<fs_flush(1)>,
+L<fs_flushmount(1)>,
+L<fs_flushvolume(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.
diff --git a/doc/man-pages/pod1/fs_getcalleraccess.pod b/doc/man-pages/pod1/fs_getcalleraccess.pod
new file mode 100644
index 0000000..56a14f8
--- /dev/null
+++ b/doc/man-pages/pod1/fs_getcalleraccess.pod
@@ -0,0 +1,73 @@
+=head1 NAME
+
+fs getcalleraccess - Show the current user's access to a file or directory
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs getcalleraccess> S<<< [B<-path> <I<path>>+] >>> [B<-help>]
+
+B<fs gca> S<<< [B<-p> <I<path>>] >>> [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs getcalleraccess> command displays the access that the current
+user has to the specified path using the same representation as B<fs
+listacl>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=item B<-path> <I<path>>+
+
+The B<-path> option specifies the path on which to operate. B<-path> may
+be omitted. If this option isn't given, the default is to act on the
+current directory.
+
+=back
+
+=head1 OUTPUT
+
+For each path, B<fs getcalleraccess> outputs a line like:
+
+    Callers access to <directory> is <rights>
+
+where <directory> is the path on which it is operating and <rights> is an
+ACL string in the same format as is returned by B<fs listacl>. See
+L<fs_listacl(1)> for more information about AFS ACL strings.
+
+=head1 EXAMPLES
+
+The following command shows the current user's access to the path
+F</afs/openafs.org>, which is read and lookup access.
+
+   % fs getcalleraccess /afs/openafs.org
+   Callers access to /afs/openafs.org is rl
+   %
+
+=head1 PRIVILEGE REQUIRED
+
+No special privileges are required for this command.
+
+=head1 SEE ALSO
+
+L<fs_listacl(1)>,
+L<fs_setacl(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.