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