[PATCH] hostapd: fix some manual page formatting

Kel Modderman kel
Wed Mar 11 11:01:13 PDT 2009


Hi Jouni,

lintian (Debian package lint tool) found some small deficiencies in hostapd.8
and hostapd_cli.1. Here is its full explination for your reading pleasure, and
a patch. Enjoy :)

I: hostapd: hyphen-used-as-minus-sign usr/share/man/man1/hostapd_cli.1.gz:6
N:
N:    Manual page seems to contain a hyphen where a minus sign was intended.
N:    "-" chars are interpreted as hyphens (U+2010) by groff, not as minus
N:    signs (U+002D). Since options to programs use minus signs (U+002D), this
N:    means for example in UTF-8 locales that you cannot cut&paste options,
N:    nor search for them easily.
N:
N:    "-" must be escaped ("\-") to be interpreted as minus. If you really
N:    intend a hyphen, write it as "\(hy" to emphasise that fact. See groff(7)
N:    and especially groff_char(7) for details, and also the thread starting
N:    with
N:    http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481.h
N:    tml
N:
N:    If you use some tool that converts your documentation to groff format,
N:    it might be possible that this tool converts dashes of any kind to groff
N:    hyphens, while the safe way of converting dashes is usually to convert
N:    them to "\-".
N:
N:    Because this error can occur very often we show only the first 10
N:    occurrences for each man page and give the number of suppressed
N:    occurrences. If you want to see all warnings, run lintian with the
N:    -d/--debug option.
---
--- a/hostapd/hostapd.8
+++ b/hostapd/hostapd.8
@@ -3,7 +3,7 @@
 hostapd \- IEEE 802.11 AP, IEEE 802.1X/WPA/WPA2/EAP/RADIUS Authenticator
 .SH SYNOPSIS
 .B hostapd
-[-hdBKtv] [-P <PID file>] <configuration file(s)>
+[\-hdBKtv] [\-P <PID file>] <configuration file(s)>
 .SH DESCRIPTION
 This manual page documents briefly the
 .B hostapd
--- a/hostapd/hostapd_cli.1
+++ b/hostapd/hostapd_cli.1
@@ -3,7 +3,7 @@
 hostapd_cli \- hostapd command-line interface
 .SH SYNOPSIS
 .B hostapd_cli
-[-p<path>] [-i<ifname>] [-hv] [command..]
+[\-p<path>] [\-i<ifname>] [\-hv] [command..]
 .SH DESCRIPTION
 This manual page documents briefly the
 .B hostapd_cli
---



More information about the Hostap mailing list