diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/install.texi | 1 | ||||
| -rw-r--r-- | doc/ipv6.texi | 10 | ||||
| -rw-r--r-- | doc/pimd.8 | 108 |
4 files changed, 120 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index c3016b2b..5c041572 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -61,7 +61,7 @@ quagga_TEXINFOS = appendix.texi basic.texi bgpd.texi filter.texi install.texi \ .dia.png: $(DIATOPNG) "$@" $< -man_MANS = vtysh.1 bgpd.8 ospf6d.8 ospfd.8 ripd.8 ripngd.8 zebra.8 isisd.8 +man_MANS = vtysh.1 bgpd.8 ospf6d.8 ospfd.8 ripd.8 ripngd.8 zebra.8 isisd.8 pimd.8 EXTRA_DIST = BGP-TypeCode draft-zebra-00.ms draft-zebra-00.txt $(man_MANS) \ mpls/ChangeLog.opaque.txt mpls/cli_summary.txt \ diff --git a/doc/install.texi b/doc/install.texi index 16e29c99..fbc2401d 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -267,6 +267,7 @@ bgpd 2605/tcp # BGPd vty ospf6d 2606/tcp # OSPF6d vty ospfapi 2607/tcp # ospfapi isisd 2608/tcp # ISISd vty +pimd 2611/tcp # PIMd vty @end example If you use a FreeBSD newer than 2.2.8, the above entries are already diff --git a/doc/ipv6.texi b/doc/ipv6.texi index a78a92fe..519b7798 100644 --- a/doc/ipv6.texi +++ b/doc/ipv6.texi @@ -157,15 +157,25 @@ Set default router preference in IPv6 router advertisements per RFC4191. Default: medium @end deffn +@deffn {Interface Command} {ipv6 nd rdnss ipv6prefix [lifetime]} {} Include +RDNSS options to advertise recursive DNS server addresses. Additionally a +maximum lifetime (in seconds) can be specified to limit the lifetime of this +option. The valid range is between @code{<0-4294967295>} where 0 means that the +RDNSS address must no longer be used. The default lifetime - without explicitly +specify a lifetime - is unlimited. +@end deffn + @example @group interface eth0 no ipv6 nd suppress-ra ipv6 nd prefix 2001:0DB8:5009::/64 + ipv6 nd rdnss 2001:0DB8:5009::1 @end group @end example For more information see @cite{RFC2462 (IPv6 Stateless Address Autoconfiguration)} , @cite{RFC2461 (Neighbor Discovery for IP Version 6 (IPv6))} , @cite{RFC3775 (Mobility Support in IPv6 (Mobile IPv6))} +, @cite{RFC5006 (IPv6 Router Advertisement Option for DNS Configuration)} and @cite{RFC4191 (Default Router Preferences and More-Specific Routes)}. diff --git a/doc/pimd.8 b/doc/pimd.8 new file mode 100644 index 00000000..b26b1128 --- /dev/null +++ b/doc/pimd.8 @@ -0,0 +1,108 @@ +.TH PIM 8 "10 December 2008" "Quagga PIM daemon" "Version 0.99.11" +.SH NAME +pimd \- a PIM routing for use with Quagga Routing Suite. +.SH SYNOPSIS +.B pimd +[ +.B \-dhvZ +] [ +.B \-f +.I config-file +] [ +.B \-i +.I pid-file +] [ +.B \-P +.I port-number +] [ +.B \-A +.I vty-address +] [ +.B \-u +.I user +] [ +.B \-g +.I group +] +.SH DESCRIPTION +.B pimd +is a protocol-independent multicast component that works with the +.B Quagga +Routing Suite. +.SH OPTIONS +Options available for the +.B pimd +command: +.TP +\fB\-d\fR, \fB\-\-daemon\fR +Runs in daemon mode, forking and exiting from tty. +.TP +\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR +Specifies the config file to use for startup. If not specified this +option will likely default to \fB\fI/usr/local/etc/pimd.conf\fR. +.TP +\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR +Specify the group to run as. Default is \fIquagga\fR. +.TP +\fB\-h\fR, \fB\-\-help\fR +A brief message. +.TP +\fB\-i\fR, \fB\-\-pid_file \fR\fIpid-file\fR +When pimd starts its process identifier is written to +\fB\fIpid-file\fR. The init system uses the recorded PID to stop or +restart pimd. The likely default is \fB\fI/var/run/pimd.pid\fR. +.TP +\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR +Specify the port that the pimd VTY will listen on. This defaults to +2611, as specified in \fB\fI/etc/services\fR. +.TP +\fB\-A\fR, \fB\-\-vty_addr \fR\fIvty-address\fR +Specify the address that the pimd VTY will listen on. Default is all +interfaces. +.TP +\fB\-u\fR, \fB\-\-user \fR\fIuser\fR +Specify the user to run as. Default is \fIquagga\fR. +.TP +\fB\-v\fR, \fB\-\-version\fR +Print the version and exit. +.TP +\fB\-Z\fR, \fB\-\-debug_zclient\fR +Enable logging information for zclient debugging. +.SH FILES +.TP +.BI /usr/local/sbin/pimd +The default location of the +.B pimd +binary. +.TP +.BI /usr/local/etc/pimd.conf +The default location of the +.B pimd +config file. +.TP +.BI $(PWD)/pimd.log +If the +.B pimd +process is config'd to output logs to a file, then you will find this +file in the directory where you started \fBpimd\fR. +.SH WARNING +This man page is intended to be a quick reference for command line +options. +.SH DIAGNOSTICS +The pimd process may log to standard output, to a VTY, to a log +file, or through syslog to the system logs. +.SH "SEE ALSO" +.BR zebra (8), +.BR vtysh (1) +.SH BUGS +\fBpimd\fR is in early development at the moment and is not ready for +production use. + +.B pimd +eats bugs for breakfast. If you have food for the maintainers try +.BI http://savannah.nongnu.org/projects/qpimd +.SH AUTHORS +See +.BI http://savannah.nongnu.org/projects/qpimd +for an accurate list of authors. + |