Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / 501ba490846e87e6fd5bfea05c31dce1777915b9 / . / doc / ospfd.8
blob: af5a83ab9368f48d85e3082b9020670fdce6484c [file] [log] [blame]
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]1.TH OSPFD 8 "10 August 2004" "Quagga OSPFv2 daemon" "Version 0.96.5"
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]2.SH NAME
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]3ospfd \- an OSPFv2 routing engine for use with Quagga routing software.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]4.SH SYNOPSIS
5.B ospfd
6[
7.B \-dhlv
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]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
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]23]
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]24.SH DESCRIPTION
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]25.B ospfd
26is a routing component that works with the
27.B Quagga
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]28routing engine.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]29.SH OPTIONS
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]30Options available for the
31.B ospfd
32command:
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]33.TP
34\fB\-d\fR, \fB\-\-daemon\fR
35Runs in daemon mode, forking and exiting from tty.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]36.TP
37\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
38Specifies the config file to use for startup. If not specified this
39option will likely default to \fB\fI/usr/local/etc/ospfd.conf\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]40.TP
41\fB\-h\fR, \fB\-\-help\fR
42A brief message.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]43.TP
44\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
45When ospfd starts its process idenifier is written to
46\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
47restart ospfd. The likely default is \fB\fI/var/run/ospfd.pid\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]48.TP
49\fB\-l\fR, \fB\-\-log_mode\fR
50Turn verbose logging on.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]51.TP
52\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
53Specify the port that the ospfd VTY will listen on. This defaults to
542604, as specified in \fB\fI/etc/services\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]55.TP
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]56\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
57Specify the address that the ospfd VTY will listen on. Default is all
58intrefaces.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]59.TP
60\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
61Specify the user and group to run as. User and group have to have same
62name at the moment. Default is \fIquagga\fR.
hasso6c110e72003-11-27 13:02:03 +0000[diff] [blame]63.TP
hassoc3abdb72004-10-11 16:27:03 +0000[diff] [blame]64\fB\-a\fR, \fB\-\-apiserver \fR
65Enable OSPF apiserver. Default is disabled.
66.TP
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]67\fB\-v\fR, \fB\-\-version\fR
68Print the version and exit.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]69.SH FILES
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]70.TP
71.BI /usr/local/sbin/ospfd
72The default location of the
73.B ospfd
74binary.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]75.TP
76.BI /usr/local/etc/ospfd.conf
77The default location of the
78.B ospfd
79config file.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]80.TP
81.BI $(PWD)/ospfd.log
82If the
83.B ospfd
84process is config'd to output logs to a file, then you will find this
85file in the directory where you started \fBospfd\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]86.SH WARNING
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]87This man page is intended to be a quick reference for command line
88options. The definitive document is the Info file \fBQuagga\fR.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]89.SH DIAGNOSTICS
90The ospfd process may log to standard output, to a VTY, to a log
91file, or through syslog to the system logs. \fBospfd\fR supports many
92debugging options, see the Info file, or the source for details.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]93.SH "SEE ALSO"
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]94.BR bgpd (8),
95.BR ripd (8),
96.BR ripngd (8),
97.BR ospf6d (8),
98.BR isisd (8),
99.BR zebra (8),
100.BR vtysh (1)
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]101.SH BUGS
102.B ospfd
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]103eats bugs for breakfast. If you have food for the maintainers try
hasso2f04e672004-02-20 18:53:22 +0000[diff] [blame]104.BI http://bugzilla.quagga.net
hasso246c1352004-08-10 12:00:34 +0000[diff] [blame]105.SH AUTHORS
106See
107.BI http://www.zebra.org
108and
109.BI http://www.quagga.org
110or the Info file for an accurate list of authors.
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]111