doc/pimd.8.in

   1 .TH PIM 8 "10 December 2008" "@PACKAGE_FULLNAME@ PIM daemon" "Version @PACKAGE_VERSION@"
   2 .SH NAME
   3 pimd \- a PIM routing for use with @PACKAGE_FULLNAME@.
   4 .SH SYNOPSIS
   5 .B pimd
   6 [
   7 .B \-dhvZ
   8 ] [
   9 .B \-f
  10 .I config-file
  11 ] [
  12 .B \-i
  13 .I pid-file
  14 ] [
  15 .B \-z
  16 .I path
  17 ] [
  18 .B \-P
  19 .I port-number
  20 ] [
  21 .B \-A
  22 .I vty-address
  23 ] [
  24 .B \-u
  25 .I user
  26 ] [
  27 .B \-g
  28 .I group
  29 ] [
  30 .B \-M
  31 .I module:options
  32 ]
  33 .SH DESCRIPTION
  34 .B pimd
  35 is a protocol-independent multicast component that works with the
  36 .B @PACKAGE_FULLNAME@
  37 Routing Suite.
  38 .SH OPTIONS
  39 Options available for the
  40 .B pimd
  41 command:
  42 .TP
  43 \fB\-d\fR, \fB\-\-daemon\fR
  44 Runs in daemon mode, forking and exiting from tty.
  45 .TP
  46 \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  47 Specifies the config file to use for startup. If not specified this
  48 option will default to \fB\fI@CFG_SYSCONF@/pimd.conf\fR.
  49 .TP
  50 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  51 Specify the group to run as. Default is \fI@enable_group@\fR.
  52 .TP
  53 \fB\-h\fR, \fB\-\-help\fR
  54 A brief message.
  55 .TP
  56 \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  57 When pimd starts its process identifier is written to
  58 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
  59 restart pimd.  The default is \fB\fI@CFG_STATE@/pimd.pid\fR.
  60 .TP
  61 \fB\-z\fR, \fB\-\-socket \fR\fIpath\fR
  62 Specify the socket path for contacting the zebra daemon.
  63 The default is \fB\fI@CFG_STATE@/zserv.api\fR.  The value of this option
  64 must be the same as the one given when starting zebra.  Refer to the \fBzebra
  65 (8)\fR man page for more information.
  66 .TP
  67 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  68 Specify the port that the pimd VTY will listen on. This defaults to
  69 2611, as specified in \fB\fI/etc/services\fR.
  70 .TP
  71 \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  72 Specify the address that the pimd VTY will listen on. Default is all
  73 interfaces.
  74 .TP
  75 \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  76 Specify the user to run as. Default is \fI@enable_user@\fR.
  77 .TP
  78 \fB\-M\fR, \fB\-\-module \fR\fImodule:options\fR
  79 Load a module at startup.  May be specified more than once.
  80 There are currently no such modules for
  81 \fBpimd\fR in the base package.
  82 .TP
  83 \fB\-v\fR, \fB\-\-version\fR
  84 Print the version and exit.
  85 .TP
  86 \fB\-Z\fR, \fB\-\-debug_zclient\fR
  87 Enable logging information for zclient debugging.
  88 .SH FILES
  89 .TP
  90 .BI @CFG_SBIN@/pimd
  91 The default location of the
  92 .B pimd
  93 binary.
  94 .TP
  95 .BI @CFG_SYSCONF@/pimd.conf
  96 The default location of the
  97 .B pimd
  98 config file.
  99 .TP
 100 .BI @CFG_STATE@/pimd.pid
 101 The default location of the
 102 .B pimd
 103 pid file.
 104 .TP
 105 .BI @CFG_STATE@/zserv.api
 106 The default location of the
 107 .B zebra
 108 unix socket file.
 109 .TP
 110 .BI $(PWD)/pimd.log
 111 If the
 112 .B pimd
 113 process is config'd to output logs to a file, then you will find this
 114 file in the directory where you started \fBpimd\fR.
 115 .SH WARNING
 116 This man page is intended to be a quick reference for command line
 117 options.
 118 .SH DIAGNOSTICS
 119 The pimd process may log to standard output, to a VTY, to a log
 120 file, or through syslog to the system logs.
 121 .SH "SEE ALSO"
 122 .BR zebra (8),
 123 .BR vtysh (1)
 124 .SH BUGS
 125 \fBpimd\fR is in early development at the moment and is not ready for
 126 production use.
 127
 128 .B pimd
 129 eats bugs for breakfast. If you have food for the maintainers try
 130 .BI https://github.com/udhos/qpimd
 131 .SH AUTHORS
 132 See
 133 .BI https://github.com/udhos/qpimd
 134 for an accurate list of authors.
 135