blob: 8f830152f57fadc15767d5198735f5b3715f375d [file] [log] [blame]
hasso246c1352004-08-10 12:00:34 +00001.TH ZEBRA 8 "10 August 2004" "Zebra daemon" "Version 0.96.5"
paul718e3742002-12-13 20:15:29 +00002.SH NAME
hasso246c1352004-08-10 12:00:34 +00003zebra \- a routing manager for use with associated Quagga components.
paul718e3742002-12-13 20:15:29 +00004.SH SYNOPSIS
5.B zebra
6[
7.B \-bdhklrv
hasso246c1352004-08-10 12:00:34 +00008] [
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
paul718e3742002-12-13 20:15:29 +000023]
paul718e3742002-12-13 20:15:29 +000024.SH DESCRIPTION
25.B zebra
26is a routing manager that implements the
27.B zebra
28route engine.
29.B zebra
hasso246c1352004-08-10 12:00:34 +000030supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.
paul718e3742002-12-13 20:15:29 +000031.SH OPTIONS
hasso246c1352004-08-10 12:00:34 +000032Options available for the
33.B zebra
34command:
paul718e3742002-12-13 20:15:29 +000035.TP
36\fB\-b\fR, \fB\-\-batch\fR
37Runs in batch mode, \fBzebra\fR parses its config and exits.
paul718e3742002-12-13 20:15:29 +000038.TP
39\fB\-d\fR, \fB\-\-daemon\fR
40Runs in daemon mode, forking and exiting from tty.
paul718e3742002-12-13 20:15:29 +000041.TP
42\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
43Specifies the config file to use for startup. If not specified this option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
paul718e3742002-12-13 20:15:29 +000044.TP
45\fB\-h\fR, \fB\-\-help\fR
46A brief message.
paul718e3742002-12-13 20:15:29 +000047.TP
48\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
49When zebra starts its process idenifier is written to
50\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
51restart zebra. The likely default is \fB\fI/var/run/zebra.pid\fR.
paul718e3742002-12-13 20:15:29 +000052.TP
53\fB\-k\fR, \fB\-\-keep_kernel\fR
54On startup, don't delete self inserted routes.
paul718e3742002-12-13 20:15:29 +000055.TP
56\fB\-l\fR, \fB\-\-log_mode\fR
57Turn verbose logging on.
paul718e3742002-12-13 20:15:29 +000058.TP
59\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
60Specify the port that the zebra VTY will listen on. This defaults to
612602, as specified in \fB\fI/etc/services\fR.
paul718e3742002-12-13 20:15:29 +000062.TP
hasso6c110e72003-11-27 13:02:03 +000063\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
64Specify the address that the zebra VTY will listen on. Default is all
65intrefaces.
hasso6c110e72003-11-27 13:02:03 +000066.TP
67\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
68Specify the user and group to run as. User and group have to have same
69name at the moment. Default is \fIquagga\fR.
hasso6c110e72003-11-27 13:02:03 +000070.TP
paul718e3742002-12-13 20:15:29 +000071\fB\-r\fR, \fB\-\-retain\fR
72When the program terminates, retain routes added by \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +000073.TP
74\fB\-v\fR, \fB\-\-version\fR
75Print the version and exit.
paul718e3742002-12-13 20:15:29 +000076.SH FILES
paul718e3742002-12-13 20:15:29 +000077.TP
78.BI /usr/local/sbin/zebra
79The default location of the
80.B zebra
81binary.
paul718e3742002-12-13 20:15:29 +000082.TP
83.BI /usr/local/etc/zebra.conf
84The default location of the
85.B zebra
86config file.
paul718e3742002-12-13 20:15:29 +000087.TP
88.BI $(PWD)/zebra.log
89If the
90.B zebra
91process is config'd to output logs to a file, then you will find this
92file in the directory where you started \fBzebra\fR.
paul718e3742002-12-13 20:15:29 +000093.SH WARNING
hasso246c1352004-08-10 12:00:34 +000094This man page is intended to be a quick reference for command line
95options. The definitive document is the Info file \fBQuagga\fR.
paul718e3742002-12-13 20:15:29 +000096.SH DIAGNOSTICS
hasso246c1352004-08-10 12:00:34 +000097The zebra process may log to standard output, to a VTY, to a log
98file, or through syslog to the system logs. \fBzebra\fR supports many
99debugging options, see the Info file, or the source for details.
paul718e3742002-12-13 20:15:29 +0000100.SH "SEE ALSO"
hasso246c1352004-08-10 12:00:34 +0000101.BR bgpd (8),
102.BR ripd (8),
103.BR ripngd (8),
104.BR ospfd (8),
105.BR ospf6d (8),
106.BR isisd (8),
107.BR vtysh (1)
paul718e3742002-12-13 20:15:29 +0000108.SH BUGS
109.B zebra
hasso246c1352004-08-10 12:00:34 +0000110eats bugs for breakfast. If you have food for the maintainers try
hasso2f04e672004-02-20 18:53:22 +0000111.BI http://bugzilla.quagga.net
hasso246c1352004-08-10 12:00:34 +0000112.SH AUTHORS
113See
114.BI http://www.zebra.org
115and
116.BI http://www.quagga.org
117or the Info file for an accurate list of authors.
paul718e3742002-12-13 20:15:29 +0000118