svn commit: r245008 - stable/9/sbin/ifconfig

[Warren Block]

Author: wblock (doc committer)
Date: Thu Jan  3 21:31:57 2013
New Revision: 245008
URL: http://svnweb.freebsd.org/changeset/base/245008

Log:
  MFC r242697,r242704:
  
  r242697:
  Add devd.conf(5) and devd(8) to SEE ALSO xrefs.  Give users a pointer to
  seemingly mysterious actions that are not done by ifconfig itself, but
  by devd triggering on events caused by ifconfig.
  
  r242704:
  Remove fifteen-year-old notes on media selection (suggested by simon@).
  Add commas after "e.g." and "i.e.".
  
  PR:		docs/173405

Modified:
  stable/9/sbin/ifconfig/ifconfig.8
Directory Properties:
  stable/9/sbin/ifconfig/   (props changed)

Modified: stable/9/sbin/ifconfig/ifconfig.8
==============================================================================
--- stable/9/sbin/ifconfig/ifconfig.8	Thu Jan  3 20:59:09 2013	(r245007)
+++ stable/9/sbin/ifconfig/ifconfig.8	Thu Jan  3 21:31:57 2013	(r245008)
@@ -28,7 +28,7 @@
 .\"     From: @(#)ifconfig.8	8.3 (Berkeley) 1/5/94
 .\" $FreeBSD$
 .\"
-.Dd May 27, 2012
+.Dd November 7, 2012
 .Dt IFCONFIG 8
 .Os
 .Sh NAME
@@ -142,7 +142,7 @@ The link-level
 address
 is specified as a series of colon-separated hex digits.
 This can be used to
-e.g.\& set a new MAC address on an ethernet interface, though the
+e.g.,\& set a new MAC address on an ethernet interface, though the
 mechanism used is not ethernet-specific.
 If the interface is already
 up when this option is used, it will be briefly brought down and
@@ -301,7 +301,7 @@ Specify interface FIB.
 A FIB
 .Ar fib_number
 is assigned to all frames or packets received on that interface.
-The FIB is not inherited, e.g. vlans or other sub-interfaces will use
+The FIB is not inherited, e.g., vlans or other sub-interfaces will use
 the default FIB (0) irrespective of the parent interface's FIB.
 The kernel needs to be tuned to support more than the default FIB
 using the
@@ -1009,7 +1009,7 @@ For example, if a device is capable of o
 with 802.11n and 802.11g then one can specify that g-only use
 should be used by specifying ``6:g''.
 Similarly the channel width can be specified by appending it
-with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
+with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
 These attributes can be combined as in: ``6:ht/40''.
 The full set of flags specified following a ``:'' are:
 .Cm a
@@ -1042,7 +1042,7 @@ and
 In addition,
 a 40MHz HT channel specification may include the location
 of the extension channel by appending ``+'' or ``-'' for above and below,
-respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
+respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
 with the center channel at frequency 2437 and the extension channel above.
 .It Cm country Ar name
 Set the country code to use in calculating the regulatory constraints
@@ -1052,7 +1052,7 @@ will operation on the channels, and the 
 can be used on a channel are defined by this setting.
 Country/Region codes are specified as a 2-character abbreviation
 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
-e.g. "ES" and "Spain".
+e.g., "ES" and "Spain".
 The set of country codes are taken from /etc/regdomain.xml and can also
 be viewed with the ``list countries'' request.
 Note that not all devices support changing the country code from a default
@@ -1069,7 +1069,7 @@ DFS embodies several facilities includin
 radar signals, dynamic transmit power control, and channel selection
 according to a least-congested criteria.
 DFS support is mandatory for some 5GHz frequencies in certain
-locales (e.g. ETSI).
+locales (e.g., ETSI).
 By default DFS is enabled according to the regulatory definitions
 specified in /etc/regdomain.xml and the current country code, regdomain,
 and channel.
@@ -1142,7 +1142,7 @@ Enable Dynamic WDS (DWDS) support.
 DWDS is a facility by which 4-address traffic can be carried between
 stations operating in infrastructure mode.
 A station first associates to an access point and authenticates using
