summaryrefslogtreecommitdiffstats
path: root/man/lg_intro.1.in
diff options
context:
space:
mode:
authorTar Committer <tar@ocjtech.us>2001-02-05 17:47:18 +0000
committerTar Committer <tar@ocjtech.us>2001-02-05 17:47:18 +0000
commitb88919bea4b222a616adbdd2b82fc262a14afc8d (patch)
treea75da71b0e2f905f35d2d7cbfd161df97a3d2c63 /man/lg_intro.1.in
parent25c2b7c2c8a333b276c3499bcce004137d4b4fe0 (diff)
downloadrancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.zip
rancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.tar.gz
rancid-b88919bea4b222a616adbdd2b82fc262a14afc8d.tar.xz
Imported from rancid-2.1.tar.gz.rancid-2.1
Diffstat (limited to 'man/lg_intro.1.in')
-rw-r--r--man/lg_intro.1.in64
1 files changed, 64 insertions, 0 deletions
diff --git a/man/lg_intro.1.in b/man/lg_intro.1.in
new file mode 100644
index 0000000..1af8942
--- /dev/null
+++ b/man/lg_intro.1.in
@@ -0,0 +1,64 @@
+.\"
+.hys 50
+.TH "lg_intro" "1" "24 Jan 2001"
+.SH NAME
+lg_intro \- introduction to the looking glass
+.\"
+.SH INTRODUCTION
+The
+.B looking glass
+offers a web based interface to routers to users without their needing
+permission to login to the router. This may be a perfect interface for customer
+support or less savvy folks, and many ISPs have given public access to such
+an interface as a "route server."
+.\"
+.SH DESCRIPTION
+The looking glass consists of two CGI
+.BR perl (1)
+scripts,
+.IR lg.cgi
+and
+.IR lg.form.cgi ,
+and the
+.BR lg.conf (5)
+configuration file.
+.PP
+Both of these scripts begin with reading the configuration file. If
+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
+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
+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
+.BR clogin (1)
+to login to the device and execute the command. The
+results of the command are cached if applicable and displayed for the
+user.
+.\"
+.SH "GETTING STARTED"
+Besides
+.BR lg.conf (5),
+additional instructions for setting up the looking glass can be found
+in the README file under
+.IR @prefix@/util/lg .
+.PP
+Note that the looking glass scripts require a few perl modules not
+included with rancid. Rancid's configure process does not check for
+these. See the README file.
+.\"
+.SH "SEE ALSO"
+.BR cloginrc (5),
+.BR clogin (1),
+.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.