doc/ospfd.8.in

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