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