1 .\" $NetBSD: ifconfig.if.5,v 1.18 2014/12/29 14:22:25 wiz Exp $
3 .\" Copyright (c) 1996 Matthew R. Green
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd interface-specific configuration files or variables
36 files or variables contain information regarding the configuration
37 of each network interface.
45 that is to be configured, there should be either an
55 .Pa /etc/ifconfig.fxp0
59 Only characters allowed in
61 variables names should be used for
64 uppercase and lowercase letters, digits, and underscore
67 The variable or file will get evaluated only if the interface exists on
69 Multiple lines can be placed in a variable or file, and will be
70 evaluated sequentially.
71 In the case of a variable, semicolons may be used instead of
72 newlines, as described in
74 .Ao backslash Ac Ns Ao newline Ac
75 sequences in files are ignored, so long logical lines may be
76 made up of several shorter physical lines.
78 Normally, a line will be evaluated as command line arguments to
80 .Dq Li ifconfig Ar nnX
81 will be prepended on evaluation.
82 Arguments with embedded shell metacharacters should be quoted in
86 If the line is equal to
89 will be started for the interface.
90 However, it is instead recommended that
94 and any per interface configuration or restriction is done in
97 If a line is empty, or starts with
99 the line will be ignored as comment.
101 If a line starts with
103 the rest of line will get evaluated as shell script fragment.
104 Shell variables declared in
105 .Pa /etc/rc.d/network
106 are accessible but may not be modified.
107 The most useful variable is
109 as it will be bound to the interface being configured with the file.
111 For example, the following illustrates static interface configuration:
112 .Bd -literal -offset indent
113 # IPv4, with an alias
114 inet 10.0.1.12 netmask 255.255.255.0 media 100baseTX
115 inet 10.0.1.13 netmask 255.255.255.255 alias
116 # let us have IPv6 address on this interface
117 inet6 2001:db8::1 prefixlen 64 alias
118 # have subnet router anycast address too
119 inet6 2001:db8:: prefixlen 64 alias anycast
122 The following example sets a network name for a wireless interface
123 (using quotes to protect special characters in the name),
126 .Bd -literal -offset indent
131 The following example is for dynamically-created pseudo interfaces like
134 .Pa /etc/rc.d/network
137 command for such interfaces,
138 but creation is now handled automatically.
139 .Bd -literal -offset indent
141 # configure IPv6 default route toward the interface
142 !route add -inet6 default ::1
143 !route change -inet6 default -ifp $int
146 .Pa /etc/rc.d/network