From b88919bea4b222a616adbdd2b82fc262a14afc8d Mon Sep 17 00:00:00 2001 From: Tar Committer Date: Mon, 5 Feb 2001 17:47:18 +0000 Subject: Imported from rancid-2.1.tar.gz. --- man/lg.conf.5.in | 129 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 man/lg.conf.5.in (limited to 'man/lg.conf.5.in') diff --git a/man/lg.conf.5.in b/man/lg.conf.5.in new file mode 100644 index 0000000..fe7bdc7 --- /dev/null +++ b/man/lg.conf.5.in @@ -0,0 +1,129 @@ +.\" +.hys 50 +.TH "lg.conf" "5" "22 Jan 2001" +.SH NAME +lg.conf \- looking glass configuration file +.SH DESCRIPTION +.B lg.conf +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. +.\" +.SH VARIABLES +The following variables are used (alphabetically): +.Bl -tag -width flag +.\" +.TP +.B LG_AS_REG +*** not implemented. +.\" +.TP +.B LG_CACHE_DIR +Sets the location of the cache directory. The looking glass uses this +to hold lock files, log files, and output from cached commands. +.sp +Default: ./tmp +.sp +Note that the default is relative to the directory where +.IR lg.cgi +runs in the server's document root (eg: /usr/local/www/data/lg/tmp). +.\" +.TP +.B LG_CACHE_TIME +Sets the number of seconds that the looking glass should cache output from +commands that tend to produce a lot of output, such as 'show ip bgp +dampened-paths'. +.sp +Default: 600 +.\" +.TP +.B LG_CLOGINRC +Defines the +.BR cloginrc (5) +that the looking glass should use. The path may be relative to the directory +where the CGI scripts run in the server's document root. +.sp +Default: @prefix@/.cloginrc +.sp +Note that the .cloginrc must be readable by the user or group that will be +running the CGI and that +.BR clogin (1) +will not allow a world readable +.IR .cloginrc . +The user is normally that of the http server (httpd). +.\" +.TP +.B LG_IMAGE +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"; +.\" +.TP +.B LG_LOG +Defines the fully qualified path name 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. +.sp +Example: local0 +.sp +Default: $LG_CACHE_DIR/lg.log +.\" +.TP +.B LG_ROUTERDB +Sets the location for the +.IR router.db +file in rancid's +.BR router.db (5) +format. It lists the devices that should be available to the looking glass +users. Only those devices of supported types and with status '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. +.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 +default umask is 027 (see +.BR env (5)). +.\" +.TP +.B LG_SINGLE +*** not implemented. +.\" +.TP +.B PATH +Is a colon separate list of directory pathnames in the the file system +where rancid's login scripts, +.IR clogin (1) +etc. ) +and programs needed within these, such as +.IR telnet (1), +are located. +Its value is set by configure. Should it be necessary to modify PATH, +note that it must include $BASEDIR/bin (see above). +.\" +.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 +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 +.IR @prefix@ . +.El +.SH SEE ALSO +.BR cloginrc (5), +.BR lg_intro (1) -- cgit