From ff168ecfe045c690c24d5bbc5a3062bf9d64120c Mon Sep 17 00:00:00 2001 From: Tar Committer Date: Fri, 9 Aug 2002 21:59:06 +0000 Subject: Imported from rancid-2.2.2.tar.gz. --- man/env.5.in | 15 ++++++++++++--- man/lg.conf.5.in | 31 +++++++++++++++++++++++-------- man/lg_intro.1.in | 13 +++++++------ man/par.1 | 10 ++++++++-- 4 files changed, 50 insertions(+), 19 deletions(-) (limited to 'man') diff --git a/man/env.5.in b/man/env.5.in index 1050ac7..99366c4 100644 --- a/man/env.5.in +++ b/man/env.5.in @@ -49,11 +49,20 @@ Default: $BASEDIR/CVS Determines which passwords will be filtered from configs. The value may be "NO", "YES", or "ALL" to filter none of the passwords, only those which are reversable or plain-text, or all (plus ssh keys, etc), respectively. -Note that passwords whose value cycles and would produce erroneous diffs -are always filtered (eg: Alteon passwords). Note that a value of "NO" could -be a security issue. .sp Default: YES +.sp +Note: a value of "NO" could be a security issue since diffs are sent via +e-mail. A value of "ALL" is encouraged. +.sp +Note: +.B FILTER_PWDS +does not affect the handling of SNMP community strings. see +.B NOCOMMSTR +below. +.sp +Note: passwords whose value cycles and would produce erroneous diffs +are always filtered (eg: Alteon passwords). .\" .TP .B LIST_OF_GROUPS diff --git a/man/lg.conf.5.in b/man/lg.conf.5.in index cb052f7..b5d5423 100644 --- a/man/lg.conf.5.in +++ b/man/lg.conf.5.in @@ -9,7 +9,8 @@ contains configuration for the looking glass scripts. .PP The syntax is that of .IR perl (1). -It is used to set variables to affect run-time behavior or to locate resources. +It is used to set variables to affect run-time behavior and/or to locate +resources. .\" .SH VARIABLES The following variables are used (alphabetically): @@ -67,7 +68,7 @@ Defines a html image tag () which, if defined, will be included at the top of the looking glass pages. It may contain any html as it is simply handed off to print(). .sp -Example: $LG_IMAGE="\n FOO"; +Example: $LG_IMAGE="\\n FOO"; .\" .TP .B LG_INFO @@ -79,7 +80,8 @@ Example: $LG_INFO="For Support contact webma .\" .TP .B LG_LOG -Defines the fully qualified path name for the log file or the +Defines the fully qualified path name (ie: begins with '/') for the log file +or the .BR syslog (3) facility to use for logging. For syslog, the argument is the lowercase name of a syslog facility (see syslog.h) without the 'LOG_' prefix. @@ -98,12 +100,12 @@ format. It lists the devices that should be available to the looking glass users. Only those devices of supported types and with state 'up' are made available. If not defined and the default file does not exist, the looking glass will compile a list from the router.db files of all the groups present -in rancid, that is a concatenation of $BASEDIR/*/router.db. +in rancid, that is, the list will be a concatenation of $BASEDIR/*/router.db. .sp Default: @prefix@/util/lg/router.db .sp Note that if the concatenation method is used, it may be necessary to alter -the mode of the router.db files in the rancid group directories, since the +the mode of the router.db files in the rancid group directories, since rancid's default umask is 027 (see .BR env (5)). .\" @@ -128,22 +130,35 @@ note that it must include $BASEDIR/bin (see above). .\" .El .\" +.SH ENVIRONMENT +.Bl -tag -width LG_CONF -compact +.TP +.B LG_CONF +Location of +.B lg.conf +file. See the +.IR FILES +section for more information. +.El +.\" .SH ERRORS .B lg.conf is interpreted directly by .IR perl (1), -so its syntax follows that of perl. Errors may produce quite unexpected +so its syntax follows that of perl. Syntax errors may produce quite unexpected results. .SH FILES .Bl -tag -width .BASEDIR/bin/ENV -compact .TP .B $BASEDIR/util/lg/lg.conf Configuration file described here, where $BASEDIR is set at the time that -the rancid package was configured. In this case, $BASEDIR is +the rancid package was configured. In this installation, $BASEDIR is .IR @prefix@ . +.sp .B lg.conf is located by the value of the environment variable LG_CONF, in the CWD -(current working directory), or rancid install directory ($BASEDIR/util/lg). +(current working directory), or rancid install directory ($BASEDIR/util/lg), +in that order. .El .SH SEE ALSO .BR cloginrc (5), diff --git a/man/lg_intro.1.in b/man/lg_intro.1.in index 1af8942..b6ced11 100644 --- a/man/lg_intro.1.in +++ b/man/lg_intro.1.in @@ -18,7 +18,7 @@ The looking glass consists of two CGI scripts, .IR lg.cgi and -.IR lg.form.cgi , +.IR lgform.cgi , and the .BR lg.conf (5) configuration file. @@ -28,12 +28,12 @@ there is an error in the file's syntax or if the file can not be found, error messages will be displayed on standard-error. The Apache http server redirects standard-error to its error log file by default. .PP -lg.form.cgi displays a html form consisting of a list of possible +lgform.cgi displays a html form consisting of a list of possible router commands that can be run and a scrolling list of routers that these commands may be run on. When the form is submitted, lg.cgi is run. .PP -When lg.cgi is run, it begins by performing some basic checks on the +lg.cgi begins by performing some basic checks on the arguments passed to it. If these checks pass, lg.cgi either displays cached data from a previous invocation if that data exists and is within the cache interval or uses @@ -59,6 +59,7 @@ these. See the README file. .BR lg.conf (5) .SH HISTORY Rancid's looking glass is based on Ed Kern's (included by permission, -thanks Ed!), which can be found on http://nitrous.digex.net/. Support -for Junipers, rancid's device login scripts, and additional commands have -been added to the original. +thanks Ed!), which could once be found on http://nitrous.digex.net/ but +has apparently been removed. Support for Juniper and Foundry devices, +use of rancid's device login scripts, and additional commands and checks +have been added to the original. diff --git a/man/par.1 b/man/par.1 index b0f0cee..535246a 100644 --- a/man/par.1 +++ b/man/par.1 @@ -22,7 +22,7 @@ file takes a list of files to run a command on. The first line of each file begins with a colon (:) or a pound-sign (#). If a colon, the remainder of the line is a command to run for each of the subsequent lines. If a pound-sign, -then each subsequent line is command, unless the +then each subsequent line is a command, unless the .B \-c option was specified, in which case it operates as if the argument to .B \-c @@ -60,7 +60,7 @@ The command-line options are as follows: .PP .TP .B \-c -Command to be run on each each of the arguments following the command-line +Command to be run on each of the arguments following the command-line options, when the first line of the input file(s) begin with a pound-sign (#). .\" @@ -91,6 +91,12 @@ Default: 3 .TP .B \-q Quiet mode. Do not log anything. +.B \-q +is mutually exclusive with the +.B \-x +and +.B \-l +options and the option appearing last will take precedence. .\" .TP .B \-x -- cgit