doc/ospf6d.8.in

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