.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
-.\" must display the following acknowledgement:
+.\" must display the following acknowledgment:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" @(#)ifconfig.8 8.4 (Berkeley) 6/1/94
+.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
+.\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.27.2.14 2001/08/23 06:35:38 yar Exp $
.\"
-.Dd June 1, 1994
+.Dd July 2, 2001
.Dt IFCONFIG 8
-.Os BSD 4.2
+.Os
.Sh NAME
.Nm ifconfig
.Nd configure network interface parameters
.Sh SYNOPSIS
-.Nm ifconfig
-.Ar interface address_family
+.Nm
+.Op Fl L
+.Op Fl m
+.Ar interface
+.Op Cm create
+.Op Ar address_family
.Oo
-.Ar address
+.Ar address Ns Op Cm / Ns Ar prefixlength
.Op Ar dest_address
.Oc
.Op Ar parameters
-.Nm ifconfig
+.Nm
.Ar interface
-.Op Ar protocol_family
-.Nm ifconfig
+.Cm destroy
+.Nm
.Fl a
+.Op Fl L
.Op Fl d
+.Op Fl m
.Op Fl u
.Op Ar address_family
-.Nm ifconfig
+.Nm
.Fl l
.Op Fl d
.Op Fl u
.Op Ar address_family
+.Nm
+.Op Fl L
+.Op Fl d
+.Op Fl m
+.Op Fl u
.Sh DESCRIPTION
.Nm Ifconfig
is used to assign an address
a later time to redefine an interface's address
or other operating parameters.
.Pp
-Available operands for
-.Nm ifconfig:
-.Bl -tag -width Ds
-.It Ar Address
+The following options are available:
+.Bl -tag -width indent
+.It Ar address
For the
-.Tn DARPA-Internet
+.Tn DARPA Ns -Internet
family,
the address is either a host name present in the host name data
-base,
+base,
.Xr hosts 5 ,
or a
.Tn DARPA
Internet address expressed in the Internet standard
.Dq dot notation .
-For the Xerox Network Systems(tm) family,
-addresses are
-.Ar net:a.b.c.d.e.f ,
-where
-.Ar net
-is the assigned network number (in decimal),
-and each of the six bytes of the host number,
-.Ar a
-through
-.Ar f ,
-are specified in hexadecimal.
-The host number may be omitted on 10Mb/s Ethernet interfaces,
-which use the hardware physical address,
-and on interfaces other than the first.
-For the
-.Tn ISO
-family, addresses are specified as a long hexadecimal string,
-as in the Xerox family. However, two consecutive dots imply a zero
-byte, and the dots are optional, if the user wishes to (carefully)
-count out long strings of digits in network byte order.
+.Pp
+It is also possible to use the CIDR notation (also known as the
+slash notation) to include the netmask.
+That is, one can specify an address like
+.Li 192.168.0.1/16 .
+.\" For the Xerox Network Systems(tm) family,
+.\" addresses are
+.\" .Ar net:a.b.c.d.e.f ,
+.\" where
+.\" .Ar net
+.\" is the assigned network number (in decimal),
+.\" and each of the six bytes of the host number,
+.\" .Ar a
+.\" through
+.\" .Ar f ,
+.\" are specified in hexadecimal.
+.\" The host number may be omitted on IEEE 802 protocol
+.\" (Ethernet, FDDI, and Token Ring) interfaces,
+.\" which use the hardware physical address,
+.\" and on interfaces other than the first.
+.\" For the
+.\" .Tn ISO
+.\" family, addresses are specified as a long hexadecimal string,
+.\" as in the Xerox family.
+.\" However, two consecutive dots imply a zero
+.\" byte, and the dots are optional, if the user wishes to (carefully)
+.\" count out long strings of digits in network byte order.
.It Ar address_family
-Specifies the
-.Ar address family
+Specify the
+address family
which affects interpretation of the remaining parameters.
Since an interface can receive transmissions in differing protocols
-with different naming schemes, specifying the address family is recommeded.
+with different naming schemes, specifying the address family is recommended.
The address or protocol families currently
supported are
.Dq inet ,
-.Dq iso ,
-and
-.Dq ns .
-.It Ar Interface
-The
-.Ar interface
+.Dq inet6 ,
+.\" and
+.\" .Dq ns .
+.It Ar dest_address
+Specify the address of the correspondent on the other end
+of a point to point link.
+.It Ar interface
+This
parameter is a string of the form
.Dq name unit ,
for example,
-.Dq en0
+.Dq Li en0 .
.El
.Pp
-The following parameters may be set with
-.Nm ifconfig :
-.Bl -tag -width dest_addressxx
+The following parameters may be set with
+.Nm :
+.Bl -tag -width indent
+.It Cm add
+Another name for the
+.Cm alias
+parameter.
+Introduced for compatibility
+with
+.Bsx .
.It Cm alias
-Establish an additional network address for this interface. This is
-sometimes useful when changing network numbers, and one wishes to
-accept packets addressed to the old interface.
-A
-.Ar netmask
-should be used with this parameter.
-If the new (
-.Ar alias
-) address is on the same subnet as an existing address assigned to
-this interface, the netmask must be "255.255.255.255". If a netmask
-is not supplied, the command will use the one implied by the address
-itself (e.g, Class A). If the 'all ones' netmask is used, the system
-will handle route installation. If another netmask is used, a route
-to that address must be installed by hand, e.g., "route add -host
-XX.XX.XX.XX -interface 127.0.0.1", where "XX.XX.XX.XX" is the new
-alias (c.f.
-.Ar route
-(8)). In either case, the administrator may have to remove a route
-by hand when the alias is removed (
-.Ar -alias
-or
-.Ar delete
-)
+Establish an additional network address for this interface.
+This is sometimes useful when changing network numbers, and
+one wishes to accept packets addressed to the old interface.
+If the address is on the same subnet as the first network address
+for this interface, a netmask of
+.Li 0xffffffff
+has to be specified.
+.It Fl alias
+Remove the network address specified.
+This would be used if you incorrectly specified an alias, or it
+was no longer needed.
+If you have incorrectly set an NS address having the side effect
+of specifying the host portion, removing all NS addresses will
+allow you to respecify the host portion.
+.It Cm anycast
+(Inet6 only.)
+Specify that the address configured is an anycast address.
+Based on the current specification,
+only routers may configure anycast addresses.
+Anycast address will not be used as source address of any of outgoing
+IPv6 packets.
.It Cm arp
-Enable the use of the Address Resolution Protocol in mapping
+Enable the use of the Address Resolution Protocol
+.Pq Xr arp 4
+in mapping
between network level addresses and link level addresses (default).
This is currently implemented for mapping between
.Tn DARPA
Internet
-addresses and 10Mb/s Ethernet addresses.
+addresses and
+.Tn IEEE
+802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
.It Fl arp
-Disable the use of the Address Resolution Protocol.
+Disable the use of the Address Resolution Protocol
+.Pq Xr arp 4 .
.It Cm broadcast
-(Inet only)
+(Inet only.)
Specify the address to use to represent broadcasts to the
network.
The default broadcast address is the address with a host part of all 1's.
extra console error logging.
.It Fl debug
Disable driver dependent debugging code.
-.ne 1i
.It Cm delete
-Remove the network address specified.
-This would be used if you incorrectly specified an alias, or it
-was no longer needed.
-If you have incorrectly set an NS address having the side effect
-of specifying the host portion, removing all NS addresses will
-allow you to respecify the host portion.
-.It Cm dest_address
-Specify the address of the correspondent on the other end
-of a point to point link.
+Another name for the
+.Fl alias
+parameter.
.It Cm down
-Mark an interface ``down''. When an interface is
-marked ``down'', the system will not attempt to
-transmit messages through that interface.
+Mark an interface
+.Dq down .
+When an interface is marked
+.Dq down ,
+the system will not attempt to
+transmit messages through that interface.
If possible, the interface will be reset to disable reception as well.
This action does not automatically disable routes using the interface.
-.It Cm ipdst
-This is used to specify an Internet host who is willing to receive
-ip packets encapsulating NS packets bound for a remote network.
-An apparent point to point link is constructed, and
-the address specified will be taken as the NS address and network
-of the destination.
-IP encapsulation of
-.Tn CLNP
-packets is done differently.
+.It Cm ether
+Another name for the
+.Cm lladdr
+parameter.
+.\" .It Cm ipdst
+.\" This is used to specify an Internet host who is willing to receive
+.\" ip packets encapsulating NS packets bound for a remote network.
+.\" An apparent point to point link is constructed, and
+.\" the address specified will be taken as the NS address and network
+.\" of the destination.
+.\" IP encapsulation of
+.\" .Tn CLNP
+.\" packets is done differently.
+.It Cm lladdr Ar addr
+Set the link-level address on an interface.
+This can be used to
+e.g. set a new MAC address on an ethernet interface, though the
+mechanism used is not ethernet-specific.
+The address
+.Ar addr
+is specified as a series of colon-separated hex digits.
+If the interface is already
+up when this option is used, it will be briefly brought down and
+then brought back up again in order to ensure that the receive
+filter in the underlying ethernet hardware is properly reprogrammed.
+.It Cm media Ar type
+If the driver supports the media selection system, set the media type
+of the interface to
+.Ar type .
+Some interfaces support the mutually exclusive use of one of several
+different physical media connectors.
+For example, a 10Mb/s Ethernet
+interface might support the use of either
+.Tn AUI
+or twisted pair connectors.
+Setting the media type to
+.Dq 10base5/AUI
+would change the currently active connector to the AUI port.
+Setting it to
+.Dq 10baseT/UTP
+would activate twisted pair.
+Refer to the interfaces' driver
+specific documentation or man page for a complete list of the
+available types.
+.It Cm mediaopt Ar opts
+If the driver supports the media selection system, set the specified
+media options on the interface.
+The
+.Ar opts
+argument
+is a comma delimited list of options to apply to the interface.
+Refer to the interfaces' driver specific man page for a complete
+list of available options.
+.It Fl mediaopt Ar opts
+If the driver supports the media selection system, disable the
+specified media options on the interface.
+.It Cm tunnel Ar src_addr dest_addr
+(IP tunnel devices only.)
+Configure the physical source and destination address for IP tunnel
+interfaces
+.Pq Xr gif 4 .
+The arguments
+.Ar src_addr
+and
+.Ar dest_addr
+are interpreted as the outer source/destination for the encapsulating
+IPv4/IPv6 header.
+.It Cm deletetunnel
+Unconfigure the physical source and destination address for IP tunnel
+interfaces previously configured with
+.Cm tunnel .
+.It Cm create
+Create the specified network pseudo-device.
+If the interface is given without a unit number, try to create a new
+device with an arbitrary unit number.
+If creation of an arbitrary device is sucessful, the new device name is
+printed to standard output.
+.It Cm destroy
+Destroy the specified network pseudo-device.
+.It Cm plumb
+Another name for the
+.Cm create
+parameter.
+Included for
+.Tn Solaris
+compatibility.
+.It Cm unplumb
+Another name for the
+.Cm destroy
+parameter.
+Included for
+.Tn Solaris
+compatibility.
.It Cm metric Ar n
Set the routing metric of the interface to
.Ar n ,
Higher metrics have the effect of making a route
less favorable; metrics are counted as addition hops
to the destination network or host.
+.It Cm mtu Ar n
+Set the maximum transmission unit of the interface to
+.Ar n ,
+default is interface specific.
+The MTU is used to limit the size of packets that are transmitted on an
+interface.
+Not all interfaces support setting the MTU, and some interfaces have
+range restrictions.
.It Cm netmask Ar mask
-(Inet and ISO)
+.\" (Inet and ISO.)
+(Inet only.)
Specify how much of the address to reserve for subdividing
networks into sub-networks.
The mask includes the network part of the local address
and the subnet part, which is taken from the host field of the address.
The mask can be specified as a single hexadecimal number
-with a leading 0x, with a dot-notation Internet address,
+with a leading
+.Ql 0x ,
+with a dot-notation Internet address,
or with a pseudo-network name listed in the network table
.Xr networks 5 .
The mask contains 1's for the bit positions in the 32-bit address
The mask should contain at least the standard network portion,
and the subnet field should be contiguous with the network
portion.
-.\" see
+.Pp
+The netmask can also be specified in CIDR notation after the address.
+See the
+.Ar address
+option above for more information.
+.It Cm prefixlen Ar len
+(Inet6 only.)
+Specify that
+.Ar len
+bits are reserved for subdividing networks into sub-networks.
+The
+.Ar len
+must be integer, and for syntactical reason it must be between 0 to 128.
+It is almost always 64 under the current IPv6 assignment rule.
+If the parameter is omitted, 64 is used.
+.\" see
.\" Xr eon 5 .
-.It Cm nsellength Ar n
-.Pf ( Tn ISO
-only)
-This specifies a trailing number of bytes for a received
-.Tn NSAP
-used for local identification, the remaining leading part of which is
-taken to be the
-.Tn NET
-(Network Entity Title).
-The default value is 1, which is conformant to US
-.Tn GOSIP .
-When an ISO address is set in an ifconfig command,
-it is really the
-.Tn NSAP
-which is being specified.
-For example, in
-.Tn US GOSIP ,
-20 hex digits should be
-specified in the
-.Tn ISO NSAP
-to be assigned to the interface.
-There is some evidence that a number different from 1 may be useful
-for
-.Tn AFI
-37 type addresses.
-.It Cm trailers
-Request the use of a ``trailer'' link level encapsulation when
-sending (default).
-If a network interface supports
-.Cm trailers ,
-the system will, when possible, encapsulate outgoing
-messages in a manner which minimizes the number of
-memory to memory copy operations performed by the receiver.
-On networks that support the Address Resolution Protocol (see
-.Xr arp 4 ;
-currently, only 10 Mb/s Ethernet),
-this flag indicates that the system should request that other
-systems use trailers when sending to this host.
-Similarly, trailer encapsulations will be sent to other
-hosts that have made such requests.
-Currently used by Internet protocols only.
-.It Fl trailers
-Disable the use of a ``trailer'' link level encapsulation.
-.It Cm link[0-2]
+.\" .It Cm nsellength Ar n
+.\" .Pf ( Tn ISO
+.\" only)
+.\" This specifies a trailing number of bytes for a received
+.\" .Tn NSAP
+.\" used for local identification, the remaining leading part of which is
+.\" taken to be the
+.\" .Tn NET
+.\" (Network Entity Title).
+.\" The default value is 1, which is conformant to US
+.\" .Tn GOSIP .
+.\" When an ISO address is set in an ifconfig command,
+.\" it is really the
+.\" .Tn NSAP
+.\" which is being specified.
+.\" For example, in
+.\" .Tn US GOSIP ,
+.\" 20 hex digits should be
+.\" specified in the
+.\" .Tn ISO NSAP
+.\" to be assigned to the interface.
+.\" There is some evidence that a number different from 1 may be useful
+.\" for
+.\" .Tn AFI
+.\" 37 type addresses.
+.It Cm remove
+Another name for the
+.Fl alias
+parameter.
+Introduced for compatibility
+with
+.Bsx .
+.Sm off
+.It Cm link Op Cm 0 No - Cm 2
+.Sm on
Enable special processing of the link level of the interface.
These three options are interface specific in actual effect, however,
-they are in general used to select special modes of operation. An example
-of this is to enable SLIP compression. Currently, only used by SLIP.
-.ne 1i
-.It Fl link[0-2]
+they are in general used to select special modes of operation.
+An example
+of this is to enable SLIP compression, or to select the connector type
+for some Ethernet cards.
+Refer to the man page for the specific driver
+for more information.
+.Sm off
+.It Fl link Op Cm 0 No - Cm 2
+.Sm on
Disable special processing at the link level with the specified interface.
.It Cm up
-Mark an interface ``up''.
-This may be used to enable an interface after an ``ifconfig down.''
+Mark an interface
+.Dq up .
+This may be used to enable an interface after an
+.Dq Nm Cm down .
It happens automatically when setting the first address on an interface.
If the interface was reset when previously marked down,
the hardware will be re-initialized.
.El
.Pp
-Special flags for
-.Nm ifconfig:
-.Bl -tag -width Ds
-.It -a
-Produce a full listing for all available interfaces.
-.It -l
-Produce a name-only listing for all available interfaces.
-.It -d
-limit the listing to those interfaces that are down.
-.It -u
-limit the listing to those interfaces that are up.
-.El
-.Pp
-.Pp
.Nm Ifconfig
displays the current configuration for a network interface
when no optional parameters are supplied.
If a protocol family is specified,
-Ifconfig will report only the details specific to that protocol family.
+.Nm
+will report only the details specific to that protocol family.
+.Pp
+If the driver does supports the media selection system, the supported
+media list will be included in the output.
+.Pp
+If the
+.Fl m
+flag is passed before an interface name,
+.Nm
+will display all
+of the supported media for the specified interface.
+If
+.Fl L
+flag is supplied, address lifetime is displayed for IPv6 addresses,
+as time offset string.
+.Pp
+Optionally, the
+.Fl a
+flag may be used instead of an interface name.
+This flag instructs
+.Nm
+to display information about all interfaces in the system.
+The
+.Fl d
+flag limits this to interfaces that are down, and
+.Fl u
+limits this to interfaces that are up.
+When no arguments are given,
+.Fl a
+is implied.
+.Pp
+The
+.Fl l
+flag may be used to list all available interfaces on the system, with
+no other additional information.
+Use of this flag is mutually exclusive
+with all other flags and commands, except for
+.Fl d
+(only list interfaces that are down)
+and
+.Fl u
+(only list interfaces that are up).
.Pp
Only the super-user may modify the configuration of a network interface.
+.Sh NOTES
+The media selection system is relatively new and only some drivers support
+it (or have need for it).
.Sh DIAGNOSTICS
-Messages indicating the specified interface does not exit, the
+Messages indicating the specified interface does not exist, the
requested address is unknown, or the user is not privileged and
tried to alter an interface's configuration.
+.Sh BUGS
+IPv6 link-local addresses are required for several basic communication
+between IPv6 node.
+If they are deleted by
+.Nm
+manually, the kernel might show very strange behavior.
+So, such manual deletions are strongly discouraged.
.Sh SEE ALSO
.Xr netstat 1 ,
.Xr netintro 4 ,
+.\" .Xr eon 5 ,
.Xr rc 8 ,
-.Xr routed 8 ,
-.\" .Xr eon 5
+.Xr routed 8
.Sh HISTORY
The
.Nm
projects / apple / network_cmds.git / blobdiff