Import Upstream version 1.2.2
[quagga-debian.git] / doc / ospf6d.8
1 .TH OSPF6D 8 "25 November 2004" "Quagga OSPFv3 daemon" "Version 0.97.3"
2 .SH NAME
3 ospf6d \- an OSPFv3 routing engine for use with Quagga routing software.
4 .SH SYNOPSIS
5 .B ospf6d
6 [
7 .B \-dhv
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 ospf6d
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 ospf6d
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/ospf6d.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 ospf6d starts its process identifier is written to
53 \fB\fIpid-file\fR.  The init system uses the recorded PID to stop or
54 restart ospf6d.  The likely default is \fB\fI/var/run/ospf6d.pid\fR.
55 .TP
56 \fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR 
57 Specify the port that the ospf6d VTY will listen on. This defaults to
58 2606, 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 ospf6d 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\-v\fR, \fB\-\-version\fR
68 Print the version and exit.
69 .SH FILES
70 .TP
71 .BI /usr/local/sbin/ospf6d
72 The default location of the 
73 .B ospf6d
74 binary.
75 .TP
76 .BI /usr/local/etc/ospf6d.conf
77 The default location of the 
78 .B ospf6d
79 config file.
80 .TP
81 .BI $(PWD)/ospf6d.log 
82 If the 
83 .B ospf6d
84 process is config'd to output logs to a file, then you will find this
85 file in the directory where you started \fBospf6d\fR.
86 .SH WARNING
87 This man page is intended to be a quick reference for command line
88 options. The definitive document is the Info file \fBQuagga\fR.
89 .SH DIAGNOSTICS
90 The ospf6d process may log to standard output, to a VTY, to a log
91 file, or through syslog to the system logs. \fBospf6d\fR supports many
92 debugging options, see the Info file, or the source for details.
93 .SH "SEE ALSO"
94 .BR bgpd (8),
95 .BR ripd (8),
96 .BR ripngd (8),
97 .BR ospfd (8),
98 .BR isisd (8),
99 .BR zebra (8),
100 .BR vtysh (1)
101 .SH BUGS
102 .B ospf6d
103 eats bugs for breakfast. If you have food for the maintainers try
104 .BI http://bugzilla.quagga.net
105 .SH AUTHORS
106 See
107 .BI http://www.zebra.org
108 and
109 .BI http://www.quagga.net
110 or the Info file for an accurate list of authors.
111