[thirdparty/dhcpcd.git] / dhcpcd.conf.5.in

.\" Copyright 2006-2008 Roy Marples
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 May 20, 2008
.Dt DHCPCD.CONF 5 SMM
.Sh NAME
.Nm dhcpcd.conf
.Nd dhcpcd configuration file 
.Sh DESCRIPTION
Although
.Nm dhcpcd
can do everything from the command line, there are cases where it's just easier
to do it once in a configuration file. Most of the options found in
.Xr dhcpcd 8
can be used here. The first word on the line is the option and the rest of the
line is the value. Leading and trailing whitespace for the option and value
are trimmed. You can escape characters in the value using the \\ character.
.Pp
Blank lines and lines starting with # are ignored.
.Pp
Here's a list of available options:
.Bl -tag -width indent
.It Ic classid Ar string
Change the default classid sent from dhcpcd-version. If not set then none
is sent.
.It Ic clientid Ar string
Change the default clientid sent from the interface hardware address.
If the string is of the format 01:02:03 then it is encoded as hex.
If not set then none is sent.
.It Ic duid
Generate an
.Rs
.%T "RFC 4361"
.Re
compliant clientid. This requires persistent storage
and not all DHCP servers work with it so it's not enabled by default.
The duid generated will be held in
.Pa @SYSCONFDIR@/dhcpcd.duid
and should not be copied to other hosts.
.It Ic hostname Ar name
Sends specified
.Ar hostname 
to the DHCP server so it can be registered in DNS. If
.Ar hostname
if a FQDN (ie, contains a .) then it will be encoded as such.
.It Ic fqdn Op none | ptr | both
none disables FQDN encoding, ptr just asks the DHCP server to update the PTR
record of the host in DNS whereas both also updates the A record.
The current hostname or the hostname specified using the
.Fl h , -hostname
option must be a FQDN.
.Nm dhcpcd
itself never does any DNS updates.
.It Ic interface Ar interface
Subsequent options are only parsed for this
.Ar interface .
.It Ic leasetime Ar seconds
Request a leasetime of
.Ar seconds .
.It Ic noarp
Don't send any ARP requests. This also disables IPv4LL.
.It Ic nogateway
Don't install any default routes.
.It Ic noipv4ll
Don't attempt to obtain an IPv4LL address if we failed to get one via DHCP.
See
.Rs
.%T "RFC 3927"
.Re
.It Ic option Ar dhcp-option
Requests the
.Ar dhcp-option
from the server. It can be a variable to be used in
.Xr dhcpcd.sh 8
or the numerical value. You can specify more seperated by commas, spaces or
more option lines.
.It Ic script Ar script
Use
.Ar script
instead of the default
.Pa @SCRIPT@ .
.It Ic timeout Ar seconds
The default timeout for waiting for a DHCP response is 20 seconds which may
be too long or too short and can be changed here.
.It Ic userclass Ar string
Tag the DHCP messages with the userclass. You can specify more than one.
.El
.Sh SEE ALSO
.Xr dhcpcd.sh 8 ,
.Xr dhcpcd 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
.Sh BUGS
Please report them to http://bugs.marples.name
Commit	Line	Data
ba9dfb7a RM	1	.\" Copyright 2006-2008 Roy Marples
	2	.\" All rights reserved
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	17	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	18	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	19	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	21	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	22	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	23	.\" SUCH DAMAGE.
	24	.\"
0aeb350c	25	.Dd May 20, 2008
ba9dfb7a RM	26	.Dt DHCPCD.CONF 5 SMM
	27	.Sh NAME
	28	.Nm dhcpcd.conf
	29	.Nd dhcpcd configuration file
	30	.Sh DESCRIPTION
	31	Although
	32	.Nm dhcpcd
	33	can do everything from the command line, there are cases where it's just easier
	34	to do it once in a configuration file. Most of the options found in
	35	.Xr dhcpcd 8
	36	can be used here. The first word on the line is the option and the rest of the
967194ef	37	line is the value. Leading and trailing whitespace for the option and value
eaa90296	38	are trimmed. You can escape characters in the value using the \\ character.
967194ef RM	39	.Pp
967194ef RM	40	Blank lines and lines starting with # are ignored.
ba9dfb7a RM	41	.Pp
	42	Here's a list of available options:
	43	.Bl -tag -width indent
d2616b08 RM	44	.It Ic classid Ar string
	45	Change the default classid sent from dhcpcd-version. If not set then none
	46	is sent.
	47	.It Ic clientid Ar string
	48	Change the default clientid sent from the interface hardware address.
	49	If the string is of the format 01:02:03 then it is encoded as hex.
	50	If not set then none is sent.
	51	.It Ic duid
	52	Generate an
	53	.Rs
	54	.%T "RFC 4361"
	55	.Re
	56	compliant clientid. This requires persistent storage
	57	and not all DHCP servers work with it so it's not enabled by default.
	58	The duid generated will be held in
	59	.Pa @SYSCONFDIR@/dhcpcd.duid
	60	and should not be copied to other hosts.
ba9dfb7a	61	.It Ic hostname Ar name
35ff0dbb RM	62	Sends specified
35ff0dbb RM	63	.Ar hostname
d2616b08	64	to the DHCP server so it can be registered in DNS. If
35ff0dbb	65	.Ar hostname
d2616b08	66	if a FQDN (ie, contains a .) then it will be encoded as such.
35ff0dbb RM	67	.It Ic fqdn Op none \| ptr \| both
	68	none disables FQDN encoding, ptr just asks the DHCP server to update the PTR
	69	record of the host in DNS whereas both also updates the A record.
1b3bc477 RM	70	The current hostname or the hostname specified using the
	71	.Fl h , -hostname
	72	option must be a FQDN.
	73	.Nm dhcpcd
	74	itself never does any DNS updates.
3adc5520	75	.It Ic interface Ar interface
012fd5d3 RM	76	Subsequent options are only parsed for this
012fd5d3 RM	77	.Ar interface .
ba9dfb7a RM	78	.It Ic leasetime Ar seconds
	79	Request a leasetime of
	80	.Ar seconds .
ba9dfb7a RM	81	.It Ic noarp
	82	Don't send any ARP requests. This also disables IPv4LL.
	83	.It Ic nogateway
	84	Don't install any default routes.
	85	.It Ic noipv4ll
	86	Don't attempt to obtain an IPv4LL address if we failed to get one via DHCP.
	87	See
	88	.Rs
	89	.%T "RFC 3927"
	90	.Re
d2616b08 RM	91	.It Ic option Ar dhcp-option
	92	Requests the
	93	.Ar dhcp-option
	94	from the server. It can be a variable to be used in
	95	.Xr dhcpcd.sh 8
	96	or the numerical value. You can specify more seperated by commas, spaces or
	97	more option lines.
0aeb350c RM	98	.It Ic script Ar script
	99	Use
	100	.Ar script
	101	instead of the default
	102	.Pa @SCRIPT@ .
d2616b08 RM	103	.It Ic timeout Ar seconds
	104	The default timeout for waiting for a DHCP response is 20 seconds which may
	105	be too long or too short and can be changed here.
	106	.It Ic userclass Ar string
	107	Tag the DHCP messages with the userclass. You can specify more than one.
eaa90296	108	.El
ba9dfb7a RM	109	.Sh SEE ALSO
	110	.Xr dhcpcd.sh 8 ,
	111	.Xr dhcpcd 8
	112	.Sh AUTHORS
eaa90296	113	.An Roy Marples <roy@marples.name>
ba9dfb7a RM	114	.Sh BUGS
ba9dfb7a RM	115	Please report them to http://bugs.marples.name