|
KNOWN.BUGS
| List of known bugs | |
LICENSE
| Big Brother license document | |
README
| Duh | |
README.CHANGES
| All changes should be in here | |
README.INSTALL
| Installation Instructions | |
bin
| Directory where executable prograns live | |
etc
| Administrative settings | |
ext
| Directory where addon programs are installed | |
install
| Files used during installation & sparse documentation | |
runbb.sh
| The mother of all shell scripts. This file gets executed to start
Big Brother. You'll need to set the BBHOME environment variable here.
Arguments are runbb.sh start|stop|restart
| |
src
| This is where the C program source lives | |
tmp
| Temp files live here. You can wipe this out periodically. | |
web
| Programs having to do with web page generation are here | |
www
| Big Brother output goes here. This directory needs to be accessible
from your Web server, since all the BB output lives here. [server] |
The Glorious bin directory
|
bb | The bb client which sends information to a
BB server. The format
of the bb command is: | |
bbd | bbd is the server which processes all incoming bb messages. [server]
| |
bbnet | The bbnet command is used to test TCP ports. It is generally
used by bb-network.sh, but can also be run by hand. Its format is: [server]
| |
touchtime | touchtime creates timestamped files for bb to use.
| |
bb-display.sh | This program is run every BBSLEEP seconds from bb-display.sh, normally every 5 minutes, to generate the BB web page output. [server] |
|
bb-local.sh | This script is run from runbb.sh and does all local tests
including disk, cpu, messages, and processes up and running. [client] |
|
bb-cpu.sh | This script is run from bb-local.sh and runs the CPU test. [client] |
|
bb-disk.sh | This script is run from bb-local.sh and runs the DISK test. [client] |
|
bb-msgs.sh | This script is run from bb-local.sh and runs the messages
file check. [client] |
|
bb-procs.sh | This script is run from bb-local.sh and runs the
process verification test. [client] |
|
bb-network.sh | This script is also run from runbb.sh, but only on the
machine listed as BBNET in the etc/bb-hosts file. For each system, it
tests any protocols listed in the etc/bb-hosts file.[server] |
|
bb-ping.sh | This script is called by bb-network.sh to test connectivity. [server] |
|
bbrun | This script is only used to run programs from runbb.sh. It
loops forever, running the programs given to it as arguments every BBSLEEP
seconds. |
|
bb-mailack.sh | This script can acknowledge an event by e-mail. [server] |
|
sendmsg | This program actually sends the page out via whatever
mechanism is supposed to be used, i.e numeric, email, etc. [server] |
The deeply confusing etc directory
|
| | bb-dftab.DIST | This file is used to set disk space warning and
paging values on a machine by machine basis. It is only necessary
if you need to change the default warning and paging values of 90% and 95%.
It must be renamed to
bb-dftab, and consists of a sequence of lines of the format:
[hostname]:filesystem:warning-percent:panic-percent
i.e. the line
/usr:92:97
would tell Big Brother to send a warning (yellow) when /usr was 92% full, and
an alert (red) when the /usr reached 97% full. Similarly, you can use this
file to test paging by assigning very low values to filesystems, i.e.:
www.maclawran.ca:/:1:2
is almost certain to generate a red dot on screen, and a page. It is only
valid if the host is www.maclawran.ca. [client]
| |
bb-hosts | The bb-hosts file is the center of each BB instance.
Click here for more info |
|
bb-proctab.DIST | This file is used to set processes to check for
on a system by system basis, instead of editing PROCS and PAGEPROCS on
every system. The format is:
[host]:proc list for yellow : proc list for red
This file must be renamed to bb-proctab to take effect. [client]
|
|
bb-cputab.DIST | This file is used to set CPU threshold values
on a system by system basis, instead of editing CPUWARN and CPUPANIC on
every system. The format is:
[host]: misc settings : cpu threshold for yellow : cpu threshold for yellow for red
This file must be renamed to bb-cputab to take effect. [client]
|
|
bb-msgstab.DIST | This file is used to define keyword(s)
to look for when checking the messages (or log) files.
This is done on a system by system basis, instead of
editing PAGEMSG, MSGS and IGNMSGS on every system. The format is:
[host]: misc settings : log filename(s) : yellow keyword(s) : red keyword(s) : ignore strings
This file must be renamed to bb-msgstab to take effect. [client]
|
|
bb-bbexttab.DIST | This file is used to define the various
external scripts to execute on a local system.
This is done on a system by system basis, instead of
editing BBEXT on every system. The format is:
[host]: misc settings : external script(s)
This file must be renamed to bb-bbexttab to take effect.
|
|
bbchkcfg.sh | Program to check whether variables are
set correctly for you BB installation. | |
bbchkhosts.sh | Program to check whether your bb-hosts file
is correctly formatted. |
bbdef.sh
bbdef-client.sh
bbdef-server.sh | These files contain most of the important setting
used by BB
|
bbinc.sh
bbinc-client.sh
bbinc-server.sh | This file contains things less often changed, however,
some of the display variables live here, including MKBBFONTROW and friends.
This script sets up the internal environment variables BB needs to run.
Be very careful if you decide to mess around in here. |
|
bbsys.local | This file contains local system overrides for some
command line locations, should they differ from the default. | |
bbsys.sh | Sets variables containing the full pathname of most
of the commands BB needs to use. | |
bbwarnrules.cfg | Rules and recipients for BB paging. [server] |
|
bbwarnsetup.cfg | Configuration for the notification feature. [server] | |
numeric-k6.scr | Script to use for kermit version 6 numeric paging. [server] |
|
numeric.scr | Script to use for kermit paging. Generally pre-version 6. [server] |
|
security.DIST | This file is used to control who can send messages
to your bbd process. This file must renamed to security and its format
is one IP address per line, i.e.
123.123.123.123
234.234.234.0
The first entry allows the IP address 123.123.123.123 to connect,
and the second, any machine from the 234.234.234.* subnet. [server]
|
|
sms.scr | SMS script for use with kermit. Used in Europe.
Read install/README.SMS for more information. [server] |
The truly useful ext directory
|
| | ext-proto | Sample external script demonstrating how BB can
be used to send any sort of data to a BB display. |
The boring install directory
|
| |
bbclient | Use this script to create installable tarballs for
systems with the SAME OS, to be installed in the SAME DIRECTORY.
Format: [client]
bbclient client-name-as-listed-in-bb-hosts
| |
bbconfig | Run this to configure your instance of BB for your
operating system. Format:
where OS-TYPE is one of: bsdi sco3 sco freebsd solaris hpux9
hpux linux sunos netbsd osf osf1 ultrix irix unixware redhat redhatES aix dynix
debian dgux. Note that this will overwrite previous values. | |
bbsys.* | File containing the location for all commands required
by BB for a given operating system. This file is copied to bbsys.local
as part of the installation process. |
The worderful src directory
|
| | Makefile | Makefile controls the compilation of BB | |
README | The README file contains details that could be helpful
if you're having trouble compiling BB, or if you're moving BB to a new
platform. |
| bb.c | Source code to the bb client program |
| bb.h | Include file with standard definitions |
| bbd.c | Source code to the bbd daemon program [server] |
| bbnet.c | Source code to the bbnet port testing program [server] |
| touchtime.c | Source code to the touchtime program used to create and
control timestamps on files. |
| bbpage.c | Handles the notification part [server] |
| bbrun.c | Launches scripts and programs |
| bbstat.c | Gathers statistics for reporting [server] |
| dumphostsvc.c | Generate HTML code to display event status [server] |
The essential web directory [server]
|
| | bb-ack.sh | Program used to send acknowledgements via the
webpage interface. BBHOME must be set, and this program must
be installed in your cgi-bin directory for online acks to work.
| |
bb-hist.sh | Program to generate history graph.
BBHOME must be set, and this program must be installed in your
cgi-bin directory in order to work. | |
bb-histlog.sh | This program is called when you click
on an individual status log from the history page. BBHOME
must be set, etc, etc. | |
bb-hostsvc.sh | This program is called when you have defined
DYNAMIC output for HTML status logs.. |
| bb-rep.sh | This program is executed when you want
to view availability statistics for all status. |
| bb-report.sh | This program is executed by bb-rep.sh
to view availability statistics for all status. |
| bb-replog.sh | This program is executed when you want
to view availability statistics for a single status. BBHOME
must be set, yadda, yadda, yadda. |
|
bb_header | Header prepended to the bb.html web page | |
bb_footer | Footer appended to the bb.html web page | |
bb2_header | Header prepended to the bb2.html web page | |
bb2_footer | Footer appended to the bb2.html web page | |
hist_header | Header prepended to history pages | |
hist_footer | Footer appened to history pages | |
histlog_header | Header appened to historical ststus pages | |
histlog_footer | Footer appended to historical status pages | |
hostsvc_header | Header prepended to HTML status reports | |
hostsvc_footer | Footer appended to HTML status reports | |
bbrep_header | Header prepended to availability reports | |
bbrep_footer | Footer appended to availability reports | |
replog_header | Header prepended to individual availability reports | |
replog_footer | Footer appended to individual availability reports | |
mkbb.bkg | Program to determine the background color for a BB page or subpage | |
mkbb.cols | Program to determine the column headings for a given table | |
mkbb.comp | Program to determine the column headings in use for a given table. Used for group-compress headings. | |
mkbb.page | Program to process bb subpages. | |
mkbb.sh | Program that creates the main BB web page, bb.html and availability reports | |
mkbb2.sh | Program that creates the summary BB web page, bb2.html |
|
mkbbwml.sh | Program that creates the summary BB web pages, in WML for WAP enabled devices |
The prolific www directory [server]
|
| | acks | Directory where ack information is stored |
| gifs | Directory where BB images are stored | |
help | Directory containing online help text. |
| html | HTML status reports | |
index.html | File link pointing to bb.html |
| notes | Notes directory used for system information. |
The surprising bbvar directory [server]
|
| | acks | Directory where ack information is stored |
| data | Data directory used for when using the data message type. |
| hist | Directory containing history data |
| histlogs | Directory containing all status changes, by machine |
| logs | Raw status reports, used for processing |
|
