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