Import Upstream version 1.2.2
[quagga-debian.git] / doc / ripngd.8
1 .TH RIPNGD 8 "25 November 2004" "Quagga RIPNG daemon" "Version 0.97.3"
2 .SH NAME
3 ripngd \- a RIPNG routing engine for use with Quagga routing software.
4 .SH SYNOPSIS
5 .B ripngd
6 [
7 .B \-dhlrv
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 ripngd
29 is a routing component that works with the
30 .B Quagga
31 routing engine.
32 .SH OPTIONS
33 Options available for the
34 .B ripngd
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 likely default to \fB\fI/usr/local/etc/ripngd.conf\fR.
44 .TP
45 \fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
46 Specify the group to run as. Default is \fIquagga\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 ripngd starts its process identifier is written to
53 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
54 restart ripngd.  The likely default is \fB\fI/var/run/ripngd.pid\fR.
55 .TP
56 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
57 Specify the port that the ripngd VTY will listen on. This defaults to
58 2603, 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 ripngd 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 \fIquagga\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 /usr/local/sbin/ripngd
75 The default location of the 
76 .B ripngd
77 binary.
78 .TP
79 .BI /usr/local/etc/ripngd.conf
80 The default location of the 
81 .B ripngd
82 config file.
83 .TP
84 .BI $(PWD)/ripngd.log 
85 If the 
86 .B ripngd
87 process is config'd to output logs to a file, then you will find this
88 file in the directory where you started \fBripngd\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 \fBQuagga\fR.
92 .SH DIAGNOSTICS
93 The ripngd process may log to standard output, to a VTY, to a log
94 file, or through syslog to the system logs. \fBripngd\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 ripd (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 ripngd
106 eats bugs for breakfast. If you have food for the maintainers try
107 .BI http://bugzilla.quagga.net
108 .SH AUTHORS
109 See
110 .BI http://www.zebra.org
111 and
112 .BI http://www.quagga.net
113 or the Info file for an accurate list of authors.
114