doc/ripd.8.in

   1 .TH RIPD 8 "25 November 2004" "@PACKAGE_FULLNAME@ RIP daemon" "Version @PACKAGE_VERSION@"
   2 .SH NAME
   3 ripd \- a RIP routing engine for use with @PACKAGE_FULLNAME@.
   4 .SH SYNOPSIS
   5 .B ripd
   6 [
   7 .B \-dhrv
   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 ripd
  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 ripd
  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@/ripd.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 ripd starts its process identifier is written to
  56 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  57 restart ripd.  The default is \fB\fI@CFG_STATE@/ripd.pid\fR.
  58 .TP
  59 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  60 Specify the port that the ripd VTY will listen on. This defaults to
  61 2602, 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 ripd 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\-r\fR, \fB\-\-retain\fR
  71 When the program terminates, retain routes added by \fBripd\fR.
  72 .TP
  73 \fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
  74 Load a module at startup.  May be specified more than once.
  75 The \fBsnmp\fR module may be available for
  76 \fBripd\fR, if the package was built with SNMP support.
  77 .TP
  78 \fB\-v\fR, \fB\-\-version\fR
  79 Print the version and exit.
  80 .SH FILES
  81 .TP
  82 .BI @CFG_SBIN@/ripd
  83 The default location of the
  84 .B ripd
  85 binary.
  86 .TP
  87 .BI @CFG_SYSCONF@/ripd.conf
  88 The default location of the
  89 .B ripd
  90 config file.
  91 .TP
  92 .BI $(PWD)/ripd.log
  93 If the
  94 .B ripd
  95 process is config'd to output logs to a file, then you will find this
  96 file in the directory where you started \fBripd\fR.
  97 .SH WARNING
  98 This man page is intended to be a quick reference for command line
  99 options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR.
 100 .SH DIAGNOSTICS
 101 The ripd process may log to standard output, to a VTY, to a log
 102 file, or through syslog to the system logs. \fBripd\fR supports many
 103 debugging options, see the Info file, or the source for details.
 104 .SH "SEE ALSO"
 105 .BR bgpd (8),
 106 .BR ripngd (8),
 107 .BR ospfd (8),
 108 .BR ospf6d (8),
 109 .BR isisd (8),
 110 .BR zebra (8),
 111 .BR vtysh (1)
 112 .SH BUGS
 113 .B ripd
 114 eats bugs for breakfast. If you have food for the maintainers try
 115 .BI @PACKAGE_BUGREPORT@
 116 .SH AUTHORS
 117 See
 118 .BI http://www.zebra.org
 119 and
 120 .BI @PACKAGE_URL@
 121 or the Info file for an accurate list of authors.