usr.sbin/pim6sd/pim6sd.8

   1 .\" Copyright (C) 1999 WIDE Project.
   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 .\" 3. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: pim6sd.8,v 1.6 2000/05/18 16:11:46 itojun Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd June 10, 1999
  32 .Dt PIM6SD 8
  33 .Os
  34 .Sh NAME
  35 .Nm pim6sd
  36 .Nd PIM for IPv6 sparse mode daemon
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl c Ar configfile
  40 .Op Fl d Op debug_level Op ,debug_level
  41 .Op Fl f
  42 .Sh DESCRIPTION
  43 .Nm Pim6sd
  44 is an IPv6 multicast routing daemon, which supports
  45 PIMv2(Protocol Independent Multicast Version 2) sparse mode
  46 for IPv6.
  47 .Pp
  48 Options supported by
  49 .Nm Ns :
  50 .Bl -tag -width Ds
  51 .It Fl c Ar configfile
  52 Specify alternate location,
  53 .Ar configfile ,
  54 for configuration file.
  55 By default,
  56 .Pa /etc/pim6sd.conf
  57 is used.
  58 .It Fl d
  59 Specify debug levels. If this option is specified without any arguments,
  60 all debug messages will be printed out.
  61 A subset of the messages to be printed out can be specified
  62 as arguments of the option.
  63 Valid debug levels are
  64 .Ic mld_proto, mld_timer, mld_member, mld, switch, trace, mtrace, traceroute,
  65 .Ic timeout, callout, pkt, packets, interfaces, vif, kernel, cache, mfc,
  66 .Ic k_cache, k_mfc, rsrr, pim_detail, pim_hello, pim_neighbors, pim_register,
  67 .Ic registers, pim_join_prune, pim_j_p, pim_jp, pim_bootstrap, pim_bsr, bsr,
  68 .Ic bootstrap, pim_asserts, pim_cand_rp, pim_c_rp, pim_rp, rp, pim_routes,
  69 .Ic pim_routing, pim_mrt, pim_timers, pim_rpf, rpf, pim, routes, routing,
  70 .Ic mrt, routers, mrouters, neighbors, timers,
  71 and
  72 .Ic asserts.
  73 .It Fl f
  74 Do not become daemon, run in foreground. This option is for debugging
  75 use.
  76 .El
  77 .Pp
  78 .Nm Pim6sd
  79 automatically configures itself to forward on all multicast-capable
  80 interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding
  81 the "loopback interface").
  82 To override the default configuration,
  83 configuration commands may be placed in
  84 .Pa /etc/pim6sd.conf
  85 .Po
  86 or an alternative file, specified by the
  87 .Sq Fl c
  88 option
  89 .Pc .
  90 .Pp
  91 The
  92 .Nm
  93 program dumps its current routing information to a dump file when
  94 it receives a
  95 .Dv SIGUSR1
  96 signal.
  97 The information includes a list of PIM neighbors,
  98 .Nm
  99 internal multicast routing table, and
 100 BSR and RP related information. Also, the program dumps its internal
 101 statistics to a file when it receives a SIGINFO signal.
 102 .Pp
 103 When
 104 .Nm
 105 receives a SIGUSR2 signal, it rereads the configuration file and
 106 reset its debug level.
 107 .Pp
 108 The
 109 .Nm
 110 program puts its logs to a separate file
 111 .Pa Pq /var/log/pim6sd.log .
 112 The log level can be configured by the
 113 .Fl d
 114 command line option or the configuration file.
 115 .\"
 116 .Sh FILES
 117 .Bl -tag -width /etc/pim6sd.conf -compact
 118 .It Pa /etc/pim6sd.conf
 119 The default configuration file.
 120 .It Pa /var/run/pim6sd.dump
 121 The file to which
 122 .Nm
 123 dumps its internal status.
 124 .It Pa /var/run/pim6sd.stat
 125 The file to which
 126 .Nm
 127 dumps its internal statistics.
 128 .It Pa /var/log/pim6sd.log
 129 The pim6sd specific log file.
 130 .El
 131 .Sh SEE ALSO
 132 .Xr daemon 3 ,
 133 .Xr pim6sd.conf 5
 134 .Sh HISTORY
 135 The
 136 .Nm
 137 command is developed by Mickael Hoerdt at LSIIT Laboratory.
 138 It is based on IPv4 PIM sparse-mode
 139 .Nm pimd
 140 developed at University of Southern California,
 141 which has also been derived from
 142 .Nm mrouted .
 143 .Nm Mrouted
 144 is COPYRIGHT 1989 by The Board of Trustees of
 145 Leland Stanford Junior University.
 146 .\"
 147 .Sh BUGS
 148 .Nm Pim6sd
 149 does not contain any unicast routing engine, so a unicast routing
 150 daemon needs to run on the system.
 151 .Pp
 152 The kernel unicast routing table is periodically polled by
 153 .Nm
 154 in order to follow changes of existing unicast routes.
 155 .\"
 156 .Pp
 157 IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack
 158 was initially integrated into
 159 .Fx 4.0