summaryrefslogtreecommitdiff
path: root/doc/ospfd.8
diff options
context:
space:
mode:
authorhasso <hasso>2004-08-10 12:00:34 +0000
committerhasso <hasso>2004-08-10 12:00:34 +0000
commit246c135ecf589aad215374daa982b36d7b3e6e0c (patch)
treec9498e2f63022e31198ed5d9a8823fe56cffb74d /doc/ospfd.8
parent55e7ecd114cd4f29b529f00cc1fe5d02d0f5b34f (diff)
I am bored. But I hate questions why there are man pages from version 0.88.
Vtysh man page looks already how it should look IMHO, the rest need more work.
Diffstat (limited to 'doc/ospfd.8')
-rw-r--r--doc/ospfd.8117
1 files changed, 39 insertions, 78 deletions
diff --git a/doc/ospfd.8 b/doc/ospfd.8
index 1d28ed04..1fde9003 100644
--- a/doc/ospfd.8
+++ b/doc/ospfd.8
@@ -1,147 +1,108 @@
-.TH OSPFD 8 "July 2000" "Zebra Beast - OSPFD" "Version 0.88"
-
+.TH OSPFD 8 "10 August 2004" "Quagga OSPFv2 daemon" "Version 0.96.5"
.SH NAME
-ospfd \- an OSPF v2 routing engine for use with Zebra
-
+ospfd \- an OSPFv2 routing engine for use with Quagga routing software.
.SH SYNOPSIS
.B ospfd
[
.B \-dhlv
+] [
+.B \-f
+.I config-file
+] [
+.B \-i
+.I pid-file
+] [
+.B \-P
+.I port-number
+] [
+.B \-A
+.I vty-address
+] [
+.B \-u
+.I user
]
-[
-.B \-f config-file
-]
-[
-.B \-i pid-file
-]
-[
-.B \-P port-number
-]
-[
-.B \-A vty-address
-]
-[
-.B \-u user
-]
-
.SH DESCRIPTION
-.B ospfd
-is a routing component that works with the
-.B zebra
+.B ospfd
+is a routing component that works with the
+.B Quagga
routing engine.
-
-
.SH OPTIONS
-
+Options available for the
+.B ospfd
+command:
.TP
\fB\-d\fR, \fB\-\-daemon\fR
Runs in daemon mode, forking and exiting from tty.
-
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/ospfd.conf\fR.
-
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
-
.TP
\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
When ospfd starts its process idenifier is written to
\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
restart ospfd. The likely default is \fB\fI/var/run/ospfd.pid\fR.
-
.TP
\fB\-l\fR, \fB\-\-log_mode\fR
Turn verbose logging on.
-
.TP
\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
Specify the port that the ospfd VTY will listen on. This defaults to
2604, as specified in \fB\fI/etc/services\fR.
-
.TP
\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
Specify the address that the ospfd VTY will listen on. Default is all
intrefaces.
-
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
Specify the user and group to run as. User and group have to have same
name at the moment. Default is \fIquagga\fR.
-
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
-
-
-.SH COMMANDS
-
-\fB router ospf \fR
-\fB router zebra \fR -- (Move routes into kernel table)
-
-\fB network [NETWORK] area [OSPF-AREA-ID] \fR
-\fB no network [NETWORK] \fR
-
-\fB show ip ospf interface \fR
-\fB show ip ospf neighbor \fR
-\fB show ip ospf database \fR
-\fB show ip ospf route \fR
-
-
-\fB debug ospf ism \fR
-\fB debug ospf packet \fR
-\fB debug ospf nsm \fR
-
-
-
.SH FILES
-
.TP
.BI /usr/local/sbin/ospfd
The default location of the
.B ospfd
binary.
-
.TP
.BI /usr/local/etc/ospfd.conf
The default location of the
.B ospfd
config file.
-
.TP
.BI $(PWD)/ospfd.log
If the
.B ospfd
process is config'd to output logs to a file, then you will find this
file in the directory where you started \fBospfd\fR.
-
-
.SH WARNING
-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.
-
-
+This man page is intended to be a quick reference for command line
+options. The definitive document is the Info file \fBQuagga\fR.
.SH DIAGNOSTICS
The ospfd process may log to standard output, to a VTY, to a log
file, or through syslog to the system logs. \fBospfd\fR supports many
debugging options, see the Info file, or the source for details.
-
-
.SH "SEE ALSO"
-References to other related man pages:
-
-ripd(8), ripngd(8), ospf6d(8), bgpd(8), zebra(8), vtysh(1)
-
-
+.BR bgpd (8),
+.BR ripd (8),
+.BR ripngd (8),
+.BR ospf6d (8),
+.BR isisd (8),
+.BR zebra (8),
+.BR vtysh (1)
.SH BUGS
.B ospfd
-eats bugs for breakfast. If you have food for the maintainers try
+eats bugs for breakfast. If you have food for the maintainers try
.BI http://bugzilla.quagga.net
-
-
-.SH AUTHOR[S]
-See <\fBwww.zebra.org\fR>, or the Info file for an accurate list of authors.
+.SH AUTHORS
+See
+.BI http://www.zebra.org
+and
+.BI http://www.quagga.org
+or the Info file for an accurate list of authors.