From: Stephen L Johnson Date: Wed, 17 Nov 1999 05:34:11 +0000 (+0000) Subject: Initial import X-Git-Tag: start~12 X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c972c69cf3ce36009a80ad4fada7b01bb3a4ee25;p=spong.git Initial import --- diff --git a/www/docs/spong.html b/www/docs/spong.html new file mode 100755 index 0000000..9285ccf --- /dev/null +++ b/www/docs/spong.html @@ -0,0 +1,201 @@ + + + + + + spong-server + + + +
+

+NAME

+spong - display spong system status from the command line +
+

+SYNOPSIS

+spong [--summary [hostlist] | --problems [hostlist] | --history +[hostlist] | --host host | --services host | --stats host +
                           +| --config host | --info host | --service host:service ] [--brief | --standard +| --full ] +

+

+

+DESCRIPTION

+The spong program interfaces with the spong-server to display the collected +information  in text format. The spong program does not have all of +the functionality of the web-based interface. It's designed to be used +from character based consoles. The spong program doesn not have to load +onto the same machine that spong-server is running on. You load this program +onto any machine. It is a good ideal to load this onto machines, when possible, +to allow the administrator of the machine to query the spong-servr when +alert of received. +

When run with any parameters, spong will display a table that lists +the hosts and services. All of the displays are text based with the legends +at the top. +

+Options

+ +
+--summary  [hostlist]
+ +
+ Summarize the status of hosts, in hostlist, in a table that lists +the hosts and services, and the current status is a single letter with +the meaning defined in the ledgend at the top of the display. If hostlist +if not specified all hosts defined in spong.hosts are displayed.
+ +
+--problems  [hostlist]
+ +
+Shows a summary of all the problems (services that are red) for the all +the hosts in hostlist. If hostlist is not specified, all hosts defined +in spong.hosts are displayed.
+ +
+--history  [hostlist]
+ +
+Show history information for the the list of hosts in hostlist. If host +list is not specified, all hosts defined in spong.hosts are displayed.
+ +
  +

  +
  +
  +

+--host  host
+ +
+Shows all information availiable for the given host.
+ +
+--services host
+ +
+Shows detailed service information for the given host.
+ +
+--stats host
+ +
+Show statistical information for the given host.
+ +
+--config host
+ +
+Shows configuration intomation for the given host.
+ +
+--info host
+ +
+Shows admin supplied text for the given host.
+ +
  +

  +
  +
  +

+--service host:service
+ +
+Shows detailed information for the given host/service. The
+ +
  +

  +

--brief +

+Display output in a brief format
+ +
+--standard
+ +
+Display output in standard format (the default)
+ +
+--full
+ +
+Display the maximum amount of information possible.
+ +
  +

  +

+

+

+CONFIGURATION

+By default, spong reads the /usr/local/etc/spong/spong.conf +file which define some specific variables that you probably don't need +to override. +

By default the  /usr/local/etc/spong/spong.conf   +file is read on startup. It defines some specific variable that you probably +don't need to override. +

After reading the configuration fil,  it then reads the /usr/local/etc/spong/spong.conf.[host] +file where [host] is the hostname of the machine that you are running on. +Since these configuration files are just standard perl code that gets imported, +the variables that you define in the host specific config file will take +precedence over the standard configuration settings. +

Here are a list of variables in the spong.conf file that are applicable +to the spong-server program: +
  +
+$SPONGSERVER
+ +
+The make of the server that spong-server is running on.
+ +
  +
+$SPONG_QUERY_PORT
+ +
+The port numbr that spong-server listens at for database queries.
+
+ +
+

+FILES

+ +
+
+/usr/local/etc/spong/spong.conf
+ +
+Configuration file. This contains variables that detail spong and OS specific +definitions used by spong-server. See spong.conf for additional +documentation.
+
+ +
+

+DEPENDENCIES

+Perl v5.003 or greater is required. +

+

+

+BUGS

+The --stats, --config, and --info parameters are currently +not implemented in the spong-server. When specified they will just generate +a blank HTML page.. +
+
+

+SEE ALSO

+ spong.hosts, spong.conf +

+

+

+AUTHOR

+Ed Hill (ed-hill@uiowa.edu), Unix +System Administrator, The University of Iowa +
Stephen L Johnson (stephen.johnson@mail.state.ar.us) +or (sjohnson@monsters.org), +Unix System Administator, DIS - State of Arkansas +

Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). + +