Bug 151952

Summary: No example for scanning for SSIDs in ifconfig(8) man page
Product: Documentation Reporter: Jared Barneck <rhyous>
Component: Books & ArticlesAssignee: Glen Barber <gjb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Jared Barneck 2010-11-04 21:30:08 UTC
I couldn't remember off the top of my head how to scan for wireless access points.

I look at the ifconfig man page and while the scan option existed, using it wasn't obvious.


The man page wasn't very helpful for something that is very needed for a laptop these days.

Fix: 

Add another example to the ifconfig(8) examples section:

Scan for Wireless Access Points and display the SSID, BSSID, Channel, Rate, etc...
    ifconfig wlan0 scan
How-To-Repeat: n/a
Comment 1 dfilter service freebsd_committer freebsd_triage 2011-03-12 19:05:49 UTC
Author: gjb (doc committer)
Date: Sat Mar 12 19:05:39 2011
New Revision: 219574
URL: http://svn.freebsd.org/changeset/base/219574

Log:
  Add example of using 'scan' for wireless networks, similarly to
  OpenBSD's ifconfig(8).
  
  PR:		151952
  Submitted by:	Jared (rhyous of yahoo com)
  MFC after:	1 week

Modified:
  head/sbin/ifconfig/ifconfig.8

Modified: head/sbin/ifconfig/ifconfig.8
==============================================================================
--- head/sbin/ifconfig/ifconfig.8	Sat Mar 12 17:05:18 2011	(r219573)
+++ head/sbin/ifconfig/ifconfig.8	Sat Mar 12 19:05:39 2011	(r219574)
@@ -2537,6 +2537,10 @@ Create the software network interface
 Destroy the software network interface
 .Li gif1 :
 .Dl # ifconfig gif1 destroy
+.Pp
+Scan for wireless networks using
+.Li wlan0 :
+.Dl # ifconfig wlan0 scan
 .Sh DIAGNOSTICS
 Messages indicating the specified interface does not exist, the
 requested address is unknown, or the user is not privileged and
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 2 Glen Barber freebsd_committer freebsd_triage 2011-03-12 19:07:56 UTC
State Changed
From-To: open->patched

Patched in HEAD.  MFC in 1 week. 



Comment 3 Glen Barber freebsd_committer freebsd_triage 2011-03-12 19:07:56 UTC
Responsible Changed
From-To: freebsd-doc->gjb

I'll take this.
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-03-19 00:34:27 UTC
Author: gjb (doc committer)
Date: Sat Mar 19 00:34:12 2011
New Revision: 219765
URL: http://svn.freebsd.org/changeset/base/219765

Log:
  MFC 219574,219575:
  - Add example of using 'scan' for wireless networks, similarly to
    OpenBSD's ifconfig(8)[1].
  - remove unneeded newline
  
  PR:		151952 [1]

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

Modified: stable/8/sbin/ifconfig/ifconfig.8
==============================================================================
--- stable/8/sbin/ifconfig/ifconfig.8	Sat Mar 19 00:31:35 2011	(r219764)
+++ stable/8/sbin/ifconfig/ifconfig.8	Sat Mar 19 00:34:12 2011	(r219765)
@@ -2508,7 +2508,6 @@ to use 100baseTX, full duplex Ethernet m
 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
 .Pp
 Label the em0 interface as an uplink:
-.Pp
 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
 .Pp
 Create the software network interface
@@ -2518,6 +2517,10 @@ Create the software network interface
 Destroy the software network interface
 .Li gif1 :
 .Dl # ifconfig gif1 destroy
+.Pp
+Scan for wireless networks using
+.Li wlan0 :
+.Dl # ifconfig wlan0 scan
 .Sh DIAGNOSTICS
 Messages indicating the specified interface does not exist, the
 requested address is unknown, or the user is not privileged and
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 5 dfilter service freebsd_committer freebsd_triage 2011-03-19 00:35:21 UTC
Author: gjb (doc committer)
Date: Sat Mar 19 00:35:11 2011
New Revision: 219766
URL: http://svn.freebsd.org/changeset/base/219766

Log:
  MFC 219574:
  - Add example of using 'scan' for wireless networks, similarly to
    OpenBSD's ifconfig(8).
  - wlan0 isn't available on 7.x, so substitute ath0 for wlan0 in the
    example.
  
  PR:		151952

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

Modified: stable/7/sbin/ifconfig/ifconfig.8
==============================================================================
--- stable/7/sbin/ifconfig/ifconfig.8	Sat Mar 19 00:34:12 2011	(r219765)
+++ stable/7/sbin/ifconfig/ifconfig.8	Sat Mar 19 00:35:11 2011	(r219766)
@@ -1946,6 +1946,10 @@ Create the software network interface
 Destroy the software network interface
 .Li gif1 :
 .Dl # ifconfig gif1 destroy
+.Pp
+Scan for wireless networks using
+.Li ath0 :
+.Dl # ifconfig ath0 scan
 .Sh DIAGNOSTICS
 Messages indicating the specified interface does not exist, the
 requested address is unknown, or the user is not privileged and
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 Glen Barber freebsd_committer freebsd_triage 2011-03-19 00:37:15 UTC
State Changed
From-To: patched->closed

Patched in stable/8 and stable/7.  Thanks!