usr.sbin/route6d/route6d.8

   1 .\"     $FreeBSD$
   2 .\"     $KAME: route6d.8,v 1.10 2000/11/24 11:57:18 itojun Exp $
   3 .\"
   4 .\" Copyright (c) 1996 WIDE Project. All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modifications, are permitted provided that the above copyright notice
   8 .\" and this paragraph are duplicated in all such forms and that any
   9 .\" documentation, advertising materials, and other materials related to
  10 .\" such distribution and use acknowledge that the software was developed
  11 .\" by the WIDE Project, Japan. The name of the Project may not be used to
  12 .\" endorse or promote products derived from this software without
  13 .\" specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS''
  14 .\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
  15 .\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  16 .\" A PARTICULAR PURPOSE.
  17 .Dd January 31, 1997
  18 .Dt ROUTE6D 8
  19 .Os
  20 .Sh NAME
  21 .Nm route6d
  22 .Nd RIP6 Routing Daemon
  23 .Sh SYNOPSIS
  24 .Nm
  25 .Op Fl adDhlnqsS
  26 .Bk -words
  27 .Op Fl R Ar routelog
  28 .Ek
  29 .Bk -words
  30 .Op Fl A Ar prefix/preflen,if1[,if2...\&]
  31 .Ek
  32 .Bk -words
  33 .Op Fl L Ar prefix/preflen,if1[,if2...\&]
  34 .Ek
  35 .Bk -words
  36 .Op Fl N Ar if1[,if2...\&]
  37 .Ek
  38 .Bk -words
  39 .Op Fl O Ar prefix/preflen,if1[,if2...\&]
  40 .Ek
  41 .Bk -words
  42 .Op Fl T Ar if1[,if2...\&]
  43 .Ek
  44 .Bk -words
  45 .Op Fl t Ar tag
  46 .Ek
  47 .\"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 is a routing daemon which supports RIP over IPv6.
  52 .Pp
  53 Options are:
  54 .Bl -tag -width indent
  55 .\"
  56 .It Fl a
  57 Enables aging of the statically defined routes.
  58 With this option, any
  59 statically defined routes will be removed unless corresponding updates
  60 arrive as if the routes are received at the startup of
  61 .Nm .
  62 .\"
  63 .It Fl R Ar routelog
  64 This option makes the
  65 .Nm
  66 to log the route change (add/delete) to the file
  67 .Ar routelog .
  68 .\"
  69 .It Fl A Ar prefix/preflen,if1[,if2...]
  70 This option is used for aggregating routes.
  71 .Ar prefix/preflen
  72 specifies the prefix and the prefix length of the
  73 aggregated route.
  74 When advertising routes,
  75 .Nm
  76 filters specific routes covered by the aggregate,
  77 and advertises the aggregated route
  78 .Ar prefix/preflen ,
  79 to the interfaces specified in the comma-separated interface list,
  80 .Ar if1[,if2...] .
  81 .Nm
  82 creates a static route to
  83 .Ar prefix/preflen
  84 with
  85 .Dv RTF_REJECT
  86 flag, into the kernel routing table.
  87 .\"
  88 .It Fl d
  89 Enables output of debugging message.
  90 This option also instructs
  91 .Nm
  92 to run in foreground mode
  93 (does not become daemon).
  94 .\"
  95 .It Fl D
  96 Enables extensive output of debugging message.
  97 This option also instructs
  98 .Nm
  99 to run in foreground mode
 100 (does not become daemon).
 101 .\"
 102 .It Fl h
 103 Disables the split horizon processing.
 104 .\"
 105 .It Fl l
 106 By default,
 107 .Nm
 108 will not exchange site local routes for safety reasons.
 109 This is because semantics of site local address space is rather vague
 110 (specification is still in being worked),
 111 and there is no good way to define site local boundary.
 112 With
 113 .Fl l
 114 option,
 115 .Nm
 116 will exchange site local routes as well.
 117 It must not be used on site boundary routers,
 118 since
 119 .Fl l
 120 option assumes that all interfaces are in the same site.
 121 .\"
 122 .It Fl L Ar prefix/preflen,if1[,if2...]
 123 Filter incoming routes from interfaces
 124 .Ar if1,[if2...] .
 125 .Nm
 126 will accept incoming routes that are in
 127 .Ar prefix/preflen .
 128 If multiple
 129 .Fl L
 130 options are specified, any routes that match one of the options is accepted.
 131 .Li ::/0
 132 is treated specially as default route, not
 133 .Do
 134 any route that has longer prefix length than, or equal to 0
 135 .Dc .
 136 If you would like to accept any route, specify no
 137 .Fl L
 138 option.
 139 For example, with
 140 .Do
 141 .Fl L
 142 .Li 3ffe::/16,if1
 143 .Fl L
 144 .Li ::/0,if1
 145 .Dc
 146 .Nm
 147 will accept default route and routes in 6bone test address, but no others.
 148 .\"
 149 .It Fl n
 150 Do not update the kernel routing table.
 151 .\"
 152 .It Fl N Ar if1[,if2...]
 153 Do not listen to, or advertise, route from/to interfaces specified by
 154 .Ar if1,[if2...] .
 155 .\"
 156 .It Fl O Ar prefix/preflen,if1[,if2...]
 157 Restrict route advertisement toward interfaces specified by
 158 .Ar if1,[if2...] .
 159 With this option
 160 .Nm
 161 will only advertise routes that matches
 162 .Ar prefix/preflen .
 163 .\"
 164 .It Fl q
 165 Makes
 166 .Nm
 167 in listen-only mode.
 168 No advertisement is sent.
 169 .\"
 170 .It Fl s
 171 Makes
 172 .Nm
 173 to advertise the statically defined routes which exist in the kernel routing
 174 table when
 175 .Nm
 176 invoked.
 177 Announcements obey the regular split horizon rule.
 178 .\"
 179 .It Fl S
 180 This option is the same as
 181 .Fl s
 182 option except that no split horizon rule does apply.
 183 .\"
 184 .It Fl T Ar if1[,if2...]
 185 Advertise only default route, toward
 186 .Ar if1,[if2...] .
 187 .\"
 188 .It Fl t Ar tag
 189 Attach route tag
 190 .Ar tag
 191 to originated route entries.
 192 .Ar tag
 193 can be decimal, octal prefixed by
 194 .Li 0 ,
 195 or hexadecimal prefixed by
 196 .Li 0x .
 197 .\"
 198 .El
 199 .Pp
 200 Upon receipt of signal
 201 .Dv SIGINT
 202 or
 203 .Dv SIGUSR1 ,
 204 .Nm
 205 will dump the current internal state into
 206 .Pa /var/run/route6d_dump .
 207 .\"
 208 .Sh FILES
 209 .Bl -tag -width /var/run/route6d_dump -compact
 210 .It Pa /var/run/route6d_dump
 211 dumps internal state on
 212 .Dv SIGINT
 213 or
 214 .Dv SIGUSR1
 215 .El
 216 .\"
 217 .Sh SEE ALSO
 218 .Rs
 219 .%A G. Malkin
 220 .%A R. Minnear
 221 .%T RIPng for IPv6
 222 .%R RFC2080
 223 .%D January 1997
 224 .Re
 225 .\"
 226 .Sh NOTE
 227 .Nm
 228 uses IPv6 advanced API,
 229 defined in RFC2292,
 230 for communicating with peers using link-local addresses.
 231 .Pp
 232 Internally
 233 .Nm
 234 embeds interface identifier into bit 32 to 63 of link-local addresses
 235 .Li ( fe80::xx
 236 and
 237 .Li ff02::xx )
 238 so they will be visible on internal state dump file
 239 .Pq Pa /var/run/route6d_dump .
 240 .Pp
 241 Routing table manipulation differs from IPv6 implementation to implementation.
 242 Currently
 243 .Nm
 244 obeys WIDE Hydrangea/KAME IPv6 kernel,
 245 and will not be able to run on other platforms.
 246 .Pp
 247 Current
 248 .Nm
 249 does not reduce the rate of the triggered updates when consecutive updates
 250 arrive.