| blob | 4a05caefa8f7250b5c9e7e497d678d0d86cff2f2 |
1 .\"
2 .\"
3 .\" Authors:
4 .\" Lars Fenneberg <lf@elemental.net>
5 .\"
6 .\" This software is Copyright 1996-2000 by the above mentioned author(s),
7 .\" All Rights Reserved.
8 .\"
9 .\" The license which is distributed with this software in the file COPYRIGHT
10 .\" applies to this software. If your distribution is missing this file, you
11 .\" may request it from <pekkas@netcore.fi>.
12 .\"
13 .\"
14 .\"
15 .TH RADVD 8 "14 Dec 2010" "radvd @VERSION@" ""
16 .SH NAME
17 radvd \- router advertisement daemon for IPv6
18 .SH SYNOPSIS
19 .B radvd
20 .B "[ \-hsvc ]"
21 .BI "[ \-d " debuglevel " ]"
22 .BI "[ \-C " configfile " ]"
23 .BI "[ \-p " pidfile " ]"
24 .BI "[ \-m " logmethod " ]"
25 .BI "[ \-l " logfile " ]"
26 .BI "[ \-f " facility " ]"
27 .BI "[ \-t " chrootdir " ]"
28 .BI "[ \-u " username " ]"
30 .SH DESCRIPTION
31 .B radvd
32 is the router advertisement daemon for IPv6. It listens to router
33 solicitations and sends router advertisements as described in
34 "Neighbor Discovery for IP Version 6 (IPv6)" (RFC 4861).
35 With these advertisements hosts can automatically configure their
36 addresses and some other parameters. They also can choose a default
37 router based on these advertisements.
39 Note that if debugging is not enabled,
40 .B radvd
41 will not start if IPv6 forwarding is disabled. IPv6 forwarding can be
42 controlled via sysctl(8),
43 .B net.ipv6.conf.all.forwarding
44 on Linux or
45 .B net.inet6.ip6.forwarding
46 on BSD.
48 Similarly, the configuration file must not be writable by others, and if
49 non-root operation is requested, not even by self/own group.
51 .SH OPTIONS
53 For every one character option there is also a long option, which
54 is listed right next to the "short" option name:
56 .TP
57 .BR "\-v" , " \-\-version"
58 Displays the version of
59 .I radvd
60 and then aborts.
61 .TP
62 .BR "\-h" , " \-\-help"
63 Displays a short usage description and then aborts.
64 .TP
65 .BR "\-s" , " \-\-singleprocess"
66 On Linux if
67 .I username
68 is specified, privilege separation is enabled and there will be
69 two processes.
70 This option disables privilege separation, and as a result,
71 the non-privileged radvd process does not have permissions to
72 change interface configuration.
73 .TP
74 .BR "\-c" , " \-\-configtest"
75 Test configuration and do startup tests and then exit.
76 .TP
77 .BR "\-d " debuglevel, " \-\-debug " debuglevel
78 With this option you turn on debugging information. The debugging level is
79 an integer in the range from 1 to 5, from quiet to very verbose. A
80 debugging level of 0 completely turns off debugging. If a debugging level
81 greater than 0 is used,
82 .I radvd
83 doesn't background itself on start. The default debugging level is 0.
84 .TP
85 .BR "\-C " configfile, " \-\-config " configfile
86 Specifies an alternate config file. Normally the compiled in default
87 .I @PATH_RADVD_CONF@
88 is used.
89 .TP
90 .BR "\-p " pidfile, " \-\-pidfile " pidfile
91 Specifies an alternate pidfile. Normally the compiled in default
92 .I @PATH_RADVD_PID@
93 is used.
94 .TP
95 .BR "\-m " method, " \-\-logmethod " method
96 Specifies the logging method to use. Possibly values are:
97 .RS
98 .TP
99 .B none
100 Completely disables any logging.
101 .TP
102 .B logfile
103 Logs to the logfile which is specified by the
104 .I \-l
105 option. If no logfile is specified on the command line, then
106 a compiled in default is used (see next option).
107 .TP
108 .B stderr
109 Logs to standard error.
110 .TP
111 .B stderr_syslog
112 Logs only the high messages (of at least LOG_ERR priority) to standard
113 error, and everything to syslog (default method).
114 .TP
115 .B syslog
116 Logs to syslog.
117 .RE
118 .PP
119 .TP
120 .BR "\-l " logfile, " \-\-logfile " logfile
121 Specifies the logfile to use when using the logging method
122 .IR logfile .
123 The default logfile is
124 .IR @PATH_RADVD_LOG@ .
125 .TP
126 .BR "\-f " facility, " \-\-facility " facility
127 Specifies the facility (as an integer) when using syslog logging. Default
128 is @LOG_FACILITY@.
129 .TP
130 .BR "\-t " chrootdir, " \-\-chrootdir " chrootdir
131 If specified, switches to
132 .I chrootdir
133 before doing anything else. This directory and its
134 subdirectories must have been populated first.
135 For security reasons,
136 .I \-u
137 must always be used when using
138 .IR chrootdir .
140 Note that on Linux
141 .I radvd
142 requires access to the
143 .I /proc
144 filesystem,
145 so it is more challenging to set up the chroot environment.
146 .TP
147 .BR "\-u " username, " \-\-username " username
148 If specified, drops root privileges and changes user ID to
149 .I username
150 and group ID to the primary group of
151 .IR username .
152 This is recommended for security reasons.
153 You might also need to use
154 .I \-p
155 to point to a file in a
156 .I username
157 -writable directory (e.g. /var/run/radvd/radvd.pid).
158 .SH FILES
160 .nf
161 @sbindir@/radvd
162 @PATH_RADVD_CONF@
163 @PATH_RADVD_PID@
164 @PATH_RADVD_LOG@
165 .fi
166 .SH BUGS
168 There certainly are some bugs. If you find them or have other
169 suggestions please contact Pekka Savola <pekkas@netcore.fi>.
171 .SH "SEE ALSO"
173 .BR radvd.conf (5),
174 .BR radvdump (8)
175 .SH AUTHORS
177 .nf
178 Pedro Roque <roque@di.fc.ul.pt> - wrote first version for Linux
179 Lars Fenneberg <lf@elemental.net> - previous maintainer
180 Nathan Lutchansky <lutchann@litech.org> - previous maintainer
181 Pekka Savola <pekkas@netcore.fi> - current maintainer
182 Craig Metz <cmetz@inner.net> - port to NRL's IPv6 code for BSD4.4
183 Marko Myllynen <myllynen@lut.fi> - RFC 2461 update, Mobile IPv6 support
184 Jim Paris <jim@jtan.com> - Privilege separation support
185 Reuben Hawkins <reubenhwk@gmail.com> - Many fixes and cleanups
186 Pierre Ossman <pierre@ossman.eu> - RFC6106 (DNSSL) support
187 .fi