DEVEL15-man-page-yet-more-fs-commands-20090517
authorMike Robinson <mike@endpoint.com>
Mon, 18 May 2009 04:40:54 +0000 (04:40 +0000)
committerRuss Allbery <rra@stanford.edu>
Mon, 18 May 2009 04:40:54 +0000 (04:40 +0000)
LICENSE IPL10
FIXES 109189

Add new man pages for fs rxstatproc, fs setcbaddr, and fs trace.  Also
updates the links from fs to its subsidiary man pages and fixes the
fs rxstatpeer man page a bit to mirror fs rxstatproc.

(cherry picked from commit faf518ace7c8c0ec9c3269afd267afd276d69cd4)

doc/man-pages/README
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/fs_rxstatpeer.pod
doc/man-pages/pod1/fs_rxstatproc.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_setcbaddr.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_trace.pod [new file with mode: 0644]

index d324c87..ba92d69 100644 (file)
@@ -234,10 +234,6 @@ Known Problems
        compile_et.afs
        copyauth
        fs monitor
-       fs rxstatpeer
-       fs rxstatproc
-       fs setcbaddr
-       fs trace
        klog.krb
        krb.conf
        pagsh.krb
index 5af22e5..dda1876 100644 (file)
@@ -23,6 +23,7 @@ L<B<fs getcrypt>|fs_getcrypt(1)>,
 L<B<fs getserverprefs>|fs_getserverprefs(1)>,
 L<B<fs listcells>|fs_listcells(1)>,
 L<B<fs newcell>|fs_newcell(1)>,
+L<B<fs setcbaddr>|fs_setcbaddr(1)>,
 L<B<fs setcell>|fs_setcell(1)>,
 L<B<fs setcrypt>|fs_setcrypt(1)>,
 L<B<fs setserverprefs>|fs_setserverprefs(1)>,
@@ -78,7 +79,11 @@ and L<B<fs rmmount>|fs_rmmount(1)>.
 Commands to control monitoring and tracing:
 L<B<fs debug>|fs_debug(1)>,
 L<B<fs memdump>|fs_memdump(1)>,
-and L<B<fs messages>|fs_messages(1)>.
+L<B<fs messages>|fs_messages(1)>,
+L<B<fs minidump>|fs_minidump(1)>,
+L<B<fs rxstatpeer>|fs_rxstatpeer(1)>,
+L<B<fs rxstatproc>|fs_rxstatproc(1)>,
+and L<B<fs trace>|fs_trace(1)>.
 
 =item *
 
@@ -187,6 +192,7 @@ L<fs_checkservers(1)>,
 L<fs_checkvolumes(1)>,
 L<fs_cleanacl(1)>,
 L<fs_copyacl(1)>,
+L<fs_cscpolicy(1)>,
 L<fs_diskfree(1)>,
 L<fs_examine(1)>,
 L<fs_exportafs(1)>,
@@ -199,6 +205,7 @@ L<fs_getcalleraccess(1)>,
 L<fs_getcellstatus(1)>,
 L<fs_getclientaddrs(1)>,
 L<fs_getcrypt(1)>,
+L<fs_getfid(1)>,
 L<fs_getserverprefs(1)>,
 L<fs_help(1)>,
 L<fs_listacl(1)>,
@@ -206,14 +213,19 @@ L<fs_listaliases(1)>,
 L<fs_listcells(1)>,
 L<fs_listquota(1)>,
 L<fs_lsmount(1)>,
+L<fs_memdump(1)>,
 L<fs_messages(1)>,
+L<fs_minidump(1)>,
 L<fs_mkmount(1)>,
 L<fs_newalias(1)>,
 L<fs_newcell(1)>,
 L<fs_quota(1)>,
 L<fs_rmmount(1)>,
+L<fs_rxstatpeer(1)>,
+L<fs_rxstatproc(1)>,
 L<fs_setacl(1)>,
 L<fs_setcachesize(1)>,
+L<fs_setcbattr(1)>,
 L<fs_setcell(1)>,
 L<fs_setclientaddrs(1)>,
 L<fs_setcrypt(1)>,
@@ -222,6 +234,7 @@ L<fs_setserverprefs(1)>,
 L<fs_setvol(1)>,
 L<fs_storebehind(1)>,
 L<fs_sysname(1)>,
+L<fs_trace(1)>,
 L<fs_whereis(1)>,
 L<fs_whichcell(1)>,
 L<fs_wscell(1)>
index ed9aab0..fcc951e 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-fs_rxstatpeer - Enables Rx packet logging in the OpenAFS kernel module
+fs_rxstatpeer - Manage per-peer Rx statistics collection
 
 =head1 SYNOPSIS
 
