DEVEL15-man-page-fs-monitor-20090518

LICENSE IPL10
FIXES 124790

Add man page for fs monitor.

(cherry picked from commit 01ba5ab1ed24d14c1068d5dac951cbea1befba10)

diff --git a/doc/man-pages/README b/doc/man-pages/README
index 862d129..6fe3af9 100644 (file)
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -231,7 +231,6 @@ Known Problems
 
    * The following installed commands have no man pages:
 
-       fs monitor
        klog.krb
        krb.conf
        pagsh.krb

diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod
index dda1876..0a4dd14 100644 (file)
--- a/doc/man-pages/pod1/fs.pod
+++ b/doc/man-pages/pod1/fs.pod
@@ -81,6 +81,7 @@ L<B<fs debug>|fs_debug(1)>,
 L<B<fs memdump>|fs_memdump(1)>,
 L<B<fs messages>|fs_messages(1)>,
 L<B<fs minidump>|fs_minidump(1)>,
+L<B<fs monitor>|fs_monitor(1)>,
 L<B<fs rxstatpeer>|fs_rxstatpeer(1)>,
 L<B<fs rxstatproc>|fs_rxstatproc(1)>,
 and L<B<fs trace>|fs_trace(1)>.
@@ -217,6 +218,7 @@ L<fs_memdump(1)>,
 L<fs_messages(1)>,
 L<fs_minidump(1)>,
 L<fs_mkmount(1)>,
+L<fs_monitor(1)>,
 L<fs_newalias(1)>,
 L<fs_newcell(1)>,
 L<fs_quota(1)>,

diff --git a/doc/man-pages/pod1/fs_monitor.pod b/doc/man-pages/pod1/fs_monitor.pod
new file mode 100644 (file)
index 0000000..9631c60
--- /dev/null
+++ b/doc/man-pages/pod1/fs_monitor.pod
@@ -0,0 +1,54 @@
+=head1 NAME
+
+fs_monitor - Enable client logging to a remote monitoring station
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs monitor> S<<< [B<-server> <I<hostname/IP address or 'off'>>] >>> [B<-help>]
+
+B<fs mariner> S<<< [B<-server> <I<hostname/IP address or 'off'>>] >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs monitor> command (aka B<mariner>) sets the cache monitor host
+address (or turns it off).
+
+=head1 CAUTIONS
+
+This command is hidden since the necessary remote monitoring component,
+B<venusmon>, is not part of OpenAFS.  This system is not currently
+distributed or supported.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<hostname/IP address or 'off'>>
+
+Name (or address) of the B<venusmon> host that monitoring information
+should be sent to.  Setting the server to I<off> turns off monitoring.
+
+=item B<-help>
+
+Prints the online help for this command.  All other valid options are
+ignored.
+
+=back
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be super-user on the local machine.
+
+=head1 COPYRIGHT
+
+Copyright 2009 Steven Jenkins <steven@endpoint.com>
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Steven Jenkins for
+OpenAFS.