This document outlines how to use the various tools included in CHIRP.


Chirp.pl:

The main utility provided with this package is chirp.pl.  Use this tool
to generate config files.  Running this program will generate a configuration
on standard output.  It is up to the user to redirect the output into
an appropriately named configuration file.

chirp.pl [-H] -h hostname [-c community] [-p port] [-i file] [-s file]
	-H: This page
	-h: Hostname for SNMP query
	-c: Community for SNMP query
	-p: Port for SNMP query
	-i: ID config file
	-s: Config file with additional site specific commands

The -h parameter is required and specifies the hostname (or IP address)
used to locate the device.

The -c parameter can be used to specify explicitly what SNMP community
name should used in querying the device.  If this parameter is not supplied,
it will default to "public".

The -p parameter can be used to specify explicitly what SNMP port
should be used in querying the device.  If this parameter is not supplied,
it will default to port 161.

The -i parameter is used to specify explicitly the id.cfg file to be used
by CHIRP.  If this is not provided, CHIRP will look in the current directory
for a file named "id.cfg".  If CHIRP is unable to locate this file, the
configuration file generated will be for an "Unknown device" type.

The -s parameter is used to specify additional site specific configuration
definitions to be included in the generated configuration file.  Please
see the samples directory for some examples of site configuration files.


Chirptree.pl:

Chirptree.pl is another utility included to help in mass generation of
configuration trees.  You may need to edit this script to change certain
parameters specific to your setup.  The variables are located near the
top of the file:
	ROOT_DIR = "/home/cricket/cricket-config"
	CHIRP = "./chirp.pl"
	COMPILE = "/home/cricket/cricket/compile"

chirptree.pl [-H] -f filename [-i file] [-q]
	-H: This page
	-f: Filename for Devices
		Format of file is:
		SUBTREE:DEVICE_NAME:HOSTNAME:SNMP_COMMUNITY:SNMP_PORT:SITE_FILE:COMMENT
	-i: ID config file
	-q: quiet mode

Chirptree.pl works by calling chirp.pl for a set of devices and storing the
output into the Cricket configuration tree.  The set of devices is determined
by the file passed to chirptree.pl via the -f parameter.

The file consists of lines containing colon ":" separated fields.  The fields
are specified below:
	SUBTREE
         	The directory structure to be created under ROOT_DIR.
		The created config file will be put under this
		directory in a directory named by DEVICE_NAME in the
		file "Targets".
	DEVICE_NAME      
		A name for the device.  A directory will be created under
		SUBTREE by this name.
	HOSTNAME
		The hostname (or IP address) of the device
	SNMP_COMMUNITY
		An (optional) SNMP community name to be used when querying
		the device.  By default, this will be "public".
	SNMP_PORT
		An (optional) SNMP port to be used.  By default, this will
		be 161.
	SITE_FILE
		An (optional) site.cfg file to be applied to the configuration
		after the configuration is generated.
	COMMENT
		An (optional) comment.  This is not processed.