doc/man-pages/pod1/fs_monitor.pod

   1 =head1 NAME
   2
   3 fs_monitor - Enable client logging to a remote monitoring station
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs monitor> S<<< [B<-server> <I<hostname/IP address or 'off'>>] >>> [B<-help>]
  11
  12 B<fs mariner> S<<< [B<-server> <I<hostname/IP address or 'off'>>] >>> [B<-help>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<fs monitor> command (aka B<mariner>) sets the cache monitor host
  20 address (or turns it off).
  21
  22 =head1 CAUTIONS
  23
  24 This command is hidden since the necessary remote monitoring component,
  25 B<venusmon>, is not part of OpenAFS.  This system is not currently
  26 distributed or supported.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-server> <I<hostname/IP address or 'off'>>
  33
  34 Name (or address) of the B<venusmon> host that monitoring information
  35 should be sent to.  Setting the server to I<off> turns off monitoring.
  36
  37 =item B<-help>
  38
  39 Prints the online help for this command.  All other valid options are
  40 ignored.
  41
  42 =back
  43
  44 =head1 PRIVILEGE REQUIRED
  45
  46 The issuer must be super-user on the local machine.
  47
  48 =head1 COPYRIGHT
  49
  50 Copyright 2009 Steven Jenkins <steven@endpoint.com>
  51
  52 This documentation is covered by the BSD License as written in the
  53 doc/LICENSE file. This man page was written by Steven Jenkins for
  54 OpenAFS.