doc/ospfd.8

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