paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 1 | .TH ZEBRA 8 "July 2000" "Zebra" "Version 0.88" |
| 2 | |
| 3 | .SH NAME |
| 4 | zebra \- a routing manager for use with associated components |
| 5 | |
| 6 | .SH SYNOPSIS |
| 7 | .B zebra |
| 8 | [ |
| 9 | .B \-bdhklrv |
| 10 | ] |
| 11 | [ |
| 12 | .B \-f config-file |
| 13 | ] |
| 14 | [ |
| 15 | .B \-i pid-file |
| 16 | ] |
| 17 | [ |
| 18 | .B \-P port-number |
| 19 | ] |
hasso | 6c110e7 | 2003-11-27 13:02:03 +0000 | [diff] [blame] | 20 | [ |
| 21 | .B \-A vty-address |
| 22 | ] |
| 23 | [ |
| 24 | .B \-u user |
| 25 | ] |
| 26 | |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 27 | |
| 28 | .SH DESCRIPTION |
| 29 | .B zebra |
| 30 | is a routing manager that implements the |
| 31 | .B zebra |
| 32 | route engine. |
| 33 | .B zebra |
| 34 | supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, BGP4+, and BGP4-. |
| 35 | |
| 36 | |
| 37 | .SH OPTIONS |
| 38 | |
| 39 | .TP |
| 40 | \fB\-b\fR, \fB\-\-batch\fR |
| 41 | Runs in batch mode, \fBzebra\fR parses its config and exits. |
| 42 | |
| 43 | .TP |
| 44 | \fB\-d\fR, \fB\-\-daemon\fR |
| 45 | Runs in daemon mode, forking and exiting from tty. |
| 46 | |
| 47 | .TP |
| 48 | \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR |
| 49 | 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. |
| 50 | |
| 51 | .TP |
| 52 | \fB\-h\fR, \fB\-\-help\fR |
| 53 | A brief message. |
| 54 | |
| 55 | .TP |
| 56 | \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR |
| 57 | When zebra starts its process idenifier is written to |
| 58 | \fB\fIpid-file\fR. The init system uses the recorded PID to stop or |
| 59 | restart zebra. The likely default is \fB\fI/var/run/zebra.pid\fR. |
| 60 | |
| 61 | .TP |
| 62 | \fB\-k\fR, \fB\-\-keep_kernel\fR |
| 63 | On startup, don't delete self inserted routes. |
| 64 | |
| 65 | .TP |
| 66 | \fB\-l\fR, \fB\-\-log_mode\fR |
| 67 | Turn verbose logging on. |
| 68 | |
| 69 | .TP |
| 70 | \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR |
| 71 | Specify the port that the zebra VTY will listen on. This defaults to |
| 72 | 2602, as specified in \fB\fI/etc/services\fR. |
| 73 | |
| 74 | .TP |
hasso | 6c110e7 | 2003-11-27 13:02:03 +0000 | [diff] [blame] | 75 | \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR |
| 76 | Specify the address that the zebra VTY will listen on. Default is all |
| 77 | intrefaces. |
| 78 | |
| 79 | .TP |
| 80 | \fB\-u\fR, \fB\-\-user \fR\fIuser\fR |
| 81 | Specify the user and group to run as. User and group have to have same |
| 82 | name at the moment. Default is \fIquagga\fR. |
| 83 | |
| 84 | .TP |
paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 85 | \fB\-r\fR, \fB\-\-retain\fR |
| 86 | When the program terminates, retain routes added by \fBzebra\fR. |
| 87 | |
| 88 | .TP |
| 89 | \fB\-v\fR, \fB\-\-version\fR |
| 90 | Print the version and exit. |
| 91 | |
| 92 | |
| 93 | .SH COMMANDS |
| 94 | |
| 95 | \fB table [TABLENO] \fR -- for use with multi-table kernels |
| 96 | |
| 97 | \fB ip route [NETWORK] [GATEWAY] \fR |
| 98 | \fB ipv6 route [NETWORK] [GATEWAY] \fR |
| 99 | |
| 100 | \fB show ip route \fR |
| 101 | \fB show ipv6 route \fR |
| 102 | \fB show interface \fR |
| 103 | \fB show ipforward \fR |
| 104 | \fB show ipv6forward \fR |
| 105 | |
| 106 | .TP |
| 107 | \fB interface [IFNAME] \fR |
| 108 | \fB shutdown \fR |
| 109 | \fB no shutdown \fR |
| 110 | \fB ip address [IP-ADDRESS] \fR |
| 111 | \fB description [DESCRIPTION] \fR |
| 112 | \fB multicast \fR |
| 113 | \fB no multicast \fR |
| 114 | |
| 115 | |
| 116 | .SH FILES |
| 117 | |
| 118 | .TP |
| 119 | .BI /usr/local/sbin/zebra |
| 120 | The default location of the |
| 121 | .B zebra |
| 122 | binary. |
| 123 | |
| 124 | .TP |
| 125 | .BI /usr/local/etc/zebra.conf |
| 126 | The default location of the |
| 127 | .B zebra |
| 128 | config file. |
| 129 | |
| 130 | .TP |
| 131 | .BI $(PWD)/zebra.log |
| 132 | If the |
| 133 | .B zebra |
| 134 | process is config'd to output logs to a file, then you will find this |
| 135 | file in the directory where you started \fBzebra\fR. |
| 136 | |
| 137 | |
| 138 | .SH WARNING |
| 139 | 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. |
| 140 | |
| 141 | |
| 142 | .SH DIAGNOSTICS |
| 143 | The zebra process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. |
| 144 | .B zebra |
| 145 | supports many debugging options, see the Info file, or the source for details. |
| 146 | |
| 147 | |
| 148 | .SH "SEE ALSO" |
| 149 | References to other related man pages: |
| 150 | |
| 151 | ripngd(8), ospfd(8), ospf6d(8), bgpd(8), zebra(8), vtysh(1) |
| 152 | |
| 153 | |
| 154 | |
| 155 | .SH BUGS |
| 156 | .B zebra |
| 157 | eats bugs for breakfast. If you have food for the maintainers try |
| 158 | .BI <bug-zebra@gnu.org> |
| 159 | |
| 160 | |
| 161 | .SH AUTHOR[S] |
| 162 | See <\fBwww.zebra.org\fR>, or the Info file for an accurate list of authors. |
| 163 | |