xref: /freebsd-src/usr.sbin/rtadvctl/rtadvctl.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
137241896SHiroki Sato.\" Copyright (C) 2011 Hiroki Sato <hrs@FreeBSD.org>.
237241896SHiroki Sato.\" All rights reserved.
337241896SHiroki Sato.\"
437241896SHiroki Sato.\" Redistribution and use in source and binary forms, with or without
537241896SHiroki Sato.\" modification, are permitted provided that the following conditions
637241896SHiroki Sato.\" are met:
737241896SHiroki Sato.\" 1. Redistributions of source code must retain the above copyright
837241896SHiroki Sato.\"    notice, this list of conditions and the following disclaimer.
937241896SHiroki Sato.\" 2. Redistributions in binary form must reproduce the above copyright
1037241896SHiroki Sato.\"    notice, this list of conditions and the following disclaimer in the
1137241896SHiroki Sato.\"    documentation and/or other materials provided with the distribution.
1237241896SHiroki Sato.\"
1337241896SHiroki Sato.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS
1437241896SHiroki Sato.\" IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1537241896SHiroki Sato.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
1637241896SHiroki Sato.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
1737241896SHiroki Sato.\" PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
1837241896SHiroki Sato.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1937241896SHiroki Sato.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2037241896SHiroki Sato.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2137241896SHiroki Sato.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2237241896SHiroki Sato.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
2337241896SHiroki Sato.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
2437241896SHiroki Sato.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2537241896SHiroki Sato.\"
2637241896SHiroki Sato.Dd July 16, 2011
2737241896SHiroki Sato.Dt RTADVCTL 8
2837241896SHiroki Sato.Os
2937241896SHiroki Sato.Sh NAME
3037241896SHiroki Sato.Nm rtadvctl
3137241896SHiroki Sato.Nd control program for
32344c81a1SWarren Block.Xr rtadvd 8
33344c81a1SWarren Blockdaemon
3437241896SHiroki Sato.Sh SYNOPSIS
3537241896SHiroki Sato.Nm
3637241896SHiroki Sato.Op Fl v
3737241896SHiroki Sato.Ar subcommand
3837241896SHiroki Sato.Op Ar interface ...
3937241896SHiroki Sato.Sh DESCRIPTION
4037241896SHiroki Sato.Nm
41*9ae4c2a4SHiroki Satois a utility that communicates with the
4237241896SHiroki Sato.Xr rtadvd 8
4337241896SHiroki Satodaemon and displays information about Router Advertisement messages being
4437241896SHiroki Satosent on each interface.
4537241896SHiroki Sato.Pp
4637241896SHiroki SatoThis utility provides several options and subcommands.
4737241896SHiroki SatoThe options are as follows:
4837241896SHiroki Sato.Bl -tag -width indent
4937241896SHiroki Sato.\"
5037241896SHiroki Sato.It Fl v
5137241896SHiroki SatoIncrease verbosity level.
5237241896SHiroki SatoWhen specified once, the
5337241896SHiroki Sato.Nm
5437241896SHiroki Satoutility shows additional information about prefixes, RDNSS, and DNSSL
5537241896SHiroki Satooptions.
5637241896SHiroki SatoWhen given twice, it additionally shows information about
5737241896SHiroki Satoinactive interfaces and some statistics.
5837241896SHiroki Sato.El
5937241896SHiroki Sato.Pp
6037241896SHiroki SatoThe subcommands are as follows:
6137241896SHiroki Sato.Bl -tag -width indent
6237241896SHiroki Sato.\"
6337241896SHiroki Sato.It reload Op interfaces...
64*9ae4c2a4SHiroki SatoSpecifies to reload the configuration file.
65*9ae4c2a4SHiroki SatoIf one or more
66*9ae4c2a4SHiroki Sato.Ar interfaces
67*9ae4c2a4SHiroki Satoare specified, configuration entries for the interfaces will be reloaded
6837241896SHiroki Satoselectively.
6937241896SHiroki Sato.It enable interfaces...
70*9ae4c2a4SHiroki SatoSpecifies to mark the interface as enabled and to tries to reload the
7137241896SHiroki Satoconfiguration entry.
7237241896SHiroki SatoThis subcommand is useful for dynamically-added interfaces.
7337241896SHiroki Sato.Pp
7437241896SHiroki SatoThe
7537241896SHiroki Sato.Xr rtadvd 8
76*9ae4c2a4SHiroki Satodaemon marks an interface as enabled if the interface exists and the
77*9ae4c2a4SHiroki Satoconfiguration file has a valid entry for it when it is invoked.
7837241896SHiroki Sato.It disable interfaces...
79*9ae4c2a4SHiroki SatoSpecifies to mark the interface as disabled.
8037241896SHiroki Sato.It shutdown
8137241896SHiroki SatoMakes the
8237241896SHiroki Sato.Xr rtadvd 8
8337241896SHiroki Satodaemon shut down.
8437241896SHiroki SatoNote that the
8537241896SHiroki Sato.Xr rtadvd 8
8637241896SHiroki Satodaemon will send several RAs with zero lifetime to invalidate the old
8737241896SHiroki Satoinformation on each interface.
8837241896SHiroki SatoIt will take at most nine seconds.
8937241896SHiroki Sato.It show Op interfaces...
90*9ae4c2a4SHiroki SatoDisplays information about the Router Advertisement messages being sent
9137241896SHiroki Satoon each interface.
92e9d25c68SGlen Barber.El
9337241896SHiroki Sato.Sh SEE ALSO
94914f6e62SJoel Dahl.Xr rtadvd.conf 5 ,
95914f6e62SJoel Dahl.Xr rtadvd 8
9637241896SHiroki Sato.Sh HISTORY
9737241896SHiroki SatoThe
9837241896SHiroki Sato.Nm
9937241896SHiroki Satocommand first appeared in
10037241896SHiroki Sato.Fx 9.0 .
10137241896SHiroki Sato.Sh AUTHORS
10237241896SHiroki Sato.Nm
10337241896SHiroki Satowas written by
10401c2b8acSBaptiste Daroussin.An Hiroki Sato Aq Mt hrs@FreeBSD.org .
105