@@ -57,6 +57,7 @@ The issuer must be logged in as the local superuser root.
 =head1 SEE ALSO
 
 L<fs(1)>,
+L<fs_rxstatproc(1)>,
 L<rxdebug(1)>
 
 =head1 COPYRIGHT
diff --git a/doc/man-pages/pod1/fs_rxstatproc.pod b/doc/man-pages/pod1/fs_rxstatproc.pod
new file mode 100644 (file)
index 0000000..20a7c3d
--- /dev/null
@@ -0,0 +1,65 @@
+=head1 NAME
+
+fs_rxstatproc - Manage per-process Rx statistics collection
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs rxstatproc> [B<-enable>] [B<-disable>] [B<-clear>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+This command enables or disables the updating of RPC statistics counters
+related to the entire RX process, or sets the accumulated counter values
+back to zero.
+
+=head1 OPTIONS
+
+One or more of the following options must be specified:
+
+=over 4
+
+=item B<-enable>
+
+Enable the collection of process RPC statistics
+
+=item B<-disable>
+
+Enable the collection of process RPC statistics
+
+=item B<-clear>
+
+Resets all trace counters to zero.
+
+=over
+
+=head1 OUTPUT
+
+This command produces no output other than error-messages.
+
+=head1 EXAMPLES
+
+The following command starts collecting statistics:
+
+   % fs rxstatproc -enable
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be logged in as the local superuser root.
+
+=head1 SEE ALSO
+
+L<fs(1)>,
+L<fs_rxstatpeer(1)>,
+L<rxdebug(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2008. This documentation is covered by the BSD License as
+written in the doc/LICENSE file. This man page was written by Mike
+Robinson (L<mike@endpoint.com>) for OpenAFS.
diff --git a/doc/man-pages/pod1/fs_setcbaddr.pod b/doc/man-pages/pod1/fs_setcbaddr.pod
new file mode 100644 (file)
index 0000000..10c7227
--- /dev/null
@@ -0,0 +1,49 @@
+=head1 NAME
+
+fs_setcbaddr - Configure IP address used for AFS callbacks
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs setcbaddr> S<<< [B<-host> <I<address>>] >>>
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+B<fs setcbaddr> changes the IP address used by the client for callbacks.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-host> <I<address>>]
+
+The new callback address.
+
+=back
+
+=head1 OUTPUT
+
+This command produces no output other than error messages.
+
+=head1 EXAMPLES
+
+   % fs setcbaddr 10.2.4.23
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be the local superuser.
+
+=head1 SEE ALSO
+
+L<fs(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2008. This documentation is covered by the BSD License as
+written in the doc/LICENSE file. This man page was written by Mike
+Robinson (L<mike@endpoint.com>) for OpenAFS.
diff --git a/doc/man-pages/pod1/fs_trace.pod b/doc/man-pages/pod1/fs_trace.pod
new file mode 100644 (file)
index 0000000..38cc0f6
--- /dev/null
@@ -0,0 +1,86 @@
+=head1 NAME
+
+fs_trace - Enable or disable AFS Cache Manager tracing 
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs trace> S<<< [B<-on>|B<-off>] >>> [B<-reset>] [B<-dump>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+This command enables or disables AFS Cache Manager tracing, resets the
+trace log, or dumps the log.  When you dump the log, two files are created
+in the Windows Temporary directory:  F<afs-buffer.log> and F<afsd.log>.
+Any existing files with those names will be replaced.
+
+=head1 CAUTIONS
+
+This command is only available on Windows.
+
+=head1 OPTIONS
+
+Any combination of the following options may be specified, except that
+both B<-on> and B<-off> cannot be specified at the same time.
+
+=over 4
+
+=item B<-on>
+
+Turn tracing on.
+
+=item B<-off>
+
+Turn tracing off.
+
+=item B<-reset>
+
+Resets the tracing information, discarding any trace-information collected
+up to this time.
+
+=item B<-dump>
+
+Creates a dump file containing the trace information.
+
+=over
+
+=head1 OUTPUT
+
+If successful, the output of this command (for any option) will be:
+
+   AFS tracing enabled
+
+If unsuccessful:
+
+   AFS tracing disabled
+
+=head1 EXAMPLES
+
+The following command starts tracing:
+
+   % fs trace -on
+
+The following dumps the current contents and resets the trace log, then
+turns tracing off:
+
+   % fs trace -dump -reset -off
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be have AFS Client Administrator access to issue this
+command.
+
+=head1 SEE ALSO
+
+L<fs(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2008. This documentation is covered by the BSD License as
+written in the doc/LICENSE file. This man page was written by Mike
+Robinson (L<mike@endpoint.com>) for OpenAFS.