xref: /freebsd/usr.sbin/rrenumd/rrenumd.8 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
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.\" $FreeBSD$
31.\"
32.Dd September 7, 1998
33.Dt RRENUMD 8
34.Os
35.Sh NAME
36.Nm rrenumd
37.Nd router renumbering daemon
38.Sh SYNOPSIS
39.Nm
40.Op Fl df
41.Oo
42.Fl c Ar conf_file | Fl s
43.Oc
44.Sh DESCRIPTION
45The
46.Nm
47utility transmits router renumbering request packets,
48to renumber the routers in the site network.
49.Pp
50On KAME-based systems,
51router renumbering requests are received and processed by
52.Xr rtadvd 8 .
53For other systems, refer to relevant documents.
54.Pp
55The program will daemonize itself on invocation.
56It reads configuration information from standard input if
57.Fl s
58is specified, or from
59.Ar conf_file
60if
61.Fl c Ar conf_file
62is specified.
63.Pp
64The contents of configuration information are described in
65.Xr rrenumd.conf 5 .
66.Pp
67After successful configuration,
68.Nm
69sends router renumbering
70messages periodically to configured destinations.
71Messages contain prefixes configured to be renumbered.
72.Bl -tag -width indent
73.\"
74.It Fl d
75Debug mode.
76.It Fl f
77Foreground mode.
78Do not become daemon.
79.It Fl s
80Script mode.
81Configuration information is obtained from standard input.
82.It Fl c Ar conf_file
83Specify a configuration file where configuration information is kept.
84.El
85.Sh RETURN VALUES
86The program exits with 0 on success, and non-zero on failures.
87.Sh SEE ALSO
88.Xr rrenumd.conf 5 ,
89.Xr rtadvd 8
90.Sh STANDARDS
91.Rs
92.%A Matt Crawford
93.%R RFC
94.%N 2894
95.%D August 2000
96.%T "Router Renumbering for IPv6"
97.Re
98.Sh HISTORY
99The
100.Nm
101utility first appeared in KAME IPv6 protocol stack kit.
102.\" .Sh BUGS
103.\" (to be written)
104