xref: /freebsd/usr.sbin/rrenumd/rrenumd.8 (revision e0c4386e)
1.\"	$KAME: rrenumd.8,v 1.6 2001/01/22 02:06:24 itojun Exp $
2.\"
3.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the project nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd September 7, 1998
31.Dt RRENUMD 8
32.Os
33.Sh NAME
34.Nm rrenumd
35.Nd router renumbering daemon
36.Sh SYNOPSIS
37.Nm
38.Op Fl df
39.Oo
40.Fl c Ar conf_file | Fl s
41.Oc
42.Sh DESCRIPTION
43The
44.Nm
45utility transmits router renumbering request packets,
46to renumber the routers in the site network.
47.Pp
48On KAME-based systems,
49router renumbering requests are received and processed by
50.Xr rtadvd 8 .
51For other systems, refer to relevant documents.
52.Pp
53The program will daemonize itself on invocation.
54It reads configuration information from standard input if
55.Fl s
56is specified, or from
57.Ar conf_file
58if
59.Fl c Ar conf_file
60is specified.
61.Pp
62The contents of configuration information are described in
63.Xr rrenumd.conf 5 .
64.Pp
65After successful configuration,
66.Nm
67sends router renumbering
68messages periodically to configured destinations.
69Messages contain prefixes configured to be renumbered.
70.Bl -tag -width indent
71.\"
72.It Fl d
73Debug mode.
74.It Fl f
75Foreground mode.
76Do not become daemon.
77.It Fl s
78Script mode.
79Configuration information is obtained from standard input.
80.It Fl c Ar conf_file
81Specify a configuration file where configuration information is kept.
82.El
83.Sh EXIT STATUS
84The program exits with 0 on success, and non-zero on failures.
85.Sh SEE ALSO
86.Xr rrenumd.conf 5 ,
87.Xr rtadvd 8
88.Sh STANDARDS
89.Rs
90.%A Matt Crawford
91.%R RFC
92.%N 2894
93.%D August 2000
94.%T "Router Renumbering for IPv6"
95.Re
96.Sh HISTORY
97The
98.Nm
99utility first appeared in KAME IPv6 protocol stack kit.
100.\" .Sh BUGS
101.\" (to be written)
102