release/src/router/dhcpv6/dhcp6s.8

   1 .\"     $KAME: dhcp6s.8,v 1.34 2005/03/17 05:27:01 suz Exp $
   2 .\"
   3 .\" Copyright (C) 1998 and 1999 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 Sep 12, 1999
  31 .Dt DHCP6S 8
  32 .Os KAME
  33 .Sh NAME
  34 .Nm dhcp6s
  35 .Nd DHCPv6 server
  36 .\"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl c Ar configfile
  40 .Op Fl Ddf
  41 .Op Fl k Ar ctlkeyfile
  42 .Op Fl p Ar ctlport
  43 .Op Fl P Ar pid-file
  44 .Ar interface
  45 .\"
  46 .Sh DESCRIPTION
  47 .Nm
  48 replies to DHCPv6 client as DHCPv6 server.
  49 .Nm
  50 can give the following information to clients.
  51 .Bl -bullet -compact
  52 .It
  53 IPv6 prefixes for the requesting site
  54 .It
  55 Non-temporary IPv6 addresses
  56 .It
  57 A list of the DNS server addresses
  58 .It
  59 DNS Domain Search List
  60 .It
  61 A list of the NTP server addresses
  62 .It
  63 A list of the SIP server addresses
  64 .It
  65 SIP Server domain name
  66 .It
  67 A list of the NIS server addresses
  68 .It
  69 NIS domain name
  70 .It
  71 A list of the NIS+ server addresses
  72 .It
  73 NIS+ domain name
  74 .It
  75 A list of the BCMCS server addresses
  76 .It
  77 BCMCS Server domain name
  78 .El
  79 .Pp
  80 Command line options are as below:
  81 .Bl -tag -width indent
  82 .\"
  83 .It Fl c Ar configfile
  84 Use
  85 .Ar configfile
  86 as the configuration file.
  87 .It Fl d
  88 Print debugging messages.
  89 .It Fl D
  90 Even more debugging information is printed.
  91 .It Fl f
  92 Foreground mode (useful when debugging).
  93 Although
  94 .Nm
  95 usually prints warning, debugging, or error messages to
  96 .Xr syslog 8 ,
  97 it prints the messages to standard error if this option is
  98 specified.
  99 .It Fl k Ar ctlkeyfile
 100 Use
 101 .Ar ctlkeyfile
 102 to store the shared secret to authenticate the communication with
 103 .Nm dhcp6ctl .
 104 The default file name used when unspecified is
 105 .Pa /usr/local/etc/dhcp6sctlkey .
 106 The default name is intentionally same as that for
 107 .Nm dhcp6ctl
 108 so that the server and the control command can share the file when
 109 .Nm dhcp6ctl
 110 controls the server on the same node,
 111 which should be the typical case.
 112 .It Fl p Ar ctlport
 113 Use
 114 .Ar ctlport
 115 as the port number listening on to communicate with
 116 .Nm dhcp6ctl .
 117 .It Fl P Ar pid-file
 118 Use
 119 .Ar pid-file
 120 to dump the process ID of
 121 .Nm .
 122 .El
 123 .\"
 124 .Sh FILES
 125 .Bl -tag -width /usr/local/etc/dhcp6s.conf -compact
 126 .It Pa /usr/local/etc/dhcp6s.conf
 127 is the default configuration file.
 128 .It Pa /var/db/dhcp6s_duid
 129 is the default file to store the server's DUID.
 130 .It Pa /usr/local/etc/dhcp6sctlkey
 131 is the default key file to communicate with the control command.
 132 See
 133 .Xr dhcp6ctl 8
 134 for the file format.
 135 .It Pa /var/run/dhcp6s.pid
 136 is the default file that contains pid of the currently running
 137 .Nm .
 138 .El
 139 .\"
 140 .Sh SEE ALSO
 141 .Xr dhcp6s.conf 5 ,
 142 .Xr dhcp6ctl 8 ,
 143 .Xr dhcp6c 8
 144 .Rs
 145 .%A Ralph Droms, Editor
 146 .%D 2003
 147 .%T Dynamic Host Configuration Protocol for IPv6 (DHCPv6)
 148 .%R RFC 3315
 149 .Re
 150 .\"
 151 .Sh HISTORY
 152 The
 153 .Nm
 154 command first appeared in WIDE/KAME IPv6 protocol stack kit.
 155 .Pp
 156 The
 157 .Fl n Ar dnsserv
 158 command-line option was obsoleted by introducing a configuration file.
 159 .\"
 160 .Sh BUGS
 161 .Nm
 162 is incomplete and violates DHCPv6 protocol spec, in several aspects.
 163 To name a few:
 164 .Bl -enum
 165 .It
 166 it does not assign temporary IPv6 addresses
 167 .Pq nor will .
 168 .El