usr.sbin/route6d/route6d.8

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