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