Documentation for ifmedia & updated ifconfig usage

1 files changed, 69 insertions, 11 deletions

diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8
index d5374b14a94..9fd17bc60c8 100644
--- a/sbin/ifconfig/ifconfig.8
+++ b/sbin/ifconfig/ifconfig.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: ifconfig.8,v 1.12 1998/08/29 21:11:06 deraadt Exp $
+.\"	$OpenBSD: ifconfig.8,v 1.13 1998/09/03 23:08:09 jason Exp $
 .\"	$NetBSD: ifconfig.8,v 1.11 1996/01/04 21:27:29 pk Exp $
 .\"     $FreeBSD: ifconfig.8,v 1.16 1998/02/01 07:03:29 steve Exp $
 .\"
@@ -35,7 +35,7 @@
 .\"
 .\"     @(#)ifconfig.8	8.4 (Berkeley) 6/1/94
 .\"
-.Dd June 1, 1994
+.Dd Sept 3, 1998
 .Dt IFCONFIG 8
 .Os BSD 4.2
 .Sh NAME
@@ -53,9 +53,15 @@
 .Ar interface
 .Op Ar address_family
 .Nm ifconfig
-.Fl a
+.Fl m
+.Ar interface
+.Op address_family
 .Nm ifconfig
-.Fl A
+.Op Fl a | am
+.Op Ar address_family
+.Nm ifconfig
+.Op Fl A | Am
+.Op Ar address_family
 .Sh DESCRIPTION
 .Nm Ifconfig
 is used to assign an address
@@ -183,6 +189,39 @@ of the destination.
 IP encapsulation of
 .Tn CLNP
 packets is done differently.
+.It Cm media Ar type
+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
+or
+.Dq AUI
+would change the currently active connector to the AUI port.
+Setting it to
+.Dq 10baseT
+or
+.Dq UTP
+would activate twisted pair.  Refer to the interfaces' driver
+specific man page for a complete list of the available types.
+.It Cm mediaopt Ar opts
+Set the specified media options on the interface.
+.Ar opts
+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
+Disable the specified media options on the interface.
+.It Cm instance Ar minst
+Set the media instance to
+.Ar minst .
+This is useful for devices which have multiple physical layer interfaces
+(PHYs).  Setting the instance on such devices may not be strictly required
+by the network interface driver as the driver may take care of this
+automatically; see the driver's manual page for more information.
 .It Cm metric Ar n
 Set the routing metric of the interface to
 .Ar n ,
@@ -286,15 +325,27 @@ when no optional parameters are supplied.
 If a protocol family is specified,
 ifconfig will report only the details specific to that protocol family.
 .Pp
-The interface name
-.Fl a
-causes information on all interfaces to be displayed.
-The protocol family may be specified as well.
+Using
+.Fl a ,
+causes
+.Nm ifconfig
+to print information on all interfaces.
+The protocol family may be specified as well.  Additionally, if
+.Fl am ,
+is used, interface media information is printed.
 .Pp
-The interface name
+If
 .Fl A
-causes full interface alias information for each interface to be
-displayed.
+is used, it causes full interface alias information for each interface to
+be displayed. If
+.Fl Am
+is used, interface media information is printed for all interfaces
+as well.
+.Pp
+If
+.Fl m
+followed by an interface name is specified, then the media information
+for that interface will be printed.
 .Pp
 Only the super-user may modify the configuration of a network interface.
 .Pp
@@ -310,12 +361,19 @@ Assign the ipx(3) address of 12625920 specified in decimal to interface fxp0.
 .It Cm ifconfig fxp0 atalk 39108.128 range 39107-39109 phase 2
 Assign the AppleTalk network 39108 and server node 128 with a network 
 range of 39107-39109 to interface fxp0 on a phase 2 AppleTalk network. 
+.Pp
+.It Cm ifconfig xl0 media 10baseT
+Configure the xl0 interface to use 10baseT.
+.Pp
+.It Cm ifconfig xl0 media 100baseT mediaopt full-duplex
+Configure the xl0 interface to use 100baseT, full duplex.
 .El
 .Sh DIAGNOSTICS
 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 SEE ALSO
+.Xr ifmedia 4 ,
 .Xr netstat 1 ,
 .Xr netintro 4 ,
 .Xr rc 8 ,