openpkg
/
openpkg-packages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
73016 Commits
1 Branch
2 Tags
575 MiB
 
 
 
 
 
 
Tree: e0ee7e84a2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e0ee7e84a2'
${ noResults }
openpkg-packages/gated/gdc.8

425 lines
15 KiB
Raw Blame History

.\"
.\" This file automatically generated from ../doc/operation_guide/gdc.html by
.\" `html -Tman ../doc/operation_guide/gdc.html'
.\"
.\"
.\" Public Release 3
.\"
.\" $Id: gdc.8,v 1.2 1997/07/17 22:40:49 chopps Exp $
.\"
.\" ------------------------------------------------------------------------
.\"
.\" Copyright (c) 1996, 1997 The Regents of the University of Michigan
.\" All Rights Reserved
.\"
.\" Royalty-free licenses to redistribute GateD Release
.\" 3 in whole or in part may be obtained by writing to:
.\"
.\" Merit GateDaemon Project
.\" 4251 Plymouth Road, Suite C
.\" Ann Arbor, MI 48105
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
.\" EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE REGENTS OF THE
.\" UNIVERSITY OF MICHIGAN AND MERIT DO NOT WARRANT THAT THE
.\" FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR
.\" THAT OPERATION WILL BE UNINTERRUPTED OR ERROR FREE. The Regents of the
.\" University of Michigan and Merit shall not be liable for
.\" any special, indirect, incidental or consequential damages with respect
.\" to any claim by Licensee or any third party arising from use of the
.\" software. GateDaemon was originated and developed through release 3.0
.\" by Cornell University and its collaborators.
.\"
.\" Please forward bug fixes, enhancements and questions to the
.\" gated mailing list: gated-people@gated.merit.edu.
.\"
.\" ------------------------------------------------------------------------
.\"
.\" Copyright (c) 1990,1991,1992,1993,1994,1995 by Cornell University.
.\" All rights reserved.
.\"
.\" THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
.\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\" GateD is based on Kirton's EGP, UC Berkeley's routing
.\" daemon (routed), and DCN's HELLO routing Protocol.
.\" Development of GateD has been supported in part by the
.\" National Science Foundation.
.\"
.\" ------------------------------------------------------------------------
.\"
.\" Portions of this software may fall under the following
.\" copyrights:
.\"
.\" Copyright (c) 1988 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are
.\" permitted provided that the above copyright notice and
.\" this paragraph are duplicated in all such forms and that
.\" any documentation, advertising materials, and other
.\" materials related to such distribution and use
.\" acknowledge that the software was developed by the
.\" University of California, Berkeley. The name of the
.\" University may not be used to endorse or promote
.\" products derived from this software without specific
.\" prior written permission. THIS SOFTWARE IS PROVIDED
.\" ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
.\" INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.TH GDC 8 "1994/03/16 21:39:05 UTC" "Release 3.5" "Merit GateDaemon Project"
.SH "NAME"
\fBgdc\fP - operational user interface for \fBgated (8)\fP
.SH "SYNOPSIS"
\fBgdc\fP
[ \fB-q\fP ]
[ \fB-n\fP ]
[ \fB-c\fP \fIcoresize\fP ]
[ \fB-f\fP \fIfilesize\fP ]
[ \fB-m\fP \fIdatasize\fP ]
[ \fB-s\fP \fIstacksize\fP ]
[ \fB-t\fP \fIseconds\fP ]
\fIcommand\fP
.SH "DESCRIPTION"
\fBGdc\fP provides a user-oriented interface for the operation of the
\fBgated (8)\fP
routing daemon. It provides support for starting and
stopping the daemon, for the delivery of signals to manipulate the
daemon when it is operating, for the maintenance and syntax checking
of configuration files, and for the production and removal of state dumps
and core dumps.
\fBGdc\fP
can reliably determine
\fIgated\fP's
running state and produces a reliable
exit status when errors occur, making it advantageous for use in
shell scripts which manipulate
\fIgated\fP.
Commands executed using
\fBgdc\fP
and, optionally, error messages produced by the execution of those
commands, are logged via the same
\fBsyslogd (8)\fP
facility which
\fIgated\fP
itself uses, providing an audit trail of operations performed on
the daemon.
If installed as a setuid root program
\fBgdc\fP
will allow non-root users who are members of a trusted group (by
default the
\fBgdmaint\fP
group) to manipulate the routing daemon while denying access
to others. The name of the user is logged along via
\fBsyslogd (8)\fP
along with an indication of each command executed, for audit purposes.
The command-line options are:
.IP "\fB-n\fP"
Run without changing the kernel forwarding table. Useful for
testing, and when operating as a route server which does no
forwarding.
.IP "\fB-q\fP"
Run quietly. With this option informational messages which are
normally printed to the standard output are suppressed and error
messages are logged via \fBsyslogd (8)\fP instead of being
printed to the standard error output. This is often convenient
when running \fBgdc\fP from a shell script.
.IP "\fB-t\fP \fIseconds\fP"
Specifies the time in seconds which \fBgdc\fP will
spend waiting for \fIgated\fP to complete certain operations,
in particular at termination and startup. By default this value
is set to 10 seconds.
.PP
These additional command-line options may be present, depending on the
options used to compile \fBgdc\fP:
.IP "\fB-c\fP \fIcoresize\fP"
Sets the maximum size of a core dump a \fIgated\fP started
with \fBgdc\fP will produce. Useful on systems where
the default maximum core dump size is too small for
\fIgated\fP to produce a full core dump on errors.
.IP "\fB-f\fP \fIfilesize\fP"
Sets the maximum file size a \fIgated\fP started with
\fBgdc\fP will produce. Useful on systems where the
default maximum file dump size is too small for \fIgated\fP to
produce a full state dump when requested.
.IP "\fB-m\fP \fIdatasize\fP"
Sets the maximum size of the data segment of a \fIgated\fP
started with \fBgdc\fP. Useful on systems where the
default data segment size is too small for \fIgated\fP to run.
.IP "\fB-s\fP \fIstacksize\fP"
Sets the maximum size of stack of a \fIgated\fP started with
\fBgdc\fP. Useful on systems where the default maximum
stack size is too small for \fIgated\fP to run.
.PP
The following commands cause signals to be delivered to \fIgated\fP
for various purpose:
.IP "\fBCOREDUMP\fP" 10
Sends an abort signal to \fIgated\fP, causing it to terminate with a core dump.
.IP "\fBdump\fP"
Signal \fIgated\fP to dump its current state into the file
\fI/usr/tmp/gated_dump\fP.
.IP "\fBinterface\fP"
Signal \fIgated\fP to recheck the interface configuration.
\fIgated\fP normally does this periodically in any event, but
the facility can be used to force the daemon to check interface
status immediately when changes are known to have occured.
.IP "\fBKILL\fP"
Cause \fIgated\fP to terminate ungracefully. Normally useful
when the daemon has hung.
.IP "\fBreconfig\fP"
Signal \fIgated\fP to reread its configuration file,
reconfiguring its current state as appropriate.
.IP "\fBterm\fP"
Signal \fIgated\fP to terminate after shutting down all
operating routing protocols gracefully. Executing this command a
second time should cause \fIgated\fP to terminate even if some
protocols have not yet fully shut down.
.IP "\fBtoggletrace\fP"
If \fIgated\fP is currently tracing to a file, cause tracing
to be suspended and the trace file to be closed. If
\fIgated\fP tracing is current suspended, cause the trace file
to be reopenned and tracing initiated. This is useful for moving
trace files.
.PP
By default \fIgated\fP obtains its configuration from a file
normally named \fI/etc/gated.config\fP.
The \fIgdc\fP program also maintains several other versions of the
configuration file, in particular named:
.IP "\fI/etc/gated.conf+\fP" 10
The \fInew\fP configuration file. When \fBgdc\fP
is requested to install a new configuration file, this file is
renamed \fI/etc/gated.conf\fP.
.IP "\fI/etc/gated.conf-\fP"
The \fIold\fP configuration file. When \fBgdc\fP
is requested to install a new configuration file, the previous
\fI/etc/gated.conf\fP is renamed to this name.
.IP "\fI/etc/gated.conf--\fP"
The \fIreally old\fP configuration file. \fBGdc\fP
retains the previous \fIold\fP configuration file under this
name.
.PP
The following commands perform operations related to configuration files:
.IP "\fBcheckconf\fP" 10
Check \fI/etc/gated.conf\fP for syntax errors. This is
usefully done after changes to the configuration file but before
sending a \fBreconfig\fP signal to the currently
running \fIgated\fP, to ensure that there are no errors in the
configuration which would cause the running \fIgated\fP to
terminate on reconfiguration. When this command is used,
\fBgdc\fP issues an informational message indicating
whether there were parse errors or not, and if so saves the error
output in a file for inspection.
.IP "\fBchecknew\fP"
Like \fBcheckconf\fP except that the \fInew\fP
configuration file, \fI/etc/gated.conf+\fP, is checked
instead.
.IP "\fBnewconf\fP"
Move the \fI/etc/gated.conf+\fP file into place as
\fI/etc/gated.conf\fP, retaining the older versions of the
file as described above. \fBGdc\fP will decline to do
anything when given this command if the \fInew\fP
configuration file doesn't exist or otherwise looks suspect.
.IP "\fBbackout\fP"
Rotate the configuration files in the \fInewer\fP direction,
in effect moving the \fIold\fP configuration file to
\fI/etc/gated.conf\fP. The command will decline to perform the
operation if \fI/etc/gated.conf-\fP doesn't exist or is zero
length, or if the operation would delete an existing, non-zero
length \fI/etc/gated.conf+\fP file.
.IP "\fBBACKOUT\fP"
Perform a \fBbackout\fP operation even if
\fI/etc/gated.conf+\fP exists and is of non-zero length.
.IP "\fBmodeconf\fP"
Set all configuration files to mode 664, owner root, group
gdmaint. This allows a trusted non-root user to modify the
configuration files.
.IP "\fBcreateconf\fP"
If \fI/etc/gated.conf+\fP does not exist, create a zero length
file with the file mode set to 664, owner root, group gdmaint.
This allows a trusted non-root user to install a new
configuration file.
.PP
The following commands provide support for starting and stopping
\fIgated\fP, and for determining its running state:
.IP "\fBrunning\fP" 10
Determine if \fIgated\fP is currently running. This is done
by checking to see if \fIgated\fP has a lock on the file
containing its pid, if the pid in the file is sensible and if
there is a running process with that pid. Exits with zero status
if \fIgated\fP is running, non-zero otherwise.
.IP "\fBstart\fP"
Start \fIgated\fP. The command returns an error if
\fIgated\fP is already running. Otherwise it executes the
\fIgated\fP binary and waits for up to the delay interval (10
seconds by default, as set with the \fB-t\fP option
otherwise) until the newly started process obtains a lock on the
pid file. A non-zero exit status is returned if an error is
detected while executing the binary, or if a lock is not obtained
on the pid file within the specified wait time.
.IP "\fBstop\fP"
Stop \fIgated\fP, gracefully if possible, ungracefully if not.
The command returns an error (with non-zero exit status) if
\fIgated\fP is not currently running. Otherwise it sends a
terminate signal to \fIgated\fP and waits for up to the delay
interval (10 seconds by default, as specified with the
\fB-t\fP option otherwise) for the process to exit.
Should \fIgated\fP fail to exit within the delay interval it
is then signaled again with a second terminate signal. Should it
fail to exit by the end of the second delay interval it is
signalled for a third time with a kill signal. This should force
immediate termination unless something is very broken. The
command terminates with zero exit status when it detects that
\fIgated\fP has terminated, non-zero otherwise.
.IP "\fBrestart\fP"
If \fIgated\fP is running it is terminated via the same
procedure as is used for the \fBstop\fP command above.
When the previous \fIgated\fP terminates, or if it was not
running prior to command execution, a new \fIgated\fP process is
executed using the procedures described for the
\fBstart\fP command above. A non-zero exit status is
returned if any step in this procedure appears to have failed.
.PP
The following commands allow the removal of files created by the
execution of some of the commands above:
.IP "\fBrmcore\fP" 10
Removes any existing \fIgated\fP core dump file.
.IP "\fBrmdump\fP"
Removes any existing \fIgated\fP state dump file.
.IP "\fBrmparse\fP"
Removes the parse error file generated when a
\fBcheckconf\fP or \fBchecknew\fP command
is executed and syntax errors are encountered in the
configuration file being checked.
.PP
.SH "FILES"
Many of default filenames listed below contain the string %s, which is
replaced by the name with which gated is invoked. Normally this is
\fIgated\fP, but if invoked as \fIgated-test\fP,
\fBgated\fP will by default look for
\fI/etc/gated-test.conf\fP. These paths may all be changed at
compilation time.
.IP "\fI/etc/gated\fP" 10
the \fIgated\fP binary. Another popular location is
\fI/usr/local/sbin/gated\fP.
.IP "\fI/etc/gated.conf\fP"
current \fIgated\fP configuration file.
.IP "\fI/etc/gated.conf+\fP"
newer configuration file.
.IP "\fI/etc/gated.conf-\fP"
older configuration file
.IP "\fI/etc/gated.conf--\fP"
much older configuration file
.IP "\fI/etc/gated.pid\fP"
where \fIgated\fP stores its pid, the default is
\fI/etc/%s.pid\fP. Another popular location is
\fI/var/run/%s.pid\fP.
.IP "\fI/usr/tmp/gated_dump\fP"
\fIgated\fP's state dump file, the default is
\fI/usr/tmp/%s_dump\fP. Another popular location is
\fI/var/tmp/%s_dump\fP.
.IP "\fI/usr/tmp/gated_parse\fP"
where config file parse errors go, the default is
\fI/usr/tmp/%s_parse\fP. Another popular location is
\fI/var/tmp/%s_parse\fP.
.IP "\fI/usr/tmp\fP"
where \fIgated\fP drops its core file. Another popular
location is \fI/var/tmp\fP. The core file is usually
\fIcore\fP, but some systems use \fIcore.gated\fP.
.PP
.SH "AUTHOR"
.br
\fIDennis Ferguson <dennis@ans.net>\fP
.SH "SEE ALSO"
\fBgated (8)\fP,
\fBospf_monitor (8)\fP,
\fBripquery (8)\fP,
\fBrouted (8)\fP,
\fBroute (8)\fP
\fBsyslog (8)\fP
.br
\fBGateD Documentation\fP
.br
\fBGateD Configuration Guide\fP
.SH "BUGS"
Many commands only work when \fIgated\fP is installed in the system
directory it was configured with.
There is not yet any way to tell \fBgdc\fP about
systems which name their core dump other than \fIcore\fP
(\fIcore.gated\fP is a less common possibility).
.SH "COPYRIGHT INFORMATION"
Copyright (c) 1996, 1997 The Regents of the University of Michigan
All Rights Reserved
License to use, copy, modify, and distribute this software and its
documentation can be obtained from Merit at the University of Michigan.
This package and associated documentation is Copyright (c)
1990,1991,1992,1993,1994,1995 Cornell University., all rights reserved.
This software contains code that is Copyright (c) 1988 Regents of the
University of California., all rights reserved.;