128 lines
3.7 KiB
Groff
128 lines
3.7 KiB
Groff
.\" $KAME: dhcp6relay.8,v 1.19 2005/03/02 04:56:49 suz Exp $
|
|
.\"
|
|
.\" Copyright (C) 2000 WIDE Project.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the project nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd Apr 18, 2000
|
|
.Dt DHCP6RELAY 8
|
|
.Os KAME
|
|
.Sh NAME
|
|
.Nm dhcp6relay
|
|
.Nd DHCPv6 relay agent
|
|
.\"
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl Ddf
|
|
.Op Fl b Ar boundaddr
|
|
.Op Fl H Ar hoplim
|
|
.Op Fl r Ar relay-IF
|
|
.Op Fl s Ar serveraddr
|
|
.Op Fl S Ar script-file
|
|
.Op Fl p Ar pid-file
|
|
.Ar interface ...
|
|
.\"
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
acts as an intermediary to deliver DHCPv6 messages between clients and
|
|
servers, and is on the same link as a client.
|
|
.\"
|
|
.Nm
|
|
needs command line arguments
|
|
.Ar interface ... ,
|
|
which specifies the list of links accommodating clients.
|
|
.Pp
|
|
Options supported by
|
|
.Nm
|
|
are:
|
|
.Bl -tag -width Ds
|
|
.It Fl d
|
|
Print debugging messages.
|
|
.It Fl D
|
|
Even more debugging information is printed.
|
|
.It Fl f
|
|
Foreground mode (useful when debugging).
|
|
Although
|
|
.Nm
|
|
usually prints warning, debugging, or error messages to
|
|
.Xr syslog 8 ,
|
|
it prints the messages to standard error if this option is
|
|
specified.
|
|
.It Fl b Ar boundaddr
|
|
Specifies the source address to relay packets to servers (or other
|
|
agents).
|
|
.It Fl H Ar hoplim
|
|
Specifies the hop limit of DHCPv6 Solicit messages forwarded to
|
|
servers.
|
|
.It Fl r Ar relay-IF
|
|
Specifies the interface on which messages to servers are sent.
|
|
When omitted, the same interface as
|
|
.Ar interface
|
|
will be used.
|
|
When multiple
|
|
.Ar interface
|
|
are specified, this option cannot be omitted.
|
|
.It Fl s Ar serveraddr
|
|
Specifies the DHCPv6 server address to relay packets to.
|
|
If not specified, packets are relayed to ff05::1:3 (All DHCPv6 servers).
|
|
.It Fl S Ar script-file
|
|
Specifies the script file to be executed when
|
|
.Nm
|
|
receives a RELAY-REPLY message from a DHCPv6 server. Further detail of the
|
|
script file syntax is available in
|
|
.Xr dhcp6c 8
|
|
.It Fl p Ar pid-file
|
|
Use
|
|
.Ar pid-file
|
|
to dump the process ID of
|
|
.Nm .
|
|
.El
|
|
.\"
|
|
.Sh FILES
|
|
.Bl -tag -width /var/run/dhcp6relay.pid -compact
|
|
.It Pa /var/run/dhcp6relay.pid
|
|
is the default file that contains pid of the currently running
|
|
.Nm .
|
|
.El
|
|
|
|
.Sh SEE ALSO
|
|
.Xr dhcp6c 8 ,
|
|
.Xr dhcp6s 8
|
|
.Rs
|
|
.%A Ralph Droms, Editor
|
|
.%D 2003
|
|
.%T Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
|
|
.%R RFC 3315
|
|
.Re
|
|
.\"
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
command first appeared in WIDE/KAME IPv6 protocol stack kit.
|
|
.\"
|
|
.Bl -enum
|
|
.El
|