Merge branch 'Teaman-ND' into Teaman-RT
[tomato.git] / release / src / router / zebra / doc / zebra.8
blob190f4a622c1e061b49375f2e806130967703b8a6
1 .TH ZEBRA 8 "July 2000" "Zebra" "Version 0.88"
3 .SH NAME
4 zebra \- a routing manager for use with associated components
6 .SH SYNOPSIS
7 .B zebra
9 .B \-bdhklrv
12 .B \-f config-file
15 .B \-i pid-file
18 .B \-P port-number
21 .SH DESCRIPTION
22 .B zebra 
23 is a routing manager that implements the 
24 .B zebra
25 route engine.
26 .B zebra 
27 supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, BGP4+, and BGP4-.
30 .SH OPTIONS
32 .TP
33 \fB\-b\fR, \fB\-\-batch\fR
34 Runs in batch mode, \fBzebra\fR parses its config and exits.
36 .TP
37 \fB\-d\fR, \fB\-\-daemon\fR
38 Runs in daemon mode, forking and exiting from tty.
40 .TP
41 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
42 Specifies the config file to use for startup. If not specified this option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
44 .TP
45 \fB\-h\fR, \fB\-\-help\fR
46 A brief message.
48 .TP
49 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
50 When zebra starts its process idenifier is written to
51 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
52 restart zebra.  The likely default is \fB\fI/var/run/zebra.pid\fR.
54 .TP
55 \fB\-k\fR, \fB\-\-keep_kernel\fR
56 On startup, don't delete self inserted routes.
58 .TP
59 \fB\-l\fR, \fB\-\-log_mode\fR
60 Turn verbose logging on.
62 .TP
63 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
64 Specify the port that the zebra VTY will listen on. This defaults to
65 2602, as specified in \fB\fI/etc/services\fR.
67 .TP
68 \fB\-r\fR, \fB\-\-retain\fR 
69 When the program terminates, retain routes added by \fBzebra\fR.
71 .TP
72 \fB\-v\fR, \fB\-\-version\fR
73 Print the version and exit.
76 .SH COMMANDS
78 \fB table [TABLENO] \fR -- for use with multi-table kernels 
80 \fB ip route [NETWORK] [GATEWAY] \fR
81 \fB ipv6 route [NETWORK] [GATEWAY] \fR
83 \fB show ip route \fR
84 \fB show ipv6 route \fR
85 \fB show interface \fR
86 \fB show ipforward \fR
87 \fB show ipv6forward \fR
89 .TP
90 \fB interface [IFNAME] \fR
91 \fB shutdown \fR
92 \fB no shutdown \fR
93 \fB ip address [IP-ADDRESS] \fR
94 \fB description [DESCRIPTION] \fR
95 \fB multicast \fR
96 \fB no multicast \fR
99 .SH FILES
102 .BI /usr/local/sbin/zebra
103 The default location of the 
104 .B zebra
105 binary.
108 .BI /usr/local/etc/zebra.conf
109 The default location of the 
110 .B zebra
111 config file.
114 .BI $(PWD)/zebra.log 
115 If the 
116 .B zebra
117 process is config'd to output logs to a file, then you will find this
118 file in the directory where you started \fBzebra\fR.
121 .SH WARNING
122 This man page is intended as a quick reference for command line options, and for config file commands. The definitive document is the Info file \fBzebra\fR.
125 .SH DIAGNOSTICS
126 The zebra process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. 
127 .B zebra
128 supports many debugging options, see the Info file, or the source for details.
131 .SH "SEE ALSO"
132 References to other related man pages:
134 ripngd(8), ospfd(8), ospf6d(8), bgpd(8), zebra(8), vtysh(1)
138 .SH BUGS
139 .B zebra
140 eats bugs for breakfast. If you have food for the maintainers try 
141 .BI <bug-zebra@gnu.org>
144 .SH AUTHOR[S]
145 See <\fBwww.zebra.org\fR>, or the Info file for an accurate list of authors.