pimd.8 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. .TH PIM 8 "10 December 2008" "Quagga PIM daemon" "Version 0.99.11"
  2. .SH NAME
  3. pimd \- a PIM routing for use with Quagga Routing Suite.
  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 \-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 pimd
  29. is a protocol-independent multicast component that works with the
  30. .B Quagga
  31. Routing Suite.
  32. .SH OPTIONS
  33. Options available for the
  34. .B pimd
  35. command:
  36. .TP
  37. \fB\-d\fR, \fB\-\-daemon\fR
  38. Runs in daemon mode, forking and exiting from tty.
  39. .TP
  40. \fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
  41. Specifies the config file to use for startup. If not specified this
  42. option will likely default to \fB\fI/usr/local/etc/pimd.conf\fR.
  43. .TP
  44. \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
  45. Specify the group to run as. Default is \fIquagga\fR.
  46. .TP
  47. \fB\-h\fR, \fB\-\-help\fR
  48. A brief message.
  49. .TP
  50. \fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR
  51. When pimd starts its process identifier is written to
  52. \fB\fIpid-file\fR. The init system uses the recorded PID to stop or
  53. restart pimd. The likely default is \fB\fI/var/run/pimd.pid\fR.
  54. .TP
  55. \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
  56. Specify the port that the pimd VTY will listen on. This defaults to
  57. 2611, as specified in \fB\fI/etc/services\fR.
  58. .TP
  59. \fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR
  60. Specify the address that the pimd VTY will listen on. Default is all
  61. interfaces.
  62. .TP
  63. \fB\-u\fR, \fB\-\-user \fR\fIuser\fR
  64. Specify the user to run as. Default is \fIquagga\fR.
  65. .TP
  66. \fB\-v\fR, \fB\-\-version\fR
  67. Print the version and exit.
  68. .TP
  69. \fB\-Z\fR, \fB\-\-debug_zclient\fR
  70. Enable logging information for zclient debugging.
  71. .SH FILES
  72. .TP
  73. .BI /usr/local/sbin/pimd
  74. The default location of the
  75. .B pimd
  76. binary.
  77. .TP
  78. .BI /usr/local/etc/pimd.conf
  79. The default location of the
  80. .B pimd
  81. config file.
  82. .TP
  83. .BI $(PWD)/pimd.log
  84. If the
  85. .B pimd
  86. process is config'd to output logs to a file, then you will find this
  87. file in the directory where you started \fBpimd\fR.
  88. .SH WARNING
  89. This man page is intended to be a quick reference for command line
  90. options.
  91. .SH DIAGNOSTICS
  92. The pimd process may log to standard output, to a VTY, to a log
  93. file, or through syslog to the system logs.
  94. .SH "SEE ALSO"
  95. .BR zebra (8),
  96. .BR vtysh (1)
  97. .SH BUGS
  98. \fBpimd\fR is in early development at the moment and is not ready for
  99. production use.
  100. .B pimd
  101. eats bugs for breakfast. If you have food for the maintainers try
  102. .BI http://savannah.nongnu.org/projects/qpimd
  103. .SH AUTHORS
  104. See
  105. .BI http://savannah.nongnu.org/projects/qpimd
  106. for an accurate list of authors.