netfilter-devel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [conntrack-tools PATCH] man: fix hyphen used as minus sign
@ 2014-09-25  9:45 Arturo Borrero Gonzalez
  2014-09-25 17:25 ` Pablo Neira Ayuso
  0 siblings, 1 reply; 2+ messages in thread
From: Arturo Borrero Gonzalez @ 2014-09-25  9:45 UTC (permalink / raw)
  To: netfilter-devel; +Cc: formorer, pablo

Report from Debian's lintian:

 This manual page seems to contain a hyphen where a minus sign was
 intended. By default, "-" chars are interpreted as hyphens (U+2010) by
 groff, not as minus signs (U+002D). Since options to programs use minus
 signs (U+002D), this means for example in UTF-8 locales that you cannot
 cut and paste options, nor search for them easily.
 [...]

Signed-off-by: Arturo Borrero Gonzalez <arturo.borrero.glez@gmail.com>
---
 conntrack.8  |   22 +++++++++++-----------
 conntrackd.8 |    4 ++--
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/conntrack.8 b/conntrack.8
index 45e8582..abc26c5 100644
--- a/conntrack.8
+++ b/conntrack.8
@@ -1,4 +1,4 @@
-.TH CONNTRACK 8 "Jul 5, 2010" "" ""
+.TH CONNTRACK 8 "Sep 25, 2014" "" ""
 
 .\" Man page written by Harald Welte <laforge@netfilter.org (Jun 2005)
 .\" Maintained by Pablo Neira Ayuso <pablo@netfilter.org (May 2007)
@@ -86,7 +86,7 @@ Show the in-kernel connection tracking system statistics.
 .TP
 .BI "-z, --zero "
 Atomically zero counters after reading them.  This option is only valid in
-combination with the "-L, --dump" command options.
+combination with the "\-L, \-\-dump" command options.
 .TP
 .BI "-o, --output [extended,xml,timestamp,id,ktimestamp,labels] "
 Display output in a certain format. With the extended output option, this tool
@@ -101,7 +101,7 @@ Set the bitmask of events that are to be generated by the in-kernel ctnetlink
 event code.  Using this parameter, you can reduce the event messages generated
 by the kernel to those types to those that you are actually interested in.
 .
-This option can only be used in conjunction with "-E, --event".
+This option can only be used in conjunction with "\-E, \-\-event".
 .TP
 .BI "-b, --buffer-size " "value (in bytes)"
 Set the Netlink socket buffer size. This option is useful if the command line
@@ -112,7 +112,7 @@ other words, if the amount of events are big enough to overrun the socket
 buffer. Note that using a big buffer reduces the chances to hit ENOBUFS, 
 however, this results in more memory consumption.
 .
-This option can only be used in conjunction with "-E, --event".
+This option can only be used in conjunction with "\-E, \-\-event".
 .SS FILTER PARAMETERS
 .TP
 .BI "-s, --orig-src " IP_ADDRESS
@@ -132,31 +132,31 @@ Specify layer four (TCP, UDP, ...) protocol.
 .TP
 .BI "-f, --family " "PROTO"
 Specify layer three (ipv4, ipv6) protocol
-This option is only required in conjunction with "-L, --dump". If this option is not passed, the default layer 3 protocol will be IPv4.
+This option is only required in conjunction with "\-L, \-\-dump". If this option is not passed, the default layer 3 protocol will be IPv4.
 .TP
 .BI "-t, --timeout " "TIMEOUT"
 Specify the timeout.
 .TP
 .BI "-m, --mark " "MARK[/MASK]"
 Specify the conntrack mark.  Optionally, a mask value can be specified.
-In "--update" mode, this mask specifies the bits that should be zeroed before XORing
+In "\-\-update" mode, this mask specifies the bits that should be zeroed before XORing
 the MARK value into the ctmark.
 Otherwise, the mask is logically ANDed with the existing mark before the comparision.
-In "--create" mode, the mask is ignored.
+In "\-\-create" mode, the mask is ignored.
 .TP
 .BI "-l, --label " "LABEL"
 Specify a conntrack label.
-This option is only available in conjunction with "-L, --dump", "-E, --event", or "-U --update".
+This option is only available in conjunction with "\-L, \-\-dump", "\-E, \-\-event", or "\-U \-\-update".
 Match entries whose labels match at least those specified.
-Use multiple -l commands to specify multiple labels that need to be set.
+Use multiple \-l commands to specify multiple labels that need to be set.
 Match entries whose labels matches at least those specified as arguments.
 .BI "--label-add " "LABEL"
 Specify the conntrack label to add to to the selected conntracks.
-This option is only available in conjunction with "-I, --create" or "-U, --update".
+This option is only available in conjunction with "\-I, \-\-create" or "\-U, \-\-update".
 .BI "--label-del " "[LABEL]"
 Specify the conntrack label to delete from the selected conntracks.
 If no label is given, all labels are deleted.
-This option is only available in conjunction with "-U, --update".
+This option is only available in conjunction with "\-U, \-\-update".
 .TP
 .BI "-c, --secmark " "SECMARK"
 Specify the conntrack selinux security mark.
diff --git a/conntrackd.8 b/conntrackd.8
index 131a7ac..455f6c5 100644
--- a/conntrackd.8
+++ b/conntrackd.8
@@ -1,4 +1,4 @@
-.TH CONNTRACKD 8 "Oct 21, 2008" "" ""
+.TH CONNTRACKD 8 "Sep 25, 2014" "" ""
 
 .\" Man page written by Pablo Neira Ayuso <pablo@netfilter.org> (Dec 2007)
 
@@ -32,7 +32,7 @@ Dump the external cache, i.e. show foreign states
 .TP
 .BI "-x "
 Display output in XML format. This option is only valid in combination
-with "-i" and "-e" parameters.
+with "\-i" and "\-e" parameters.
 .TP
 .BI "-f " "[|internal|external]"
 Flush the internal and/or external cache


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [conntrack-tools PATCH] man: fix hyphen used as minus sign
  2014-09-25  9:45 [conntrack-tools PATCH] man: fix hyphen used as minus sign Arturo Borrero Gonzalez
@ 2014-09-25 17:25 ` Pablo Neira Ayuso
  0 siblings, 0 replies; 2+ messages in thread
From: Pablo Neira Ayuso @ 2014-09-25 17:25 UTC (permalink / raw)
  To: Arturo Borrero Gonzalez; +Cc: netfilter-devel, formorer

On Thu, Sep 25, 2014 at 11:45:11AM +0200, Arturo Borrero Gonzalez wrote:
> Report from Debian's lintian:
> 
>  This manual page seems to contain a hyphen where a minus sign was
>  intended. By default, "-" chars are interpreted as hyphens (U+2010) by
>  groff, not as minus signs (U+002D). Since options to programs use minus
>  signs (U+002D), this means for example in UTF-8 locales that you cannot
>  cut and paste options, nor search for them easily.
>  [...]

Applied, thanks.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2014-09-25 17:24 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-09-25  9:45 [conntrack-tools PATCH] man: fix hyphen used as minus sign Arturo Borrero Gonzalez
2014-09-25 17:25 ` Pablo Neira Ayuso

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).