man/en_US/ifconfig.8

   1 .TH IFCONFIG 8 "2002-07-04" "net-tools" "Linux Programmer's Manual"
   2 .SH NAME
   3 ifconfig \- configure a network interface
   4 .SH SYNOPSIS
   5 .B "ifconfig [-v] [-a] [-s] [interface]"
   6 .br
   7 .B "ifconfig [-v] interface [aftype] options | address ..."
   8 .SH DESCRIPTION
   9 .B Ifconfig
  10 is used to configure the kernel-resident network interfaces.  It is
  11 used at boot time to set up interfaces as necessary.  After that, it
  12 is usually only needed when debugging or when system tuning is needed.
  13 .LP
  14 If no arguments are given,
  15 .B ifconfig
  16 displays the status of the currently active interfaces.  If
  17 a single
  18 .B interface
  19 argument is given, it displays the status of the given interface
  20 only; if a single
  21 .B -a
  22 argument is given, it displays the status of all interfaces, even
  23 those that are down.  Otherwise, it configures an interface.
  24
  25 .SH Address Families
  26 If the first argument after the interface name is recognized as
  27 the name of a supported address family, that address family is
  28 used for decoding and displaying all protocol addresses.  Currently
  29 supported address families include
  30 .B inet
  31 (TCP/IP, default),
  32 .B inet6
  33 (IPv6),
  34 .B ax25
  35 (AMPR Packet Radio),
  36 .B ddp
  37 (Appletalk Phase 2),
  38 .B ipx
  39 (Novell IPX) and
  40 .B netrom
  41 (AMPR Packet radio).
  42 .SH OPTIONS
  43 .TP
  44 .B -a
  45 display all interfaces which are currently available, even if down
  46 .TP
  47 .B -s
  48 display a short list (like netstat -i)
  49 .TP
  50 .B -v
  51 be more verbose for some error conditions
  52 .TP
  53 .B interface
  54 The name of the interface.  This is usually a driver name followed by
  55 a unit number, for example
  56 .B eth0
  57 for the first Ethernet interface.
  58 .TP
  59 .B up
  60 This flag causes the interface to be activated.  It is implicitly
  61 specified if an address is assigned to the interface.
  62 .TP
  63 .B down
  64 This flag causes the driver for this interface to be shut down.
  65 .TP
  66 .B "[\-]arp"
  67 Enable or disable the use of the ARP protocol on this interface.
  68 .TP
  69 .B "[\-]promisc"
  70 Enable or disable the
  71 .B promiscuous
  72 mode of the interface.  If selected, all packets on the network will
  73 be received by the interface.
  74 .TP
  75 .B "[\-]allmulti"
  76 Enable or disable
  77 .B all-multicast
  78 mode.  If selected, all multicast packets on the network will be
  79 received by the interface.
  80 .TP
  81 .B "metric N"
  82 This parameter sets the interface metric.
  83 .TP
  84 .B "mtu N"
  85 This parameter sets the Maximum Transfer Unit (MTU) of an interface.
  86 .TP
  87 .B "dstaddr addr"
  88 Set the remote IP address for a point-to-point link (such as
  89 PPP).  This keyword is now obsolete; use the
  90 .B pointopoint
  91 keyword instead.
  92 .TP
  93 .B "netmask addr"
  94 Set the IP network mask for this interface.  This value defaults to the
  95 usual class A, B or C network mask (as derived from the interface IP
  96 address), but it can be set to any value.
  97 .TP
  98 .B "add addr/prefixlen"
  99 Add an IPv6 address to an interface.
 100 .TP
 101 .B "del addr/prefixlen"
 102 Remove an IPv6 address from an interface.
 103 .TP
 104 .B "tunnel aa.bb.cc.dd"
 105 Create a new SIT (IPv6-in-IPv4) device, tunnelling to the given destination.
 106 .TP
 107 .B "irq addr"
 108 Set the interrupt line used by this device.  Not all devices can
 109 dynamically change their IRQ setting.
 110 .TP
 111 .B "io_addr addr"
 112 Set the start address in I/O space for this device.
 113 .TP
 114 .B "mem_start addr"
 115 Set the start address for shared memory used by this device.  Only a
 116 few devices need this.
 117 .TP
 118 .B "media type"
 119 Set the physical port or medium type to be used by the device.  Not
 120 all devices can change this setting, and those that can vary in what
 121 values they support.  Typical values for
 122 .B type
 123 are
 124 .B 10base2
 125 (thin Ethernet),
 126 .B 10baseT
 127 (twisted-pair 10Mbps Ethernet),
 128 .B AUI
 129 (external transceiver) and so on.  The special medium type of
 130 .B auto
 131 can be used to tell the driver to auto-sense the media.  Again, not
 132 all drivers can do this.
 133 .TP
 134 .B "[-]broadcast [addr]"
 135 If the address argument is given, set the protocol broadcast
 136 address for this interface.  Otherwise, set (or clear) the
 137 .B IFF_BROADCAST
 138 flag for the interface.
 139 .TP
 140 .B "[-]pointopoint [addr]"
 141 This keyword enables the
 142 .B point-to-point
 143 mode of an interface, meaning that it is a direct link between two
 144 machines with nobody else listening on it.
 145 .br
 146 If the address argument is also given, set the protocol address of
 147 the other side of the link, just like the obsolete
 148 .B dstaddr
 149 keyword does.  Otherwise, set or clear the
 150 .B IFF_POINTOPOINT
 151 flag for the interface.
 152 .TP
 153 .B hw class address
 154 Set the hardware address of this interface, if the device driver
 155 supports this operation.  The keyword must be followed by the
 156 name of the hardware class and the printable ASCII equivalent of
 157 the hardware address.  Hardware classes currently supported include
 158 .B ether
 159 (Ethernet),
 160 .B ax25
 161 (AMPR AX.25),
 162 .B ARCnet
 163 and
 164 .B netrom
 165 (AMPR NET/ROM).
 166 .TP
 167 .B multicast
 168 Set the multicast flag on the interface. This should not normally be needed
 169 as the drivers set the flag correctly themselves.
 170 .TP
 171 .B address
 172 The IP address to be assigned to this interface.
 173 .TP
 174 .B txqueuelen length
 175 Set the length of the transmit queue of the device. It is useful to set this
 176 to small values for slower devices with a high latency (modem links, ISDN)
 177 to prevent fast bulk transfers from disturbing interactive traffic like
 178 telnet too much.
 179 .SH NOTES
 180 Since kernel release 2.2 there are no explicit interface statistics for
 181 alias interfaces anymore. The statistics printed for the original address
 182 are shared with all alias addresses on the same device. If you want per-address
 183 statistics you should add explicit accounting
 184 rules for the address using the
 185 .BR ipchains(8)
 186 command.
 187 .LP
 188 Since net-tools 1.61 ifconfig is printing byte counters with SI units. So
 189 1 KiB are 2^10 byte. Note, the numbers are truncated to one decimal (which can
 190 by quite a large error if you consider 0.1 PiB is 112.589.990.684.262
 191 bytes :)
 192 .LP
 193 Interrupt problems with Ethernet device drivers fail with EAGAIN
 194 .I (SIOCSIIFLAGS: Resource temporarily unavailable)
 195 it is most likely a interrupt conflict. See
 196 .I http://www.scyld.com/expert/irq-conflict.html
 197 for more information.
 198 .SH FILES
 199 .I /proc/net/socket
 200 .br
 201 .I /proc/net/dev
 202 .br
 203 .I /proc/net/if_inet6
 204 .SH BUGS
 205 While appletalk DDP and IPX addresses will be displayed they cannot be
 206 altered by this command.
 207 .SH SEE ALSO
 208 route(8), netstat(8), arp(8), rarp(8), ipchains(8)
 209 .br
 210 http://physics.nist.gov/cuu/Units/binary.html - Prefixes for binary multiples
 211 .SH AUTHORS
 212 Fred N. van Kempen, <waltje@uwalt.nl.mugnet.org>
 213 .br
 214 Alan Cox, <Alan.Cox@linux.org>
 215 .br
 216 Phil Blundell, <Philip.Blundell@pobox.com>
 217 .br
 218 Andi Kleen;
 219 .br
 220 Bernd Eckenfels, <net-tools@lina.inka.de>