From eff06a7cdb2b3bca4a14d378ecbd9d1923000682 Mon Sep 17 00:00:00 2001 From: Kel Modderman Date: Wed, 27 Feb 2008 17:48:23 -0800 Subject: [PATCH] Enhance manpage with use of emphasis instead of strong quote The Debian package checker "lintian" was making noise about wpa_supplicant.conf(5). It was caused by a line beginning with ', which is apparently not liked by man(1). I suggest the use of word where 'word' is used at the moment. Signed-off-by: Kel Modderman --- wpa_supplicant/doc/docbook/wpa_cli.sgml | 23 ++++++++++--------- wpa_supplicant/doc/docbook/wpa_priv.sgml | 8 +++---- .../doc/docbook/wpa_supplicant.conf.sgml | 4 ++-- .../doc/docbook/wpa_supplicant.sgml | 14 +++++------ 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/wpa_supplicant/doc/docbook/wpa_cli.sgml b/wpa_supplicant/doc/docbook/wpa_cli.sgml index d55aee468..1fe98f4fc 100644 --- a/wpa_supplicant/doc/docbook/wpa_cli.sgml +++ b/wpa_supplicant/doc/docbook/wpa_cli.sgml @@ -72,17 +72,18 @@ case of OTP request, it includes the challenge from the authentication server. - The reply to these requests can be given with 'identity', - 'password', and 'otp' commands. <id> needs to be copied from the - the matching request. 'password' and 'otp' commands can be used - regardless of whether the request was for PASSWORD or OTP. The - main difference between these two commands is that values given - with 'password' are remembered as long as wpa_supplicant is - running whereas values given with 'otp' are used only once and - then forgotten, i.e., wpa_supplicant will ask frontend for a new - value for every use. This can be used to implement - one-time-password lists and generic token card -based - authentication. + The reply to these requests can be given with + identity, password, and + otp commands. <id> needs to be copied from + the matching request. password and + otp commands can be used regardless of whether + the request was for PASSWORD or OTP. The main difference between these + two commands is that values given with password are + remembered as long as wpa_supplicant is running whereas values given + with otp are used only once and then forgotten, + i.e., wpa_supplicant will ask frontend for a new value for every use. + This can be used to implement one-time-password lists and generic token + card -based authentication. Example request for password and a matching reply: diff --git a/wpa_supplicant/doc/docbook/wpa_priv.sgml b/wpa_supplicant/doc/docbook/wpa_priv.sgml index 43a468c32..89b8a9221 100644 --- a/wpa_supplicant/doc/docbook/wpa_priv.sgml +++ b/wpa_supplicant/doc/docbook/wpa_priv.sgml @@ -49,9 +49,9 @@ Example configuration The following steps are an example of how to configure - wpa_priv to allow users in the 'wpapriv' group - to communicate with wpa_supplicant with privilege - separation: + wpa_priv to allow users in the + wpapriv group to communicate with + wpa_supplicant with privilege separation: Create user group (e.g., wpapriv) and assign users that should be able to use wpa_supplicant into that group. @@ -111,7 +111,7 @@ wpa_supplicant -i ath0 -c wpa_supplicant.conf supported wpa_supplicant driver backends is to be used. To get a list of supported driver types see wpa_supplicant help (e.g, wpa_supplicant -h). The driver backend supported by most good - drivers is 'wext'. + drivers is wext. The <ifname> string specifies which network interface is to be managed by wpa_supplicant diff --git a/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml b/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml index 00bf6f5fa..ebefe115a 100644 --- a/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml +++ b/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml @@ -26,7 +26,7 @@ Changes to configuration file can be reloaded be sending SIGHUP signal to wpa_supplicant ('killall -HUP wpa_supplicant'). Similarly, reloading can be triggered with - the 'wpa_cli reconfigure' command. + the wpa_cli reconfigure command. Configuration file can include one or more network blocks, e.g., one for each used SSID. wpa_supplicant will automatically @@ -174,7 +174,7 @@ network={ Authentication for wired Ethernet. This can be used with - 'wired' interface (-Dwired on command line). + wired interface (-Dwired on command line).
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=wheel diff --git a/wpa_supplicant/doc/docbook/wpa_supplicant.sgml b/wpa_supplicant/doc/docbook/wpa_supplicant.sgml index 21c495183..52b62c317 100644 --- a/wpa_supplicant/doc/docbook/wpa_supplicant.sgml +++ b/wpa_supplicant/doc/docbook/wpa_supplicant.sgml @@ -530,9 +530,9 @@ wpa_supplicant \ snapshot/v0.2.x) (http://hostap.epitest.fi/) Driver needs to be set in - Managed mode ('iwconfig wlan0 mode managed'). Please note - that station firmware version needs to be 1.7.0 or newer to - work in WPA mode. + Managed mode (iwconfig wlan0 mode managed). + Please note that station firmware version needs to be 1.7.0 or + newer to work in WPA mode. @@ -736,8 +736,8 @@ wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B Add MODE="Managed" and WPA="y" to the network scheme in /etc/pcmcia/wireless.opts. - Add the following block to the end of 'start' action handler - in /etc/pcmcia/wireless: + Add the following block to the end of start + action handler in /etc/pcmcia/wireless:
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then @@ -746,8 +746,8 @@ fi
- Add the following block to the end of 'stop' action handler - (may need to be separated from other actions) in + Add the following block to the end of stop + action handler (may need to be separated from other actions) in /etc/pcmcia/wireless: