usr.sbin/rtadvctl/rtadvctl.8

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