[mirror_frr.git] / doc / isisd.8.in

.TH IS-IS 8 "25 November 2004" "@PACKAGE_FULLNAME@ IS-IS daemon" "Version @PACKAGE_VERSION@"
.SH NAME
isisd \- an IS-IS routing engine for use with @PACKAGE_FULLNAME@.
.SH SYNOPSIS
.B isisd
[
.B \-dhv
] [
.B \-f
.I config-file
] [
.B \-i
.I pid-file
] [
.B \-P
.I port-number
] [
.B \-A
.I vty-address
] [
.B \-u
.I user
] [
.B \-g
.I group
] [
.B \-M
.I module:options
]
.SH DESCRIPTION
.B isisd
is a routing component that works with the
.B @PACKAGE_FULLNAME@
routing engine.
.SH OPTIONS
Options available for the
.B isisd
command:
.TP
\fB\-d\fR, \fB\-\-daemon\fR
Runs in daemon mode, forking and exiting from tty.
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR 
Specifies the config file to use for startup. If not specified this
option will default to \fB\fI@CFG_SYSCONF@/isisd.conf\fR.
.TP
\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
Specify the group to run as. Default is \fI@enable_group@\fR.
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
When isisd starts its process identifier is written to
\fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
restart isisd.  The default is \fB\fI@CFG_STATE@/isisd.pid\fR.
.TP
\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
Specify the port that the isisd VTY will listen on. This defaults to
2608, as specified in \fB\fI/etc/services\fR.
.TP
\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
Specify the address that the isisd VTY will listen on. Default is all
interfaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
Specify the user to run as. Default is \fI@enable_user@\fR.
.TP
\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
Load a module at startup.  May be specified more than once.
There are currently no such modules for
\fBisisd\fR in the base package.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
.SH FILES
.TP
.BI @CFG_SBIN@/isisd
The default location of the 
.B isisd
binary.
.TP
.BI @CFG_SYSCONF@/isisd.conf
The default location of the 
.B isisd
config file.
.TP
.BI $(PWD)/isisd.log 
If the 
.B isisd
process is config'd to output logs to a file, then you will find this
file in the directory where you started \fBisisd\fR.
.SH WARNING
This man page is intended to be a quick reference for command line
options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
.SH DIAGNOSTICS
The isisd process may log to standard output, to a VTY, to a log
file, or through syslog to the system logs. \fBisisd\fR supports many
debugging options, see the Info file, or the source for details.
.SH "SEE ALSO"
.BR bgpd (8),
.BR ripd (8),
.BR ripngd (8),
.BR ospfd (8),
.BR ospf6d (8),
.BR zebra (8),
.BR vtysh (1)
.SH BUGS
\fBisisd\fR is ALPHA quality at the moment and hasn't any way ready for
production use.

.B isisd
eats bugs for breakfast. If you have food for the maintainers try
.BI @PACKAGE_BUGREPORT@
.SH AUTHORS
See
.BI http://isisd.sourceforge.net
or the Info file for an accurate list of authors.
Commit	Line	Data
	1	.TH IS-IS 8 "25 November 2004" "@PACKAGE_FULLNAME@ IS-IS daemon" "Version @PACKAGE_VERSION@"
	2	.SH NAME
	3	isisd \- an IS-IS routing engine for use with @PACKAGE_FULLNAME@.
	4	.SH SYNOPSIS
	5	.B isisd
	6	[
	7	.B \-dhv
	8	] [
	9	.B \-f
	10	.I config-file
	11	] [
	12	.B \-i
	13	.I pid-file
	14	] [
	15	.B \-P
	16	.I port-number
	17	] [
	18	.B \-A
	19	.I vty-address
	20	] [
	21	.B \-u
	22	.I user
	23	] [
	24	.B \-g
	25	.I group
	26	] [
	27	.B \-M
	28	.I module:options
	29	]
	30	.SH DESCRIPTION
	31	.B isisd
	32	is a routing component that works with the
	33	.B @PACKAGE_FULLNAME@
	34	routing engine.
	35	.SH OPTIONS
	36	Options available for the
	37	.B isisd
	38	command:
	39	.TP
	40	\fB\-d\fR, \fB\-\-daemon\fR
	41	Runs in daemon mode, forking and exiting from tty.
	42	.TP
	43	\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
	44	Specifies the config file to use for startup. If not specified this
	45	option will default to \fB\fI@CFG_SYSCONF@/isisd.conf\fR.
	46	.TP
	47	\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
	48	Specify the group to run as. Default is \fI@enable_group@\fR.
	49	.TP
	50	\fB\-h\fR, \fB\-\-help\fR
	51	A brief message.
	52	.TP
	53	\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
	54	When isisd starts its process identifier is written to
	55	\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
	56	restart isisd. The default is \fB\fI@CFG_STATE@/isisd.pid\fR.
	57	.TP
	58	\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
	59	Specify the port that the isisd VTY will listen on. This defaults to
	60	2608, as specified in \fB\fI/etc/services\fR.
	61	.TP
	62	\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
	63	Specify the address that the isisd VTY will listen on. Default is all
	64	interfaces.
	65	.TP
	66	\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
	67	Specify the user to run as. Default is \fI@enable_user@\fR.
	68	.TP
	69	\fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
	70	Load a module at startup. May be specified more than once.
	71	There are currently no such modules for
	72	\fBisisd\fR in the base package.
	73	.TP
	74	\fB\-v\fR, \fB\-\-version\fR
	75	Print the version and exit.
	76	.SH FILES
	77	.TP
	78	.BI @CFG_SBIN@/isisd
	79	The default location of the
	80	.B isisd
	81	binary.
	82	.TP
	83	.BI @CFG_SYSCONF@/isisd.conf
	84	The default location of the
	85	.B isisd
	86	config file.
	87	.TP
	88	.BI $(PWD)/isisd.log
	89	If the
	90	.B isisd
	91	process is config'd to output logs to a file, then you will find this
	92	file in the directory where you started \fBisisd\fR.
	93	.SH WARNING
	94	This man page is intended to be a quick reference for command line
	95	options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
	96	.SH DIAGNOSTICS
	97	The isisd process may log to standard output, to a VTY, to a log
	98	file, or through syslog to the system logs. \fBisisd\fR supports many
	99	debugging options, see the Info file, or the source for details.
	100	.SH "SEE ALSO"
	101	.BR bgpd (8),
	102	.BR ripd (8),
	103	.BR ripngd (8),
	104	.BR ospfd (8),
	105	.BR ospf6d (8),
	106	.BR zebra (8),
	107	.BR vtysh (1)
	108	.SH BUGS
	109	\fBisisd\fR is ALPHA quality at the moment and hasn't any way ready for
	110	production use.
	111
	112	.B isisd
	113	eats bugs for breakfast. If you have food for the maintainers try
	114	.BI @PACKAGE_BUGREPORT@
	115	.SH AUTHORS
	116	See
	117	.BI http://isisd.sourceforge.net
	118	or the Info file for an accurate list of authors.
	119