Import Upstream version 1.2.2
[quagga-debian.git] / doc / isisd.8
1 .TH IS-IS 8 "25 November 2004" "Quagga IS-IS daemon" "Version 0.97.3"
2 .SH NAME
3 isisd \- an IS-IS routing engine for use with Quagga routing software.
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 .SH DESCRIPTION
28 .B isisd
29 is a routing component that works with the
30 .B Quagga
31 routing engine.
32 .SH OPTIONS
33 Options available for the
34 .B isisd
35 command:
36 .TP
37 \fB\-d\fR, \fB\-\-daemon\fR
38 Runs in daemon mode, forking and exiting from tty.
39 .TP
40 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR 
41 Specifies the config file to use for startup. If not specified this
42 option will likely default to \fB\fI/usr/local/etc/isisd.conf\fR.
43 .TP
44 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
45 Specify the group to run as. Default is \fIquagga\fR.
46 .TP
47 \fB\-h\fR, \fB\-\-help\fR
48 A brief message.
49 .TP
50 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
51 When isisd starts its process identifier is written to
52 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
53 restart isisd.  The likely default is \fB\fI/var/run/isisd.pid\fR.
54 .TP
55 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
56 Specify the port that the isisd VTY will listen on. This defaults to
57 2608, as specified in \fB\fI/etc/services\fR.
58 .TP
59 \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
60 Specify the address that the isisd VTY will listen on. Default is all
61 interfaces.
62 .TP
63 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
64 Specify the user to run as. Default is \fIquagga\fR.
65 .TP
66 \fB\-v\fR, \fB\-\-version\fR
67 Print the version and exit.
68 .SH FILES
69 .TP
70 .BI /usr/local/sbin/isisd
71 The default location of the 
72 .B isisd
73 binary.
74 .TP
75 .BI /usr/local/etc/isisd.conf
76 The default location of the 
77 .B isisd
78 config file.
79 .TP
80 .BI $(PWD)/isisd.log 
81 If the 
82 .B isisd
83 process is config'd to output logs to a file, then you will find this
84 file in the directory where you started \fBisisd\fR.
85 .SH WARNING
86 This man page is intended to be a quick reference for command line
87 options. The definitive document is the Info file \fBQuagga\fR.
88 .SH DIAGNOSTICS
89 The isisd process may log to standard output, to a VTY, to a log
90 file, or through syslog to the system logs. \fBisisd\fR supports many
91 debugging options, see the Info file, or the source for details.
92 .SH "SEE ALSO"
93 .BR bgpd (8),
94 .BR ripd (8),
95 .BR ripngd (8),
96 .BR ospfd (8),
97 .BR ospf6d (8),
98 .BR zebra (8),
99 .BR vtysh (1)
100 .SH BUGS
101 \fBisisd\fR is ALPHA quality at the moment and hasn't any way ready for
102 production use.
103
104 .B isisd
105 eats bugs for breakfast. If you have food for the maintainers try
106 .BI http://bugzilla.quagga.net
107 .SH AUTHORS
108 See
109 .BI http://isisd.sourceforge.net
110 or the Info file for an accurate list of authors.
111