xref: /freebsd/usr.sbin/rtadvctl/rtadvctl.8 (revision 675be9115aae86ad6b3d877155d4fd7822892105)
1.\" Copyright (C) 2011 Hiroki Sato <hrs@FreeBSD.org>.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS
14.\" IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
15.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
16.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
17.\" PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
24.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd July 16, 2011
29.Dt RTADVCTL 8
30.Os
31.Sh NAME
32.Nm rtadvctl
33.Nd control program for
34.Xr rtadvd 8 daemon
35.Sh SYNOPSIS
36.Nm
37.Op Fl v
38.Ar subcommand
39.Op Ar interface ...
40.Sh DESCRIPTION
41.Nm
42is a utility that communicates with
43.Xr rtadvd 8
44daemon and displays information about Router Advertisement messages being
45sent on each interface.
46.Pp
47This utility provides several options and subcommands.
48The options are as follows:
49.Bl -tag -width indent
50.\"
51.It Fl v
52Increase verbosity level.
53When specified once, the
54.Nm
55utility shows additional information about prefixes, RDNSS, and DNSSL
56options.
57When given twice, it additionally shows information about
58inactive interfaces and some statistics.
59.El
60.Pp
61The subcommands are as follows:
62.Bl -tag -width indent
63.\"
64.It reload Op interfaces...
65Specifies to reload the configuration file.  If one or more
66.Ar interface
67is specified, configuration entries for the interfaces will be reloaded
68selectively.
69.It enable interfaces...
70Specifies to mark the interface as enable and to try to reload the
71configuration entry.
72This subcommand is useful for dynamically-added interfaces.
73.Pp
74The
75.Xr rtadvd 8
76daemon marks an interface as enable if the interface exists and the
77configuration file has a valid entry for that when it is invoked.
78.It disable interfaces...
79Specifies to mark the interface as disable.
80.It shutdown
81Makes the
82.Xr rtadvd 8
83daemon shut down.
84Note that the
85.Xr rtadvd 8
86daemon will send several RAs with zero lifetime to invalidate the old
87information on each interface.
88It will take at most nine seconds.
89.It show Op interfaces...
90Displays information on Router Advertisement messages being sent
91on each interface.
92.El
93.Sh SEE ALSO
94.Xr rtadvd 8 ,
95.Xr rtadvd.conf 5
96.Sh HISTORY
97The
98.Nm
99command first appeared in
100.Fx 9.0 .
101.Sh AUTHORS
102.Nm
103was written by
104.An "Hiroki Sato" Aq hrs@FreeBSD.org .
105