Correcting not escaped minus signs in manpage.

Extract of the explanations why we need a change for this:
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. The Debian groff package currently forces "-" to be interpreted
as a minus sign due to the number of manual pages with this problem, but this is
a Debian-specific modification and hopefully eventually can be removed.

"-" must be escaped ("\-") to be interpreted as minus.
This commit is contained in:
Joseph HERLANT 2014-03-06 18:56:00 +01:00
parent 2cf5c15cf6
commit c85b8f8ecd

View File

@ -3,7 +3,7 @@
cmph \- minimum perfect hashing tool cmph \- minimum perfect hashing tool
.SH SYNOPSIS .SH SYNOPSIS
.B cmph .B cmph
[-v] [-h] [-V] [-k nkeys] [-f hash_function] [-g [-c value][-s seed] ] [-a algorithm] [-M memory_in_MB] [-b BRZ_parameter] [-d tmp_dir] [-m file.mph] keysfile [\-v] [\-h] [\-V] [\-k nkeys] [\-f hash_function] [\-g [\-c value][\-s seed] ] [\-a algorithm] [\-M memory_in_MB] [\-b BRZ_parameter] [\-d tmp_dir] [\-m file.mph] keysfile
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Command line tool to generate and query minimal perfect hash functions. Command line tool to generate and query minimal perfect hash functions.
@ -56,11 +56,11 @@ $ # Using the default algorithm (chm) for constructing a mphf
.br .br
$ # for keys in file keys_file. Lines in keys_file _must_ be unique. $ # for keys in file keys_file. Lines in keys_file _must_ be unique.
.br .br
$ ./cmph -v -g keys_file $ ./cmph \-v \-g keys_file
.br .br
$ # Query id of keys in the file keys_query $ # Query id of keys in the file keys_query
.br .br
$ ./cmph -v -m keys_file.mph keys_query $ ./cmph \-v \-m keys_file.mph keys_query
.SH AUTHOR .SH AUTHOR
This manual page was written by Enrico Tassi <gareuselesinge@users.sourceforge.net>, This manual page was written by Enrico Tassi <gareuselesinge@users.sourceforge.net>,
for the Debian project (but may be used by others). for the Debian project (but may be used by others).