Return to lonManage CVS log

Up to [LON-CAPA] / loncom

Add usage and skeleton documentation.

    1: #!/usr/bin/perl
    2: # The LearningOnline Network with CAPA
    3: #
    4: #  lonManage supports remote management of nodes in a LonCAPA cluster.
    5: #
    6: #  $Id: lonManage,v 1.2 2003/08/12 09:58:49 foxr Exp $
    7: #
    8: # $Id: lonManage,v 1.2 2003/08/12 09:58:49 foxr Exp $
    9: #
   10: # Copyright Michigan State University Board of Trustees
   11: #
   12: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   13: ## LON-CAPA is free software; you can redistribute it and/or modify
   14: # it under the terms of the GNU General Public License as published by
   15: # the Free Software Foundation; either version 2 of the License, or
   16: # (at your option) any later version.
   17: #
   18: # LON-CAPA is distributed in the hope that it will be useful,
   19: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   20: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   21: # GNU General Public License for more details.
   22: #
   23: # You should have received a copy of the GNU General Public License
   24: # along with LON-CAPA; if not, write to the Free Software
   25: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   26: #
   27: # /home/httpd/html/adm/gpl.txt
   28: #
   29: # http://www.lon-capa.org/
   30: #
   31: #
   32: #   lonManage supports management of remot nodes in a lonCAPA cluster.
   33: #   it is a command line tool.  The following command line syntax (usage)
   34: #   is supported:
   35: #
   36: #    lonManage  -push   <tablename>  newfile  host
   37: #        Push <tablename> to the lonTabs directory.  Note that
   38: #        <tablename> must be one of:
   39: #           hosts  (hosts.tab)
   40: #           domain (domain.tab)
   41: #
   42: #    lonManage  -reinit lonc host
   43: #           Sends a HUP signal to the remote systems's lond.
   44: #
   45: #    lonmanage  -reinit lond host
   46: #          Requests the remote system's lond perform the same action as if
   47: #          it had received a HUP signal.
   48: #
   49: #    In the above syntax, the host above is the hosts.tab name of a host,
   50: #    not the IP address of the host.
   51: #
   52: #  $Log: lonManage,v $
   53: #  Revision 1.2  2003/08/12 09:58:49  foxr
   54: #  Add usage and skeleton documentation.
   55: #
   56: #
   57: 
   58: sub Usage {} {
   59:     print "Usage:";
   60:     print <<USAGE;
   61:     lonManage  -push   <tablename>  newfile  host
   62:         Push <tablename> to the lonTabs directory.  Note that
   63:         <tablename> must be one of:
   64:            hosts  (hosts.tab)
   65:            domain (domain.tab)
   66: 
   67:     lonManage  -reinit lonc host
   68:            Sends a HUP signal to the remote systems's lond.
   69: 
   70:     lonmanage  -reinit lond host
   71:           Requests the remote system's lond perform the same action as if
   72:           it had received a HUP signal.
   73: 
   74:     In the above syntax, the host above is the hosts.tab name of a host,
   75:     not the IP address of the host.
   76: USAGE
   77: 
   78: 
   79: }
   80: 
   81: #
   82: #    If command parsing failed, then print usage:
   83: 
   84: if(0) {
   85:     Usage;
   86: }
   87: 
   88: =head1 NAME
   89:     lonManage - Command line utility for remote management of lonCAPA
   90:     cluster nodes.
   91: 
   92: =head1 SYNOPSIS
   93: 
   94: Usage:
   95:     B<lonManage  -push   <tablename>  newfile  host>
   96:         Push <tablename> to the lonTabs directory.  Note that
   97:         <tablename> must be one of:
   98:            hosts  (hosts.tab)
   99:            domain (domain.tab)
  100: 
  101:     B<lonManage  -reinit lonc host>
  102:            Sends a HUP signal to the remote systems's lond.
  103: 
  104:     B<lonmanage  -reinit lond host>
  105:           Requests the remote system's lond perform the same action as if
  106:           it had received a HUP signal.
  107: 
  108:     In the above syntax, the host above is the hosts.tab name of a host,
  109:     not the IP address of the host.
  110: 
  111: 
  112: =head1 DESCRIPTION
  113: 
  114: =head1 PREREQUISITES
  115: 
  116: =head1  CATEGORIES
  117:     Command line utility
  118: 
  119: =cut