xref: /freebsd/usr.sbin/rtadvctl/rtadvctl.8 (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
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
35daemon
36.Sh SYNOPSIS
37.Nm
38.Op Fl v
39.Ar subcommand
40.Op Ar interface ...
41.Sh DESCRIPTION
42.Nm
43is a utility that communicates with the
44.Xr rtadvd 8
45daemon and displays information about Router Advertisement messages being
46sent on each interface.
47.Pp
48This utility provides several options and subcommands.
49The options are as follows:
50.Bl -tag -width indent
51.\"
52.It Fl v
53Increase verbosity level.
54When specified once, the
55.Nm
56utility shows additional information about prefixes, RDNSS, and DNSSL
57options.
58When given twice, it additionally shows information about
59inactive interfaces and some statistics.
60.El
61.Pp
62The subcommands are as follows:
63.Bl -tag -width indent
64.\"
65.It reload Op interfaces...
66Specifies to reload the configuration file.
67If one or more
68.Ar interfaces
69are specified, configuration entries for the interfaces will be reloaded
70selectively.
71.It enable interfaces...
72Specifies to mark the interface as enabled and to tries to reload the
73configuration entry.
74This subcommand is useful for dynamically-added interfaces.
75.Pp
76The
77.Xr rtadvd 8
78daemon marks an interface as enabled if the interface exists and the
79configuration file has a valid entry for it when it is invoked.
80.It disable interfaces...
81Specifies to mark the interface as disabled.
82.It shutdown
83Makes the
84.Xr rtadvd 8
85daemon shut down.
86Note that the
87.Xr rtadvd 8
88daemon will send several RAs with zero lifetime to invalidate the old
89information on each interface.
90It will take at most nine seconds.
91.It show Op interfaces...
92Displays information about the Router Advertisement messages being sent
93on each interface.
94.El
95.Sh SEE ALSO
96.Xr rtadvd.conf 5 ,
97.Xr rtadvd 8
98.Sh HISTORY
99The
100.Nm
101command first appeared in
102.Fx 9.0 .
103.Sh AUTHORS
104.Nm
105was written by
106.An Hiroki Sato Aq Mt hrs@FreeBSD.org .
107