docs/121821: [patch] wpa_supplicant.conf.5 - provide pointer to sample configuration file

[Sam Leffler]

John Baldwin wrote:
> On Tuesday 18 March 2008 05:03:29 am Edwin Groothuis wrote:
>   
>>> Number:         121821
>>> Category:       docs
>>> Synopsis:       [patch] wpa_supplicant.conf.5 - provide pointer to sample
>>> configuration file Confidential:   no
>>> Severity:       non-critical
>>> Priority:       low
>>> Responsible:    freebsd-doc
>>> State:          open
>>> Quarter:
>>> Keywords:
>>> Date-Required:
>>> Class:          change-request
>>> Submitter-Id:   current-users
>>> Arrival-Date:   Tue Mar 18 09:10:01 UTC 2008
>>> Closed-Date:
>>> Last-Modified:
>>> Originator:     Edwin Groothuis
>>> Release:        FreeBSD 6.3-RELEASE i386
>>> Organization:
>>>       
>> -
>>
>>     
>>> Environment:
>>>       
>> System: FreeBSD k7.mavetju 6.3-RELEASE FreeBSD 6.3-RELEASE #0: Sun Feb 17
>> 22:11:52 EST 2008 edwin at k7.mavetju:/usr/src/sys/i386/compile/SMP i386
>>
>>     
>>> Description:
>>>       
>> It took me a while to figure out how to properly use a WEP (silly
>> Nintendo DS doesn't know about WPA so I needed to reconfigure my
>> network) configuration. Once I had read through the wpa_supplicant.conf
>> in /usr/src/contrib/wpa_supplicant it was clear at once.
>>
>>     
>>> How-To-Repeat:
>>> Fix:
>>>       
>> Index: wpa_supplicant.conf.5
>> ===================================================================
>> RCS file:
>> /home/ncvs/src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5,v
>> retrieving revision 1.9
>> diff -u -r1.9 wpa_supplicant.conf.5
>> --- wpa_supplicant.conf.5	11 Jul 2007 16:04:08 -0000	1.9
>> +++ wpa_supplicant.conf.5	18 Mar 2008 08:59:02 -0000
>> @@ -518,6 +518,11 @@
>>          wep_key0=42FEEDDEAFBABEDEAFBEEFAA55
>>  }
>>  .Ed
>> +.Pp
>> +More examples can be found in the supplied
>> +.Pa wpa_supplicant.conf
>> +in
>> +.Pa /usr/src/contrib/wpa_supplicant/ .
>>  .Sh SEE ALSO
>>  .Xr wpa_cli 8 ,
>>  .Xr wpa_passphrase 8 ,
>>     
>
> This should 
> reference /usr/share/examples/etc/wpa_supplicant/wpa_supplicant.conf instead 
> since HEAD installs it there and /usr/src/ is not installed on all machines.
>
> BTW, it seems to me that wpa_supplicant.conf should just go 
> in /usr/share/examples/etc/ since it lives in /etc and is only a single file 
> rather than having its own subdirectory.
>   

I believe there were other files that could go in examples and/or I 
followed existing practice from another app.  But feel free to change it.

    Sam