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 .Oo
  41 .Fl d
  42 .Sm off
  43 .Op Ar debug_level Op , Ar ...
  44 .Sm on
  45 .Oc
  46 .Op Fl f
  47 .Sh DESCRIPTION
  48 .Nm Pim6sd
  49 is an IPv6 multicast routing daemon, which supports
  50 PIMv2(Protocol Independent Multicast Version 2) sparse mode
  51 for IPv6.
  52 .Pp
  53 Options supported by
  54 .Nm :
  55 .Bl -tag -width Ds
  56 .It Fl c Ar configfile
  57 Specify alternate location,
  58 .Ar configfile ,
  59 for configuration file.
  60 By default,
  61 .Pa /etc/pim6sd.conf
  62 is used.
  63 .It Fl d
  64 Specify debug levels. If this option is specified without any arguments,
  65 all debug messages will be printed out.
  66 A subset of the messages to be printed out can be specified
  67 as arguments of the option.
  68 Valid debug levels are
  69 .Ic mld_proto , mld_timer , mld_member , mld ,
  70 .Ic switch , trace , mtrace , traceroute ,
  71 .Ic timeout , callout , pkt , packets ,
  72 .Ic interfaces , vif , kernel , cache ,
  73 .Ic mfc , k_cache , k_mfc , rsrr ,
  74 .Ic pim_detail , pim_hello , pim_neighbors , pim_register ,
  75 .Ic registers , pim_join_prune , pim_j_p , pim_jp ,
  76 .Ic pim_bootstrap , pim_bsr , bsr , bootstrap ,
  77 .Ic pim_asserts , pim_cand_rp , pim_c_rp , pim_rp ,
  78 .Ic rp , pim_routes , pim_routing , pim_mrt ,
  79 .Ic pim_timers , pim_rpf , rpf , pim ,
  80 .Ic routes , routing , mrt , routers ,
  81 .Ic mrouters , neighbors , timers ,
  82 and
  83 .Ic asserts .
  84 .It Fl f
  85 Do not become daemon, run in foreground. This option is for debugging
  86 use.
  87 .El
  88 .Pp
  89 .Nm Pim6sd
  90 automatically configures itself to forward on all multicast-capable
  91 interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding
  92 the "loopback interface").
  93 To override the default configuration,
  94 configuration commands may be placed in
  95 .Pa /etc/pim6sd.conf
  96 .Po
  97 or an alternative file, specified by the
  98 .Sq Fl c
  99 option
 100 .Pc .
 101 .Pp
 102 The
 103 .Nm
 104 program dumps its current routing information to a dump file when
 105 it receives a
 106 .Dv SIGUSR1
 107 signal.
 108 The information includes a list of PIM neighbors,
 109 .Nm
 110 internal multicast routing table, and
 111 BSR and RP related information. Also, the program dumps its internal
 112 statistics to a file when it receives a SIGINFO signal.
 113 .Pp
 114 When
 115 .Nm
 116 receives a SIGUSR2 signal, it rereads the configuration file and
 117 reset its debug level.
 118 .Pp
 119 The
 120 .Nm
 121 program puts its logs to a separate file
 122 .Pa Pq /var/log/pim6sd.log .
 123 The log level can be configured by the
 124 .Fl d
 125 command line option or the configuration file.
 126 .\"
 127 .Sh FILES
 128 .Bl -tag -width /etc/pim6sd.conf -compact
 129 .It Pa /etc/pim6sd.conf
 130 The default configuration file.
 131 .It Pa /var/run/pim6sd.dump
 132 The file to which
 133 .Nm
 134 dumps its internal status.
 135 .It Pa /var/run/pim6sd.stat
 136 The file to which
 137 .Nm
 138 dumps its internal statistics.
 139 .It Pa /var/log/pim6sd.log
 140 The pim6sd specific log file.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr daemon 3 ,
 144 .Xr pim6sd.conf 5
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 command is developed by Mickael Hoerdt at LSIIT Laboratory.
 149 It is based on IPv4 PIM sparse-mode
 150 .Nm pimd
 151 developed at University of Southern California,
 152 which has also been derived from
 153 .Nm mrouted .
 154 .Nm Mrouted
 155 is COPYRIGHT 1989 by The Board of Trustees of
 156 Leland Stanford Junior University.
 157 .\"
 158 .Sh BUGS
 159 .Nm Pim6sd
 160 does not contain any unicast routing engine, so a unicast routing
 161 daemon needs to run on the system.
 162 .Pp
 163 The kernel unicast routing table is periodically polled by
 164 .Nm
 165 in order to follow changes of existing unicast routes.
 166 .\"
 167 .Pp
 168 IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack
 169 was initially integrated into
 170 .Fx 4.0