-normal procedures (e.g. WPA).
+normal procedures (e.g., WPA).
 Then 4-address frames are passed to carry traffic for stations
 operating on either side of the wireless link.
 DWDS extends the normal WDS mechanism by leveraging existing security
@@ -1160,7 +1160,7 @@ When DWDS is enabled on a station, traff
 different from the peer station are encapsulated in a 4-address frame
 and transmitted to the peer.
 All 4-address traffic uses the security information of the stations
-(e.g. cryptographic keys).
+(e.g., cryptographic keys).
 A station is associated using 802.11n facilities may transport
 4-address traffic using these same mechanisms; this depends on available
 resources and capabilities of the device.
@@ -1210,7 +1210,7 @@ Stations negotiate use of these faciliti
 when they associate.
 To disable all use of 802.11n use
 .Fl ht .
-To disable use of HT20 (e.g. to force only HT40 use) use
+To disable use of HT20 (e.g., to force only HT40 use) use
 .Fl ht20 .
 To disable use of HT40 use
 .Fl ht40 .
@@ -1224,7 +1224,7 @@ Auto Channel Selection is used to locate
 HT configuration controls whether legacy, HT20, or HT40 operation is setup
 on the selected channel.
 If a fixed channel is specified for a station then HT configuration can
-be given as part of the channel specification; e.g. 6:ht/20 to setup
+be given as part of the channel specification; e.g., 6:ht/20 to setup
 HT20 operation on channel 6.
 .It Cm htcompat
 Enable use of compatibility support for pre-802.11n devices (default).
@@ -1480,13 +1480,13 @@ The default setting is 6 but drivers may
 they choose.
 .It Cm mcastrate Ar rate
 Set the rate for transmitting multicast/broadcast frames.
-Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
+Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
 This rate should be valid for the current operating conditions;
 if an invalid rate is specified drivers are free to chose an
 appropriate rate.
 .It Cm mgtrate Ar rate
 Set the rate for transmitting management and/or control frames.
-Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
+Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
 .It Cm outdoor
 Set the location to use in calculating regulatory constraints.
 The location is also advertised in beacon and probe response frames
@@ -1646,7 +1646,7 @@ request can be used to show recent scan 
 initiating a new scan.
 .It Cm scanvalid Ar threshold
 Set the maximum time the scan cache contents are considered valid;
-i.e. will be used without first triggering a scan operation to
+i.e., will be used without first triggering a scan operation to
 refresh the data.
 The
 .Ar threshold
@@ -1708,7 +1708,7 @@ When operating with TDMA, setup a BSS wi
 slots.
 The slot count may be at most 8.
 The current implementation is only tested with two stations
-(i.e. point to point applications).
+(i.e., point to point applications).
 This setting is only meaningful when a station is configured as slot 0;
 other stations adopt this setting from the BSS they join.
 By default
@@ -1732,7 +1732,7 @@ is set to 10 milliseconds.
 When operating with TDMA, setup a BSS such that beacons are transmitted every
 .Ar intval
 superframes to synchronize the TDMA slot timing.
-A superframe is defined as the number of slots times the slot length; e.g.
+A superframe is defined as the number of slots times the slot length; e.g.,
 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
 The beacon interval may not be zero.
 A lower setting of
@@ -1758,7 +1758,7 @@ the driver will use the setting closest 
 Not all adapters support changing the transmit power.
 .It Cm ucastrate Ar rate
 Set a fixed rate for transmitting unicast frames.
-Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
+Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
 This rate should be valid for the current operating conditions;
 if an invalid rate is specified drivers are free to chose an
 appropriate rate.
@@ -2565,9 +2565,6 @@ The
 flag disables this behavior.
 .Pp
 Only the super-user may modify the configuration of a network interface.
-.Sh NOTES
-The media selection system is relatively new and only some drivers support
-it (or have need for it).
 .Sh EXAMPLES
 Assign the IPv4 address
 .Li 192.0.2.10 ,
@@ -2646,7 +2643,9 @@ tried to alter an interface's configurat
 .Xr pfsync 4 ,
 .Xr polling 4 ,
 .Xr vlan 4 ,
+.Xr devd.conf 5 ,
 .\" .Xr eon 5 ,
+.Xr devd 8 ,
 .Xr rc 8 ,
 .Xr routed 8 ,
 .Xr jail 8 ,