mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-07 17:10:36 +00:00
mdoc(7) police: fix markup.
This commit is contained in:
Ruslan Ermilov
parent
d907e410f3
commit
b09b4efb4b
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=79319
|
|
@ -32,9 +32,9 @@
|
|||
.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd February 13, 1996
|
||||
.Dd July 2, 2001
|
||||
.Dt IFCONFIG 8
|
||||
.Os BSD 4.2
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ifconfig
|
||||
.Nd configure network interface parameters
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
.Op Cm create
|
||||
.Op Ar address_family
|
||||
.Oo
|
||||
.Ar address Ns Op Cm / Ns Ar prefixlength
|
||||
.Ar address Ns Op / Ns Ar prefixlength
|
||||
.Op Ar dest_address
|
||||
.Oc
|
||||
.Op Ar parameters
|
||||
|
|
@ -118,12 +118,13 @@ That is, one can specify an address like
|
|||
.\" 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
|
||||
.\" 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
|
||||
Specify the
|
||||
.Ar "address family"
|
||||
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 recommended.
|
||||
|
|
@ -146,7 +147,7 @@ This
|
|||
parameter is a string of the form
|
||||
.Dq name unit ,
|
||||
for example,
|
||||
.Dq en0 .
|
||||
.Dq Li ed0 .
|
||||
.El
|
||||
.Pp
|
||||
The following parameters may be set with
|
||||
|
|
@ -157,13 +158,16 @@ Another name for the
|
|||
.Cm alias
|
||||
parameter.
|
||||
Introduced for compatibility
|
||||
with BSD/OS.
|
||||
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.
|
||||
If the address is on the same subnet as the first network address
|
||||
for this interface, a netmask of 0xffffffff has to be specified.
|
||||
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
|
||||
|
|
@ -172,14 +176,16 @@ 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)
|
||||
(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
|
||||
|
|
@ -188,9 +194,10 @@ 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.
|
||||
|
|
@ -214,7 +221,7 @@ If possible, the interface will be reset to disable reception as well.
|
|||
This action does not automatically disable routes using the interface.
|
||||
.It Cm ether
|
||||
Another name for the
|
||||
.Dq lladdr
|
||||
.Cm lladdr
|
||||
parameter.
|
||||
.\" .It Cm ipdst
|
||||
.\" This is used to specify an Internet host who is willing to receive
|
||||
|
|
@ -226,9 +233,11 @@ parameter.
|
|||
.\" .Tn CLNP
|
||||
.\" packets is done differently.
|
||||
.It Cm lladdr Ar addr
|
||||
Set the link-level address on an interface. This can be used to
|
||||
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
|
||||
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
|
||||
|
|
@ -240,31 +249,38 @@ 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
|
||||
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
|
||||
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
|
||||
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.
|
||||
.Ar Opts
|
||||
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 Ar dest_addr
|
||||
(IP tunnel devices only)
|
||||
.It Cm tunnel Ar src_addr dest_addr
|
||||
(IP tunnel devices only.)
|
||||
Configure the physical source and destination address for IP tunnel
|
||||
interfaces (gif). The arguments
|
||||
interfaces
|
||||
.Pq Xr gif 4 .
|
||||
The arguments
|
||||
.Ar src_addr
|
||||
and
|
||||
.Ar dest_addr
|
||||
|
|
@ -279,19 +295,23 @@ 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 stdout.
|
||||
printed to standard output.
|
||||
.It Cm destroy
|
||||
Destroy the specified network pseudo-device.
|
||||
.It Cm plumb
|
||||
Another name for the
|
||||
.Fl create
|
||||
parameter.
|
||||
Included for Solaris compatibility.
|
||||
Included for
|
||||
.Tn Solaris
|
||||
compatibility.
|
||||
.It Cm unplumb
|
||||
Another name for the
|
||||
.Fl destroy
|
||||
parameter.
|
||||
Included for Solaris compatibility.
|
||||
Included for
|
||||
.Tn Solaris
|
||||
compatibility.
|
||||
.It Cm vlan Ar vlan_tag
|
||||
If the interface is a vlan pseudo interface, set the vlan tag value
|
||||
to
|
||||
|
|
@ -328,10 +348,10 @@ change the association to another physical interface, the existing
|
|||
association must be cleared first.
|
||||
.Pp
|
||||
Note: if the
|
||||
.Ar link0
|
||||
.Cm link0
|
||||
flag is set on the vlan interface, the vlan pseudo
|
||||
interface's behavior changes: the
|
||||
.Ar link0
|
||||
.Cm link0
|
||||
tells the vlan interface that the
|
||||
parent interface supports insertion and extraction of vlan tags on its
|
||||
own (usually in firmware) and that it should pass packets to and from
|
||||
|
|
@ -355,19 +375,21 @@ to the destination network or host.
|
|||
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
|
||||
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
|
||||
Not all interfaces support setting the MTU, and some interfaces have
|
||||
range restrictions.
|
||||
.It Cm netmask Ar mask
|
||||
.\" (Inet and ISO)
|
||||
(Inet only)
|
||||
.\" (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
|
||||
|
|
@ -382,7 +404,7 @@ See the
|
|||
.Ar address
|
||||
option above for more information.
|
||||
.It Cm prefixlen Ar len
|
||||
(Inet6 only)
|
||||
(Inet6 only.)
|
||||
Specify that
|
||||
.Ar len
|
||||
bits are reserved for subdividing networks into sub-networks.
|
||||
|
|
@ -432,64 +454,78 @@ Another name for the
|
|||
.Fl alias
|
||||
parameter.
|
||||
Introduced for compatibility
|
||||
with BSD/OS.
|
||||
with
|
||||
.Bsx .
|
||||
.It Cm phase
|
||||
The argument following this specifies the version (phase) of the
|
||||
Appletalk network attached to the interface.
|
||||
Values of 1 or 2 are permitted.
|
||||
.It Cm link Ns Xo
|
||||
.Op Cm 0 Ns - Ns Cm 2
|
||||
.Xc
|
||||
.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, or to select the connector type
|
||||
for some Ethernet cards. Refer to the man page for the specific driver
|
||||
for some Ethernet cards.
|
||||
Refer to the man page for the specific driver
|
||||
for more information.
|
||||
.It Fl link Ns Xo
|
||||
.Op Cm 0 Ns - Ns Cm 2
|
||||
.Xc
|
||||
.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
|
||||
.Dq up .
|
||||
This may be used to enable an interface after an
|
||||
.Dq ifconfig down .
|
||||
.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.
|
||||
.It Cm ssid Ar ssid
|
||||
For IEEE 802.11 wireless interfaces, set the desired Service Set
|
||||
Identifier (aka network name.) The SSID is a string up to 32 characters
|
||||
Identifier (aka network name).
|
||||
The SSID is a string up to 32 characters
|
||||
in length and may be specified as either a normal string or in
|
||||
hexadecimal when proceeded by
|
||||
.Sq 0x .
|
||||
.Ql 0x .
|
||||
Additionally, the SSID may be cleared by setting it to
|
||||
.Sq - .
|
||||
.Ql - .
|
||||
.It Cm nwid Ar ssid
|
||||
Another name for the
|
||||
.Dq ssid
|
||||
parameter. Included for NetBSD compatibility.
|
||||
.Cm ssid
|
||||
parameter.
|
||||
Included for
|
||||
.Nx
|
||||
compatibility.
|
||||
.It Cm stationname Ar name
|
||||
For IEEE 802.11 wireless interfaces, set the name of this station.
|
||||
It appears that the station name is not really part of the IEEE 802.11
|
||||
protocol though all interfaces seem to support it. As such it only
|
||||
protocol though all interfaces seem to support it.
|
||||
As such it only
|
||||
seems to be meaningful to identical or virtually identical equipment.
|
||||
Setting the station name is identical in syntax to setting the SSID.
|
||||
.It Cm station Ar name
|
||||
Another name for the
|
||||
.Dq stationname
|
||||
parameter. Included for BSD/OS compatibility.
|
||||
.Cm stationname
|
||||
parameter.
|
||||
Included for
|
||||
.Bsx
|
||||
compatibility.
|
||||
.It Cm channel Ar number
|
||||
For IEEE 802.11 wireless interfaces, set the desired channel.
|
||||
Channels range from 1 to 14, but the exact selection available
|
||||
depends on the region your adaptor was manufactured for. Setting
|
||||
the channel to 0 will give you the default for your adaptor. Many
|
||||
depends on the region your adaptor was manufactured for.
|
||||
Setting
|
||||
the channel to 0 will give you the default for your adaptor.
|
||||
Many
|
||||
adaptors ignore this setting unless you are in ad-hoc mode.
|
||||
.It Cm authmode Ar mode
|
||||
For IEEE 802.11 wireless interfaces, set the desired authentication mode
|
||||
in infrastructure mode. Not all adaptors support all modes. The set of
|
||||
in infrastructure mode.
|
||||
Not all adaptors support all modes.
|
||||
The set of
|
||||
valid modes is
|
||||
.Dq none ,
|
||||
.Dq open ,
|
||||
|
|
@ -498,25 +534,26 @@ and
|
|||
Modes are case insensitive.
|
||||
.It Cm powersave
|
||||
For IEEE 802.11 wireless interfaces, enable powersave mode.
|
||||
.It Cm -powersave
|
||||
.It Fl powersave
|
||||
For IEEE 802.11 wireless interfaces, disable powersave mode.
|
||||
.It Cm powersavesleep Ar sleep
|
||||
For IEEE 802.11 wireless interfaces, set the desired max powersave sleep
|
||||
time in milliseconds.
|
||||
.It Cm wepmode Ar mode
|
||||
For IEEE 802.11 wireless interfaces, set the desired WEP mode. Not all
|
||||
adaptors support all modes. The set of valid modes is
|
||||
For IEEE 802.11 wireless interfaces, set the desired WEP mode.
|
||||
Not all adaptors support all modes.
|
||||
The set of valid modes is
|
||||
.Dq off ,
|
||||
.Dq on ,
|
||||
and
|
||||
.Dq mixed .
|
||||
.Dq Mixed
|
||||
mode explicitly tells the adaptor to allow association with access
|
||||
points which allow both encrypted and unencrypted traffic. On these
|
||||
adaptors,
|
||||
points which allow both encrypted and unencrypted traffic.
|
||||
On these adaptors,
|
||||
.Dq on
|
||||
means that the access point must only allow encrypted connections. On
|
||||
other adaptors,
|
||||
means that the access point must only allow encrypted connections.
|
||||
On other adaptors,
|
||||
.Dq on
|
||||
is generally another name for
|
||||
.Dq mixed .
|
||||
|
|
@ -524,46 +561,63 @@ Modes are case insensitive.
|
|||
.It Cm weptxkey Ar index
|
||||
For IEEE 802.11 wireless interfaces, set the WEP key to be used for
|
||||
transmission.
|
||||
.It Cm wepkey Ar key|index:key
|
||||
For IEEE 802.11 wireless interfaces, set the selected WEP key. If
|
||||
an
|
||||
.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
|
||||
For IEEE 802.11 wireless interfaces, set the selected WEP key.
|
||||
If an
|
||||
.Ar index
|
||||
is not given, key 1 is set. A WEP key will be either 5 or 13
|
||||
is not given, key 1 is set.
|
||||
A WEP key will be either 5 or 13
|
||||
characters (40 or 104 bits) depending of the local network and the
|
||||
capabilities of the adaptor. It may be specified either as a plain
|
||||
capabilities of the adaptor.
|
||||
It may be specified either as a plain
|
||||
string or as a string of hexadecimal digits proceeded by
|
||||
.Sq 0x .
|
||||
.Ql 0x .
|
||||
A key may be cleared by setting it to
|
||||
.Sq - .
|
||||
If WEP is supported then there are at least four keys. Some adaptors
|
||||
support more then four keys. If that is the case, then the first four keys
|
||||
.Ql - .
|
||||
If WEP is supported then there are at least four keys.
|
||||
Some adaptors support more then four keys.
|
||||
If that is the case, then the first four keys
|
||||
(1-4) will be the standard temporary keys and any others will be adaptor
|
||||
specific keys such as permanent keys stored in NVRAM.
|
||||
.It Cm wep
|
||||
Another way of saying
|
||||
.Dq wepmode on .
|
||||
Included for BSD/OS compatibility.
|
||||
.It Cm -wep
|
||||
.Cm wepmode on .
|
||||
Included for
|
||||
.Bsx
|
||||
compatibility.
|
||||
.It Fl wep
|
||||
Another way of saying
|
||||
.Dq wepmode off .
|
||||
Included for BSD/OS compatibility.
|
||||
.Cm wepmode off .
|
||||
Included for
|
||||
.Bsx
|
||||
compatibility.
|
||||
.It Cm nwkey key
|
||||
Another way of saying:
|
||||
.Pp
|
||||
``wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-''.
|
||||
.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
|
||||
.Pp
|
||||
Included for NetBSD compatibility.
|
||||
.It Cm nwkey n:k1,k2,k3,k4
|
||||
Included for
|
||||
.Nx
|
||||
compatibility.
|
||||
.It Cm nwkey Xo
|
||||
.Sm off
|
||||
.Ar n : k1 , k2 , k3 , k4
|
||||
.Sm on
|
||||
.Xc
|
||||
Another way of saying
|
||||
.Pp
|
||||
``wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4''.
|
||||
.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
|
||||
.Pp
|
||||
Included for NetBSD compatibility.
|
||||
.It Cm -nwkey
|
||||
Included for
|
||||
.Nx
|
||||
compatibility.
|
||||
.It Fl nwkey
|
||||
Another way of saying
|
||||
.Dq wepmode off .
|
||||
.Cm wepmode off .
|
||||
.Pp
|
||||
Included for NetBSD compatibility.
|
||||
Included for
|
||||
.Nx
|
||||
compatibility.
|
||||
.El
|
||||
.Pp
|
||||
.Nm Ifconfig
|
||||
|
|
@ -578,7 +632,9 @@ media list will be included in the output.
|
|||
.Pp
|
||||
If the
|
||||
.Fl m
|
||||
flag is passed before an interface name, ifconfig will display all
|
||||
flag is passed before an interface name,
|
||||
.Nm
|
||||
will display all
|
||||
of the supported media for the specified interface.
|
||||
If
|
||||
.Fl L
|
||||
|
|
@ -587,7 +643,8 @@ as time offset string.
|
|||
.Pp
|
||||
Optionally, the
|
||||
.Fl a
|
||||
flag may be used instead of an interface name. This flag instructs
|
||||
flag may be used instead of an interface name.
|
||||
This flag instructs
|
||||
.Nm
|
||||
to display information about all interfaces in the system.
|
||||
The
|
||||
|
|
@ -602,7 +659,8 @@ is implied.
|
|||
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
|
||||
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)
|
||||
|
|
@ -634,9 +692,9 @@ 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
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
|
|
|
|||
Loading…
Reference in a new issue