aboutsummaryrefslogtreecommitdiffstats
path: root/wpa_supplicant/doc/docbook
diff options
context:
space:
mode:
authorKel Modderman <kel@otaku42.de>2008-02-28 01:48:23 (GMT)
committerJouni Malinen <j@w1.fi>2008-02-28 01:48:23 (GMT)
commiteff06a7cdb2b3bca4a14d378ecbd9d1923000682 (patch)
treed23e1011a7951be83a350815f12c202c564d0832 /wpa_supplicant/doc/docbook
parent6076f6ce085c188398e918ed9530089d69d5f573 (diff)
downloadhostap-eff06a7cdb2b3bca4a14d378ecbd9d1923000682.zip
hostap-eff06a7cdb2b3bca4a14d378ecbd9d1923000682.tar.gz
hostap-eff06a7cdb2b3bca4a14d378ecbd9d1923000682.tar.bz2
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 <emphasis>word</emphasis> where 'word' is used at the moment. Signed-off-by: Kel Modderman <kel@otaku42.de>
Diffstat (limited to 'wpa_supplicant/doc/docbook')
-rw-r--r--wpa_supplicant/doc/docbook/wpa_cli.sgml23
-rw-r--r--wpa_supplicant/doc/docbook/wpa_priv.sgml8
-rw-r--r--wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml4
-rw-r--r--wpa_supplicant/doc/docbook/wpa_supplicant.sgml14
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 d55aee4..1fe98f4 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.</para>
- <para>The reply to these requests can be given with 'identity',
- 'password', and 'otp' commands. &lt;id&gt; 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.</para>
+ <para>The reply to these requests can be given with
+ <emphasis>identity</emphasis>, <emphasis>password</emphasis>, and
+ <emphasis>otp</emphasis> commands. &lt;id&gt; needs to be copied from
+ the matching request. <emphasis>password</emphasis> and
+ <emphasis>otp</emphasis> 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 <emphasis>password</emphasis> are
+ remembered as long as wpa_supplicant is running whereas values given
+ with <emphasis>otp</emphasis> 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.</para>
<para>Example request for password and a matching reply:</para>
diff --git a/wpa_supplicant/doc/docbook/wpa_priv.sgml b/wpa_supplicant/doc/docbook/wpa_priv.sgml
index 43a468c..89b8a92 100644
--- a/wpa_supplicant/doc/docbook/wpa_priv.sgml
+++ b/wpa_supplicant/doc/docbook/wpa_priv.sgml
@@ -49,9 +49,9 @@
<title>Example configuration</title>
<para>The following steps are an example of how to configure
- <command>wpa_priv</command> to allow users in the 'wpapriv' group
- to communicate with <command>wpa_supplicant</command> with privilege
- separation:</para>
+ <command>wpa_priv</command> to allow users in the
+ <emphasis>wpapriv</emphasis> group to communicate with
+ <command>wpa_supplicant</command> with privilege separation:</para>
<para>Create user group (e.g., wpapriv) and assign users that
should be able to use wpa_supplicant into that group.</para>
@@ -111,7 +111,7 @@ wpa_supplicant -i ath0 -c wpa_supplicant.conf
supported <command>wpa_supplicant</command> 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'.</para>
+ drivers is <emphasis>wext</emphasis>.</para>
<para>The &lt;ifname&gt; string specifies which network
interface is to be managed by <command>wpa_supplicant</command>
diff --git a/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml b/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml
index 00bf6f5..ebefe11 100644
--- a/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml
+++ b/wpa_supplicant/doc/docbook/wpa_supplicant.conf.sgml
@@ -26,7 +26,7 @@
<para>Changes to configuration file can be reloaded be sending
SIGHUP signal to <command>wpa_supplicant</command> ('killall -HUP
wpa_supplicant'). Similarly, reloading can be triggered with
- the 'wpa_cli reconfigure' command.</para>
+ the <emphasis>wpa_cli reconfigure</emphasis> command.</para>
<para>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={
<listitem>
<para>Authentication for wired Ethernet. This can be used with
- 'wired' interface (-Dwired on command line).</para>
+ <emphasis>wired</emphasis> interface (-Dwired on command line).</para>
<blockquote><programlisting>
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 21c4951..52b62c3 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)</term>
<listitem>
<para> (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.</para>
+ Managed mode (<emphasis>iwconfig wlan0 mode managed</emphasis>).
+ Please note that station firmware version needs to be 1.7.0 or
+ newer to work in WPA mode.</para>
</listitem>
</varlistentry>
@@ -736,8 +736,8 @@ wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
<para>Add MODE="Managed" and WPA="y" to the network scheme in
<filename>/etc/pcmcia/wireless.opts</filename>.</para>
- <para>Add the following block to the end of 'start' action handler
- in <filename>/etc/pcmcia/wireless</filename>:</para>
+ <para>Add the following block to the end of <emphasis>start</emphasis>
+ action handler in <filename>/etc/pcmcia/wireless</filename>:</para>
<blockquote><programlisting>
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
@@ -746,8 +746,8 @@ fi
</programlisting></blockquote>
- <para>Add the following block to the end of 'stop' action handler
- (may need to be separated from other actions) in
+ <para>Add the following block to the end of <emphasis>stop</emphasis>
+ action handler (may need to be separated from other actions) in
<filename>/etc/pcmcia/wireless</filename>:</para>
<blockquote><programlisting>