Annotation of 43BSDReno/sbin/ifconfig/ifconfig.8, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"    @(#)ifconfig.8  6.12 (Berkeley) 6/24/90
                     19: .\"
                     20: .TH IFCONFIG 8 "June 24, 1990"
                     21: .UC 5
                     22: .SH NAME
                     23: ifconfig \- configure network interface parameters
                     24: .SH SYNOPSIS
                     25: .B ifconfig
                     26: interface address_family
                     27: [
                     28: .I address
                     29: [
                     30: .I dest_address
                     31: ] ] [
                     32: .I parameters
                     33: ]
                     34: .br
                     35: .B ifconfig
                     36: interface
                     37: [
                     38: protocol_family
                     39: ]
                     40: .SH DESCRIPTION
                     41: .I Ifconfig
                     42: is used to assign an address
                     43: to a network interface and/or configure
                     44: network interface parameters.
                     45: .I Ifconfig
                     46: must be used at boot time to define the network address
                     47: of each interface present on a machine; it may also be used at
                     48: a later time to redefine an interface's address
                     49: or other operating parameters.  The
                     50: .I interface
                     51: parameter is a string of the form ``name unit'', e.g. ``en0''.
                     52: .LP
                     53: Since an interface may receive transmissions in differing protocols,
                     54: each of which may require separate naming schemes, it is necessary
                     55: to specify the
                     56: .IR address_family ,
                     57: which may change the interpretation of the remaining parameters.
                     58: The address families currently supported are ``inet'', ``iso'', and ``ns''.
                     59: .LP
                     60: For the DARPA-Internet family,
                     61: the address is either a host name present in the host name data
                     62: base, 
                     63: .IR hosts (5),
                     64: or a DARPA Internet address expressed in the Internet standard
                     65: ``dot notation''.
                     66: For the Xerox Network Systems(tm) family,
                     67: addresses are 
                     68: .IR net:a.b.c.d.e.f ,
                     69: where
                     70: .I net
                     71: is the assigned network number (in decimal),
                     72: and each of the six bytes of the host number,
                     73: .I a
                     74: through
                     75: .IR f ,
                     76: are specified in hexadecimal.
                     77: The host number may be omitted on 10Mb/s Ethernet interfaces,
                     78: which use the hardware physical address,
                     79: and on interfaces other than the first.
                     80: For the ISO family, addresses are specified as a long hexadecimal string,
                     81: as in the Xerox family.  However, two consecutive dots imply a zero
                     82: byte, and the dots are optional, if the user wishes to (carefully)
                     83: count out long strings of digits in network byte order.
                     84: .PP
                     85: The following parameters may be set with 
                     86: .IR ifconfig :
                     87: .TP 15
                     88: .B up
                     89: Mark an interface ``up''. 
                     90: This may be used to enable an interface after an ``ifconfig down.''
                     91: It happens automatically when setting the first address on an interface.
                     92: If the interface was reset when previously marked down,
                     93: the hardware will be re-initialized.
                     94: .TP 15
                     95: .B down
                     96: Mark an interface ``down''.  When an interface is
                     97: marked ``down'', the system will not attempt to
                     98: transmit messages through that interface. 
                     99: If possible, the interface will be reset to disable reception as well.
                    100: This action does not automatically disable routes using the interface.
                    101: .TP 15
                    102: .B trailers
                    103: Request the use of a ``trailer'' link level encapsulation when
                    104: sending (default).
                    105: If a network interface supports
                    106: .IR trailers ,
                    107: the system will, when possible, encapsulate outgoing
                    108: messages in a manner which minimizes the number of
                    109: memory to memory copy operations performed by the receiver.
                    110: On networks that support the Address Resolution Protocol (see
                    111: .IR arp (4P);
                    112: currently, only 10 Mb/s Ethernet),
                    113: this flag indicates that the system should request that other
                    114: systems use trailers when sending to this host.
                    115: Similarly, trailer encapsulations will be sent to other
                    116: hosts that have made such requests.
                    117: Currently used by Internet protocols only.
                    118: .TP 15
                    119: .B \-trailers
                    120: Disable the use of a ``trailer'' link level encapsulation.
                    121: .TP 15
                    122: .B arp
                    123: Enable the use of the Address Resolution Protocol in mapping
                    124: between network level addresses and link level addresses (default). 
                    125: This is currently implemented for mapping between DARPA Internet
                    126: addresses and 10Mb/s Ethernet addresses.
                    127: .TP 15
                    128: .B \-arp
                    129: Disable the use of the Address Resolution Protocol.
                    130: .TP 15
                    131: .BI metric " n"
                    132: Set the routing metric of the interface to
                    133: .IR n ,
                    134: default 0.
                    135: The routing metric is used by the routing protocol
                    136: .RI ( routed (8c)).
                    137: Higher metrics have the effect of making a route
                    138: less favorable; metrics are counted as addition hops
                    139: to the destination network or host.
                    140: .TP 15
                    141: .B debug
                    142: Enable driver dependent debugging code; usually, this turns on
                    143: extra console error logging.
                    144: .TP 15
                    145: .B \-debug
                    146: Disable driver dependent debugging code.
                    147: .TP 15
                    148: .BI netmask " mask"
                    149: (Inet and Iso)
                    150: Specify how much of the address to reserve for subdividing
                    151: networks into sub-networks.
                    152: The mask includes the network part of the local address
                    153: and the subnet part, which is taken from the host field of the address.
                    154: The mask can be specified as a single hexadecimal number
                    155: with a leading 0x, with a dot-notation Internet address,
                    156: or with a pseudo-network name listed in the network table
                    157: .IR networks (5).
                    158: The mask contains 1's for the bit positions in the 32-bit address
                    159: which are to be used for the network and subnet parts,
                    160: and 0's for the host part.
                    161: The mask should contain at least the standard network portion,
                    162: and the subnet field should be contiguous with the network
                    163: portion.
                    164: .TP 15
                    165: .B dest_address
                    166: Specify the address of the correspondent on the other end
                    167: of a point to point link.
                    168: .TP 15
                    169: .B broadcast
                    170: (Inet only)
                    171: Specify the address to use to represent broadcasts to the
                    172: network.
                    173: The default broadcast address is the address with a host part of all 1's.
                    174: .TP 15
                    175: .B ipdst
                    176: This is used to specify an Internet host who is willing to receive
                    177: ip packets encapsulating NS packets bound for a remote network.
                    178: An apparent point to point link is constructed, and
                    179: the address specified will be taken as the NS address and network
                    180: of the destination.
                    181: IP encapsulation of CLNP packets is done differently, see 
                    182: .IR eon (5).
                    183: .TP 15
                    184: .B alias
                    185: Establish an additional network address for this interface.
                    186: This is sometimes useful when changing network numbers, and
                    187: one wishes to accept packets addressed to the old interface.
                    188: .TP 15
                    189: .B delete
                    190: Remove the network address specified.
                    191: This would be used if you incorrectly specified an alias, or it
                    192: was no longer needed.
                    193: If you have incorrectly set an NS address having the side effect
                    194: of specifying the host portion, removing all NS addresses will
                    195: allow you to respecify the host portion.
                    196: .TP 15
                    197: .BI nsellength " n"
                    198: (ISO only)
                    199: This specifies a trailing number of bytes for a received NSAP
                    200: used for local identification, the remaining leading part of which is
                    201: taken to be the NET (Network Entity Title).
                    202: The default value is 1, which is conformant to US GOSIP.
                    203: When an iso address is set in an ifconfig command,
                    204: it is really the NSAP which is being specified.
                    205: For example, in US GOSIP, 20 hex digits should be
                    206: specified in the ISO NSAP to be assigned to the interface.
                    207: There is some evidence that a number different 1 may be useful
                    208: for AFI 37 type addresses.
                    209: .PP
                    210: .I Ifconfig
                    211: displays the current configuration for a network interface
                    212: when no optional parameters are supplied.
                    213: If a protocol family is specified,
                    214: Ifconfig will report only the details specific to that protocol family.
                    215: .PP
                    216: Only the super-user may modify the configuration of a network interface.
                    217: .SH DIAGNOSTICS
                    218: Messages indicating the specified interface does not exit, the
                    219: requested address is unknown, or the user is not privileged and
                    220: tried to alter an interface's configuration.
                    221: .SH "SEE ALSO"
                    222: netstat(1), netintro(4), rc(8), routed(8), eon(5) 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.