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