usr.sbin/route6d/route6d.8

   1 .\"     $FreeBSD: src/usr.sbin/route6d/route6d.8,v 1.1.2.7 2003/03/11 22:31:32 trhodes Exp $
   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 utility 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 The
  82 .Nm
  83 utility creates a static route to
  84 .Ar prefix/preflen
  85 with
  86 .Dv RTF_REJECT
  87 flag, into the kernel routing table.
  88 .\"
  89 .It Fl d
  90 Enables output of debugging message.
  91 This option also instructs
  92 .Nm
  93 to run in foreground mode
  94 (does not become daemon).
  95 .\"
  96 .It Fl D
  97 Enables extensive output of debugging message.
  98 This option also instructs
  99 .Nm
 100 to run in foreground mode
 101 (does not become daemon).
 102 .\"
 103 .It Fl h
 104 Disables the split horizon processing.
 105 .\"
 106 .It Fl l
 107 By default,
 108 .Nm
 109 will not exchange site local routes for safety reasons.
 110 This is because semantics of site local address space is rather vague
 111 (specification is still in being worked),
 112 and there is no good way to define site local boundary.
 113 With
 114 .Fl l
 115 option,
 116 .Nm
 117 will exchange site local routes as well.
 118 It must not be used on site boundary routers,
 119 since
 120 .Fl l
 121 option assumes that all interfaces are in the same site.
 122 .\"
 123 .It Fl L Ar prefix/preflen,if1[,if2...]
 124 Filter incoming routes from interfaces
 125 .Ar if1,[if2...] .
 126 The
 127 .Nm
 128 utility will accept incoming routes that are in
 129 .Ar prefix/preflen .
 130 If multiple
 131 .Fl L
 132 options are specified, any routes that match one of the options is accepted.
 133 .Li ::/0
 134 is treated specially as default route, not
 135 .Do
 136 any route that has longer prefix length than, or equal to 0
 137 .Dc .
 138 If you would like to accept any route, specify no
 139 .Fl L
 140 option.
 141 For example, with
 142 .Do
 143 .Fl L
 144 .Li 3ffe::/16,if1
 145 .Fl L
 146 .Li ::/0,if1
 147 .Dc
 148 .Nm
 149 will accept default route and routes in 6bone test address, but no others.
 150 .\"
 151 .It Fl n
 152 Do not update the kernel routing table.
 153 .\"
 154 .It Fl N Ar if1[,if2...]
 155 Do not listen to, or advertise, route from/to interfaces specified by
 156 .Ar if1,[if2...] .
 157 .\"
 158 .It Fl O Ar prefix/preflen,if1[,if2...]
 159 Restrict route advertisement toward interfaces specified by
 160 .Ar if1,[if2...] .
 161 With this option
 162 .Nm
 163 will only advertise routes that matches
 164 .Ar prefix/preflen .
 165 .\"
 166 .It Fl q
 167 Makes
 168 .Nm
 169 in listen-only mode.
 170 No advertisement is sent.
 171 .\"
 172 .It Fl s
 173 Makes
 174 .Nm
 175 to advertise the statically defined routes which exist in the kernel routing
 176 table when
 177 .Nm
 178 invoked.
 179 Announcements obey the regular split horizon rule.
 180 .\"
 181 .It Fl S
 182 This option is the same as
 183 .Fl s
 184 option except that no split horizon rule does apply.
 185 .\"
 186 .It Fl T Ar if1[,if2...]
 187 Advertise only default route, toward
 188 .Ar if1,[if2...] .
 189 .\"
 190 .It Fl t Ar tag
 191 Attach route tag
 192 .Ar tag
 193 to originated route entries.
 194 .Ar tag
 195 can be decimal, octal prefixed by
 196 .Li 0 ,
 197 or hexadecimal prefixed by
 198 .Li 0x .
 199 .\"
 200 .El
 201 .Pp
 202 Upon receipt of signal
 203 .Dv SIGINT
 204 or
 205 .Dv SIGUSR1 ,
 206 .Nm
 207 will dump the current internal state into
 208 .Pa /var/run/route6d_dump .
 209 .\"
 210 .Sh FILES
 211 .Bl -tag -width /var/run/route6d_dump -compact
 212 .It Pa /var/run/route6d_dump
 213 dumps internal state on
 214 .Dv SIGINT
 215 or
 216 .Dv SIGUSR1
 217 .El
 218 .\"
 219 .Sh SEE ALSO
 220 .Rs
 221 .%A G. Malkin
 222 .%A R. Minnear
 223 .%T RIPng for IPv6
 224 .%R RFC2080
 225 .%D January 1997
 226 .Re
 227 .\"
 228 .Sh NOTE
 229 The
 230 .Nm
 231 utility uses IPv6 advanced API,
 232 defined in RFC2292,
 233 for communicating with peers using link-local addresses.
 234 .Pp
 235 Internally
 236 .Nm
 237 embeds interface identifier into bit 32 to 63 of link-local addresses
 238 .Li ( fe80::xx
 239 and
 240 .Li ff02::xx )
 241 so they will be visible on internal state dump file
 242 .Pq Pa /var/run/route6d_dump .
 243 .Pp
 244 Routing table manipulation differs from IPv6 implementation to implementation.
 245 Currently
 246 .Nm
 247 obeys WIDE Hydrangea/KAME IPv6 kernel,
 248 and will not be able to run on other platforms.
 249 .Pp
 250 Current
 251 .Nm
 252 does not reduce the rate of the triggered updates when consecutive updates
 253 arrive.