release/src/router/dhcpv6/dhcp6relay.8

   1 .\"     $KAME: dhcp6relay.8,v 1.19 2005/03/02 04:56:49 suz Exp $
   2 .\"
   3 .\" Copyright (C) 2000 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 Apr 18, 2000
  31 .Dt DHCP6RELAY 8
  32 .Os KAME
  33 .Sh NAME
  34 .Nm dhcp6relay
  35 .Nd DHCPv6 relay agent
  36 .\"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl Ddf
  40 .Op Fl b Ar boundaddr
  41 .Op Fl H Ar hoplim
  42 .Op Fl r Ar relay-IF
  43 .Op Fl s Ar serveraddr
  44 .Op Fl S Ar script-file
  45 .Op Fl p Ar pid-file
  46 .Ar interface ...
  47 .\"
  48 .Sh DESCRIPTION
  49 .Nm
  50 acts as an intermediary to deliver DHCPv6 messages between clients and
  51 servers, and is on the same link as a client.
  52 .\"
  53 .Nm
  54 needs command line arguments
  55 .Ar interface ... ,
  56 which specifies the list of links accommodating clients.
  57 .Pp
  58 Options supported by
  59 .Nm
  60 are:
  61 .Bl -tag -width Ds
  62 .It Fl d
  63 Print debugging messages.
  64 .It Fl D
  65 Even more debugging information is printed.
  66 .It Fl f
  67 Foreground mode (useful when debugging).
  68 Although
  69 .Nm
  70 usually prints warning, debugging, or error messages to
  71 .Xr syslog 8 ,
  72 it prints the messages to standard error if this option is
  73 specified.
  74 .It Fl b Ar boundaddr
  75 Specifies the source address to relay packets to servers (or other
  76 agents).
  77 .It Fl H Ar hoplim
  78 Specifies the hop limit of DHCPv6 Solicit messages forwarded to
  79 servers.
  80 .It Fl r Ar relay-IF
  81 Specifies the interface on which messages to servers are sent.
  82 When omitted, the same interface as
  83 .Ar interface
  84 will be used.
  85 When multiple
  86 .Ar interface
  87 are specified, this option cannot be omitted.
  88 .It Fl s Ar serveraddr
  89 Specifies the DHCPv6 server address to relay packets to.
  90 If not specified, packets are relayed to ff05::1:3 (All DHCPv6 servers).
  91 .It Fl S Ar script-file
  92 Specifies the script file to be executed when
  93 .Nm
  94 receives a RELAY-REPLY message from a DHCPv6 server.  Further detail of the
  95 script file syntax is available in
  96 .Xr dhcp6c 8
  97 .It Fl p Ar pid-file
  98 Use
  99 .Ar pid-file
 100 to dump the process ID of
 101 .Nm .
 102 .El
 103 .\"
 104 .Sh FILES
 105 .Bl -tag -width /var/run/dhcp6relay.pid -compact
 106 .It Pa /var/run/dhcp6relay.pid
 107 is the default file that contains pid of the currently running
 108 .Nm .
 109 .El
 110
 111 .Sh SEE ALSO
 112 .Xr dhcp6c 8 ,
 113 .Xr dhcp6s 8
 114 .Rs
 115 .%A Ralph Droms, Editor
 116 .%D 2003
 117 .%T Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
 118 .%R RFC 3315
 119 .Re
 120 .\"
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 command first appeared in WIDE/KAME IPv6 protocol stack kit.
 125 .\"
 126 .Bl -enum
 127 .El