Return to pimd.8 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / quagga / doc

Annotation of embedaddon/quagga/doc/pimd.8, revision 1.1

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