diff options
Diffstat (limited to 'upstream/archlinux/man8/ifconfig.8')
| -rw-r--r-- | upstream/archlinux/man8/ifconfig.8 | 253 |
1 files changed, 253 insertions, 0 deletions
diff --git a/upstream/archlinux/man8/ifconfig.8 b/upstream/archlinux/man8/ifconfig.8 new file mode 100644 index 00000000..6f0ae3d9 --- /dev/null +++ b/upstream/archlinux/man8/ifconfig.8 @@ -0,0 +1,253 @@ +.TH IFCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual" +.SH NAME +ifconfig \- configure a network interface +.SH SYNOPSIS +.B "ifconfig [-v] [-a] [-s] [interface]" +.br +.B "ifconfig [-v] interface [aftype] options | address ..." +.SH DESCRIPTION +.B Ifconfig +is used to configure the kernel-resident network interfaces. It is +used at boot time to set up interfaces as necessary. After that, it +is usually only needed when debugging or when system tuning is needed. +.LP +If no arguments are given, +.B ifconfig +displays the status of the currently active interfaces. If +a single +.B interface +argument is given, it displays the status of the given interface +only; if a single +.B \-a +argument is given, it displays the status of all interfaces, even +those that are down. Otherwise, it configures an interface. + +.SH Address Families +If the first argument after the interface name is recognized as +the name of a supported address family, that address family is +used for decoding and displaying all protocol addresses. Currently +supported address families include +.B inet +(TCP/IP, default), +.B inet6 +(IPv6), +.B ax25 +(AMPR Packet Radio), +.B ddp +(Appletalk Phase 2), +.B ipx +(Novell IPX) and +.B netrom +(AMPR Packet radio). +All numbers supplied as parts in IPv4 dotted decimal notation may be decimal, +octal, or hexadecimal, as specified in the ISO C standard (that is, a leading 0x +or 0X implies hexadecimal; otherwise, a leading '0' implies octal; otherwise, +the number is interpreted as decimal). Use of hexadecimal and octal numbers +is not RFC-compliant and therefore its use is discouraged. +.SH OPTIONS +.TP +.B -a +display all interfaces which are currently available, even if down +.TP +.B -s +display a short list (like netstat -i) +.TP +.B -v +be more verbose for some error conditions +.TP +.B interface +The name of the interface. This is usually a driver name followed by +a unit number, for example +.B eth0 +for the first Ethernet interface. If your kernel supports alias interfaces, +you can specify them with syntax like +.B eth0:0 +for the first alias of eth0. You can use them to assign more addresses. To +delete an alias interface use +.BR "ifconfig eth0:0 down" . +Note: for every scope (i.e. same net with address/netmask combination) all +aliases are deleted, if you delete the first (primary). +.TP +.B up +This flag causes the interface to be activated. It is implicitly +specified if an address is assigned to the interface; you can suppress this +behavior when using an alias interface by appending an +.BR "-" +to the alias (e.g. +.BR "eth0:0-" ). +It is also suppressed when using the IPv4 0.0.0.0 address as the kernel will +use this to implicitly delete alias interfaces. +.TP +.B down +This flag causes the driver for this interface to be shut down. +.TP +.B "[\-]arp" +Enable or disable the use of the ARP protocol on this interface. +.TP +.B "[\-]promisc" +Enable or disable the +.B promiscuous +mode of the interface. If selected, all packets on the network will +be received by the interface. +.TP +.B "[\-]allmulti" +Enable or disable +.B all-multicast +mode. If selected, all multicast packets on the network will be +received by the interface. +.TP +.B "mtu N" +This parameter sets the Maximum Transfer Unit (MTU) of an interface. +.TP +.B "dstaddr addr" +Set the remote IP address for a point-to-point link (such as +PPP). This keyword is now obsolete; use the +.B pointopoint +keyword instead. +.TP +.B "netmask addr" +Set the IP network mask for this interface. This value defaults to the +usual class A, B or C network mask (as derived from the interface IP +address), but it can be set to any value. +.TP +.B "add addr/prefixlen" +Add an IPv6 address to an interface. +.TP +.B "del addr/prefixlen" +Remove an IPv6 address from an interface. +.TP +.B "tunnel ::aa.bb.cc.dd" +Create a new SIT (IPv6-in-IPv4) device, tunnelling to the given destination. +.TP +.B "irq addr" +Set the interrupt line used by this device. Not all devices can +dynamically change their IRQ setting. +.TP +.B "io_addr addr" +Set the start address in I/O space for this device. +.TP +.B "mem_start addr" +Set the start address for shared memory used by this device. Only a +few devices need this. +.TP +.B "media type" +Set the physical port or medium type to be used by the device. Not +all devices can change this setting, and those that can vary in what +values they support. Typical values for +.B type +are +.B 10base2 +(thin Ethernet), +.B 10baseT +(twisted-pair 10Mbps Ethernet), +.B AUI +(external transceiver) and so on. The special medium type of +.B auto +can be used to tell the driver to auto-sense the media. Again, not +all drivers can do this. +.TP +.B "[\-]broadcast [addr]" +If the address argument is given, set the protocol broadcast +address for this interface. Otherwise, set (or clear) the +.B IFF_BROADCAST +flag for the interface. +.TP +.B "[\-]pointopoint [addr]" +This keyword enables the +.B point-to-point +mode of an interface, meaning that it is a direct link between two +machines with nobody else listening on it. +.br +If the address argument is also given, set the protocol address of +the other side of the link, just like the obsolete +.B dstaddr +keyword does. Otherwise, set or clear the +.B IFF_POINTOPOINT +flag for the interface. +.TP +.B hw class address +Set the hardware address of this interface, if the device driver +supports this operation. The keyword must be followed by the +name of the hardware class and the printable ASCII equivalent of +the hardware address. Hardware classes currently supported include +.B ether +(Ethernet), +.B ax25 +(AMPR AX.25), +.B ARCnet +and +.B netrom +(AMPR NET/ROM). +.TP +.B multicast +Set the multicast flag on the interface. This should not normally be needed +as the drivers set the flag correctly themselves. +.TP +.B address +The IP address to be assigned to this interface. +.TP +.B txqueuelen length +Set the length of the transmit queue of the device. It is useful to set this +to small values for slower devices with a high latency (modem links, ISDN) +to prevent fast bulk transfers from disturbing interactive traffic like +telnet too much. +.TP +.B name \fInewname\fR +Change the name of this interface to \fInewname\fR. The interface must be shut +down first. +.SH NOTES +Since kernel release 2.2 there are no explicit interface statistics for +alias interfaces anymore. The statistics printed for the original address +are shared with all alias addresses on the same device. If you want per-address +statistics you should add explicit accounting +rules for the address using the +.BR iptables (8) +command. +.LP +Since net\-tools 1.60\-4 ifconfig is printing byte counters and human readable +counters with IEC 60027-2 units. So 1 KiB are 2^10 byte. Note, the numbers +are truncated to one decimal (which can by quite a large error if you +consider 0.1 PiB is 112.589.990.684.262 bytes :) +.LP +Interrupt problems with Ethernet device drivers fail with EAGAIN +.I (SIOCSIIFLAGS: Resource temporarily unavailable) +it is most likely a interrupt conflict. See +.I http://www.scyld.com/expert/irq\-conflict.html +for more information. +.SH FILES +.I /proc/net/dev +.br +.I /proc/net/if_inet6 +.SH BUGS +Ifconfig uses the ioctl access method to get the full address information, +which limits hardware addresses to 8 bytes. +Because Infiniband hardware address has 20 bytes, +only the first 8 bytes are displayed correctly. +Please use +.B ip link +command from +.B iproute2 +package to display link layer informations including the hardware address. +.LP +While appletalk DDP and IPX addresses will be displayed they cannot be +altered by this command. +.SH SEE ALSO +.BR route (8), +.BR netstat (8), +.BR arp (8), +.BR rarp (8), +.BR iptables (8), +.BR ifup (8), +.BR interfaces (5) +.br +http://physics.nist.gov/cuu/Units/binary.html - Prefixes for binary multiples +.SH AUTHORS +Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org> +.br +Alan Cox, <Alan.Cox@linux.org> +.br +Phil Blundell, <Philip.Blundell@pobox.com> +.br +Andi Kleen +.br +Bernd Eckenfels, <net\-tools@lina.inka.de> |