#!@@PERL@@
-
-=head1 NAME
-
-B<spong-ack> - Spong acknowledgment tool
-
-=head1 SYNOPSIS
-
-B<spong-ack> [B<--debug>] [B<--batch>] host services time [message]
-
-B<spong-ack> [B<--debug>] B<--delete> ack-id
-
-=head1 DESCRIPTION
-
-When a spong evet occurs (or will occur), you can use this tool to acknowledge
-that you know that there is a problem. You can provide text that will be seen
-by others looking at the event (via a spong display program). You can specify
-at time limit that the problem will occur. If a problem has been acknowledged, you
-will no longer received notifications of the problem, and the display programs will
-show the status of the service as "blue".
-
-=cut
-
#
# Spong acknowledgment tool. When a spong event occurs (or will occur), you
# can use this tool to acknowledge that you know there is a problem. You can
#!@@PERL@@
-
-=head1 NAME
-
-B<spong-cleanup> - perform nightly mantenance to the spong database
-
-=head1 SYNOPSIS
-
-B<spong-cleanup>
-
-=head1 DESCRIPTION
-
-This program performs routine, regular maintenace of the spong database.
-
-=over
-
-=item
-
-* Cleans out any history older then 7 days. It moves the old history for
-each host into the L<$SPONG_ARCHIVE|spong.conf/"$SPONG_ARCHIVE"> directory. If
-you don't think you would ever want to get at that history, then you can just
-change the script so that it is deleted.
-
-=item
-
-* Removes any acknowledgements that are no longer valid.
-
-=item
-
-* Removes any services that don't seem to be reported any more (if you
-stop monitoring something on a machine - the old entry will still hang around
-and show up as purple).
-
-=back
-
-=cut
-
#
# This program performs nightly maintanence to the spong database.
#
#!@@PERL@@
-
-=head1 NAME
-
-spong-client - report system information to spong server
-
-=head1 SYNOPSIS
-
-B<spong-client> [ B<--debug>|B<-d> I<n> ]
-[ B<--kill>|B<--restart>|B<--nosleep>|B<--norefresh> ] F<config-file>
-
-=head1 DESCRIPTION
-
-This program is run on each Unix machine in which you want
-to monitor local system attributes, and report that information to the
-spong server. It runs one or more configured checks. It then sleeps for
-a time period you have defined in your configuration file and does it all
-again (it actually adds or subtracts a random amount of time - no more
-then 1p% of the total you have specified, to keep clients from syncing
-up and overloading the spong-server).
-
-=cut
-
#
# Spong client monitoring script. This runs various tests locally on a machine
# and sends those results to the Spong server machine where the information
#!@@PERL@@
-
-=head1 NAME
-
-B<spong-message> - send out alerts when there is a problem
-
-=head1 SYNOPSIS
-
-B<spong-message> [B<--debug>] [B<--file> I<filename> | B<--message> I<"detailed
-message text"] I<color> I<host> I<service> I<time> I<message>
-
-B<spong-message> [B<--debug>] B<--color|--status> I<color> B<--host>
-I<hostname> B<--service> I<service> B<--time> I<time> B<--summary> I<"<summary
-message text"> [B<--file> I<filename> | B<--message> I<"detailed message
-text">]
-
-=head1 DESCRIPTION
-
-This program is called by the L<spong-server> to send out alerts. The
-L<spong-server> only makes a quick determination for send out alerts. It's only
-criteria is a change in status of a service. The B<spong-message> make a more
-thorough determination of transmitting the alerts according to the message
-rules defined in the L<spong.messages> configuration file. B<spong-message>
-also has throttling mechanisms to prevent an excessive number of messages from
-being send within a short amount of time.
-
-=cut
-
#
# Spong messaging program. This script gets called when something that spong
# is monitoring goes red. This script then runs through a number of tests
#!@@PERL@@
-
-=head1 NAME
-
-B<spong-network> - report network service informtion to spong server.
-
-=head1 SYNOPSIS
-
-B<spong-network> [B<--debug> I<n>] [B<--kill|--restart|--nosleep|--refresh]
- [F<config_file>]
-
-=head1 DESCRIPTION
-
-This checks network connectivity and network service availabity to various
-machines you want to monitor. It reports the status of the network services
-that it monitors to the spong server. Everything happens again after sleeping
-for a time period you have defined in your configuration file. This program
-typically runs on your spong server machine (although it can be run on any host
-- although I would suggest one with good network connectivity).
-
-=cut
-
#
# Spong network monitoring script. This runs various tests against IP based
# network services (like nntp, smtp, http, pop, etc...) If it can not
#!@@PERL@@
-
-=head1 NAME
-
-B<spong-server> - save status information reported by spong programs
-
-=head1 SYNOPSIS
-
-B<spong-server> [B<--debug> I<n>] [B<--kill|--restart>] [F<config_file>]
-
-=head1 DESCRIPTION
-
-The B<spong-server> is the central core program of Spong. The program received
-status reports from various spong clients (specifically B<spong-network> and
-various B<spong-client> program running). If the message is worth notifying
-someone about, it calls the B<spong-message> program. The status messages
-messages are stored into an internal datebase with significatnt changes being
-logged into a history event log. Queries from spong interface programs (like
-B<spong> and B<www-spong>) seeking to display the data in the B<spong-server)
-database.
-
-=cut
-
#
# This process splits into two processes. The parent process listens at port
# 1970 and responds to update requests. It takes update information coming
#!@@PERL@@
-
-=head1 NAME
-
-B<spong-status> - send vaious type of messages to a spong-server
-
-=head1 SYNOPSIS
-
- spong-status [--help]
- spong-status [--ttl #] (--file name | --message "message text") CMD HOST
- SERVICE COLOR "SUMMARY TEXT"
- spong-status [--cmd cmd] --host name --service name --color color
- --summary text (--message text | -f filename)
- [--ttl seconds]
-
-=head1 DESCRIPTION
-
-This program allows you to creat your own extern spong client programs or
-integrate existing monitoring program or scripts in Spong. B<spong-status>
-hids all of the details of the Spong Client/Server communication protocol.
-
-=cut
-
#
# This program can be used to send Status update messages to the Spong Server
# from shell scripts or other external programs.
#!@@PERL@@
-
-=head1 NAME
-
-B<spong> - character based Spong client interface program
-
-=head1 SYNOPSIS
-
-=begin text
-
- spong [--summary [hostlist] | --problems [hostlist] |
- --history [hostlist] | --host host |
- --services host | --stats host | --config host |
- --info host | --service host:service]
- [ --brief | --standard | --full ]
-
-=end text
-
-=begin html
-
-<b>spong</b> [--summary [hostlist] | --problems [hostlist] | --history
-[hostlist] | --host host | --services host | --stats host
-<br>
-| --config host | --info host | --service host:service ] [--brief | --standard
-| --full ]
-
-=end html
-
-=head1 DESCRIPTION
-
-The B<spong> program interfaces with the B<spong-server> to display the
-collected information; in text format. The B<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 B<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 B<spong-server> 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.
-
-=cut
-
#
# This program is used to display information collected by the spong server to
# simple character based terminals. It provides the same type of interface
#!@@PERL@@
-
-=head1 NAME
-
-B<www-spong-ack> - WWW (CGI) based spong acknowledgment tool
-
-=head1 SYNOPSIS
-
-http://spong-server.my-inc.com/spong/www-spong-ack
-
-=head DESCRIPTION
-
-Then a spong event occurs (or will occur), you can use this tool to acknowledge
-that your know there is a problem. You can provide text that will be seen by others
-looking at the event (via a spong display program). You can specify a time limit
-that the problem will occur. If a probblem has been acknowledged, you will no longer
-receive notifications of the problem, and the spong display programs will show the
-of the service(s) as "blue".
-
-=cut
-
#
# WWW based spong acknowledgment tool. When a spong event occurs (or will
# occur), you can use this tool to acknowledge that you know there is a
#!@@PERL@@
-
-=head1 NAME
-
-B<www-spong> - display spong system status via the web or general static HTML pages
-of system status
-
-=head1 SYNOPSIS
-
-B<www-spong> [
- S<B<--summary> [I<hostlist>] |>
- S<B<--problems> [I<hostlist>] |>
- S<B<--history> [<hostlist>] |>
- S<B<--host> I<host> |>
- S<B<--services> I<host> |>
- S<B<--stats> I<host> |>
- S<B<--config> I<host> |>
- S<B<--info> I< host> |>
- S<B<--service> I<host:service>>
- ]
- S<[--brief | --standard | --full ]>
-
-=head1 DESCRIPTION
-
-The B<www-spong> program interfaces with the spong-server to display the
-collected information in HTML format. B<www-spong> can be run in two modes: as
-a CGI program and from the command line.
-
-When run as a CGI program it does not have to loaded onto the same machine that
-spong-server is runnning. It queries the spong-server through it's query port.
-it will display information via a web page that reloads itself at regular
-intervals. When run with no parameters it created a page with two or three
-frames. In tree frames mode there will be a top title frame spanning the entire
-page thas has an action bar to switch views. The remain frames are displayed
-below. The left frame displays a summary of systems along with their
-associated problems (services that are red). The right panel is a table that
-lists the hosts and services, and the current status is a colored block or an
-icon depending on how spong-server is configured. For further information on
-how to use the web interface see <Users Guide|user-guide>.
-
-When run from a command line, www-spong generates HTML pages that are printed
-to the console. This mode can be used to generate static HTML pages. If
-www-spong is run without any parameters a page that contains a summary display
-for all hosts is generated.
-
-=cut
-
#
# This program is used to display information collected by the spong server to
# people using web based clients. This provides the same type of interface to
projects / spong.git / commitdiff