[Freeciv-Dev] (PR#11977) Manpages, hyphens and UTF-8 locales

["Sam Morris" <sam@xxxxxxxxxxxxx>]

<URL: http://bugs.freeciv.org/Ticket/Display.html?id=11977 >

Hi there!

I've patched the civserver and civclient manual pages to generate dashes
instead of hyphens when viewed in a Unicode locale. Since the - key
on a keyboard generates a dash and not a hyphen, it was not possible to
search the man page for options in a Unicode locale.

ISO8859-whatever doesn't distinguish between a hyphen and a dash, so I
guess no one noticed this before (maybe I'm only only unicode user who
has ever wanted to searh in a Freeciv man page?) :)

-- 
Regards,
Sam Morris

diff -ruN freeciv-20040911.orig/doc/man/civclient.6 
freeciv-20040911/doc/man/civclient.6
--- freeciv-20040911.orig/doc/man/civclient.6   2004-07-14 20:16:24.000000000 
+0100
+++ freeciv-20040911/doc/man/civclient.6        2004-09-15 21:18:54.000000000 
+0100
@@ -14,11 +14,11 @@
 civclient \- The client for the Freeciv game
 .SH SYNOPSIS
 .B civclient \
-[ -a|--autoconnect ] [ -d|--debug \fIlevel\fP ] [ -h|--help ] \
-[ -l|--log \fIlogfile\fP ] [ -m|--meta \fIserver\fP ] \
-[ -n|--name \fIname\fP ] [ -p|--port \fIport\fP ] \
-[ -P|--Plugin \fIplugin\fP ] [ -s|--server \fIserver\fP ] \
-[ -S|--Sound \fItags\fP ] [ -t|--tiles \fItiles\fP ] [ -v|--version ]
+[ \-a|\-\-autoconnect ] [ \-d|\-\-debug \fIlevel\fP ] [ \-h|\-\-help ] \
+[ \-l|\-\-log \fIlogfile\fP ] [ \-m|\-\-meta \fIserver\fP ] \
+[ \-n|\-\-name \fIname\fP ] [ \-p|\-\-port \fIport\fP ] \
+[ \-P|\-\-Plugin \fIplugin\fP ] [ \-s|\-\-server \fIserver\fP ] \
+[ \-S|\-\-Sound \fItags\fP ] [ \-t|\-\-tiles \fItiles\fP ] [ \-v|\-\-version ]
 .SH DESCRIPTION
 Freeciv is a free turn-based multiplayer strategy game, in which each player
 becomes the leader of a civilization, fighting to obtain the ultimate goal:
@@ -45,60 +45,60 @@
 .I civclient
 accepts all of the standard X Toolkit command line options along with the
 additional options listed below. Those may not be combined; that is,
-"civclient -np caesar 5556" will not work, instead you would need to enter
-"civclient -n caesar -p 5556". All options have a short form (single
+"civclient \-np caesar 5556" will not work, instead you would need to enter
+"civclient \-n caesar \-p 5556". All options have a short form (single
 hyphen and single letter) and a long form (double hyphen and a complete word);
 their effects are identical.
 .TP
-.BI "-a, --autoconnect"
+.BI "\-a, \-\-autoconnect"
 Skips the connect dialog, automatically inserts the default values. This is
 quite convenient when all has been set up properly.
 .TP
-.BI "-d, --debug"
+.BI "\-d, \-\-debug"
 Sets the debug log level (0 to 3) of information to be logged. Use the
-.I -l
+.I \-l
 option to send the logging to a file.
 .TP
-.BI "-h, --help"
+.BI "\-h, \-\-help"
 Prints a short summary of the options.
 .TP
-.BI "-l, --log"
+.BI "\-l, \-\-log"
 Specifies the file to be used as a logfile for logging. Use the
-.I -d
+.I \-d
 option to set the amount of loggin.
 .TP
-.BI "-m, --meta"
+.BI "\-m, \-\-meta"
 Connect to the given metaserver, a place where Freeciv servers can publish 
their
 presence. Freeciv clients consult the metaserver to offer users a selection of
 games to join.
 .TP
-.BI "-n, --name"
+.BI "\-n, \-\-name"
 Specifies the name to play under. This option is critical when reconnecting to
 a game. Please note that you might need to quote your playername.
 .TP
-.BI "-p, --port"
+.BI "\-p, \-\-port"
 Specifies the server port to connect to. By default this is 5555, if in doubt
 ask the server administrator.
 .TP
-.BI "-P, --Plugin"
+.BI "\-P, \-\-Plugin"
 Specifies to use one of [none, esd, sdl] for sound output.
 .TP
-.BI "-s, --server"
+.BI "\-s, \-\-server"
 The game server to connect to. This server might easily run on the same machine
 as the client.
 .TP
-.BI "-S, --Sound"
+.BI "\-S, \-\-Sound"
 Specifies where to read the sound tags from.
 .TP
-.BI "-t, --tiles"
+.BI "\-t, \-\-tiles"
 Indicates a tilespec to be used for tiles within the game.
 .TP
-.BI "-v, --version"
+.BI "\-v, \-\-version"
 Prints the version number.
 .SH "EXAMPLES"
-civclient --name "King Richard" --server io.daimi.aau.dk
+civclient \-\-name "King Richard" \-\-server io.daimi.aau.dk
 
-civclient -a -t trident
+civclient \-a \-t trident
 .SH FILES
 .TP
 .BI ~/.civclientrc
diff -ruN freeciv-20040911.orig/doc/man/civserver.6 
freeciv-20040911/doc/man/civserver.6
--- freeciv-20040911.orig/doc/man/civserver.6   2004-07-14 20:16:24.000000000 
+0100
+++ freeciv-20040911/doc/man/civserver.6        2004-09-15 21:24:20.000000000 
+0100
@@ -14,12 +14,12 @@
 civserver \- The server for the Freeciv game
 .SH SYNOPSIS
 .B civserver \
-[ -b|--bind \fIaddress\fP ] [ -d|--debug \fIlevel\fP ] \
-[ -f|--file \fIsavegame\fP ] [ -g|--gamelog \fIgamelog\fP ] [ -h|--help ] \
-[ -i|--info \fIinfo\fP ] [ -l|--log \fIlogfile\fP ] [ -m|--meta ] \
-[ -M|--Metaserver \fIserver\fP ] [ -p|--port \fIport\fP ] \
-[ -q|--quitidle \fIseconds\fP ] [ -e|--exit-on-end ] \
-[ -r|--read \fIfile\fP ] [ -v|--version ]
+[ \-b|\-\-bind \fIaddress\fP ] [ \-d|\-\-debug \fIlevel\fP ] \
+[ \-f|\-\-file \fIsavegame\fP ] [ \-g|\-\-gamelog \fIgamelog\fP ] [ 
\-h|\-\-help ] \
+[ \-i|\-\-info \fIinfo\fP ] [ \-l|\-\-log \fIlogfile\fP ] [ \-m|\-\-meta ] \
+[ \-M|\-\-Metaserver \fIserver\fP ] [ \-p|\-\-port \fIport\fP ] \
+[ \-q|\-\-quitidle \fIseconds\fP ] [ \-e|\-\-exit\-on\-end ] \
+[ \-r|\-\-read \fIfile\fP ] [ \-v|\-\-version ]
 .SH DESCRIPTION
 Freeciv is a free turn-based multiplayer strategy game, in which each player
 becomes the leader of a civilization, fighting to obtain the ultimate goal:
@@ -44,70 +44,70 @@
 as well as the documentation which is part of the Freeciv distribution.
 .SH OPTIONS
 The following options are accepted on the command line of the server. They may
-not be combined; that is, "civserver -fp savegame.sav 555" will not work,
-instead you would need to enter "civserver -f savegame.sav -p 555". All options
+not be combined; that is, "civserver \-fp savegame.sav 555" will not work,
+instead you would need to enter "civserver \-f savegame.sav \-p 555". All 
options
 have a short form (single hyphen and single letter) and a long form (double
 hyphen and a complete word); their effects are identical.
 .TP
-.BI "-b, --bind"
+.BI "\-b, \-\-bind"
 Sets the address on which the server will listen for clients.
 .TP
-.BI "-d, --debug"
+.BI "\-d, \-\-debug"
 Sets the amount of debugging information to be logged in the file named by the
-.I -l
+.I \-l
 option. The number should be 0 for fatal errors only, 1 for fatal and normal
 messages, 2 for fatal, normal, and debugging messages, or 3 for very verbose
 output.
 .TP
-.BI "-f, --file"
+.BI "\-f, \-\-file"
 Loads a saved game into the server before initialization, instead of starting a
 new game. This is for reloading saved games, or for loading scenarios.
 .TP
-.BI "-g, --gamelog"
+.BI "\-g, \-\-gamelog"
 Defines a log file to be produced during processing. This is a game progress
 log of game-related events recording the activities of the players.
 .TP
-.BI "-h, --help"
+.BI "\-h, \-\-help"
 Prints out a description of the command line options and exits.
 .TP
-.BI "-i, --info"
+.BI "\-i, \-\-info"
 Extra info to be sent to the metaserver.
 .TP
-.BI "-l, --log"
+.BI "\-l, \-\-log"
 Defines a log file to be produced during processing. Use the
-.I -d
+.I \-d
 option to set how much is logged.
 .TP
-.BI "-m, --meta"
+.BI "\-m, \-\-meta"
 Directs the server to communicate with a metaserver, a place where Freeciv
 servers can publish their presence. Freeciv clients consult the metaserver to
 offer users a selection of games to join.
 .TP
-.BI "-M, --Metaserver"
+.BI "\-M, \-\-Metaserver"
 Sets the metaserver address.
 .TP
-.BI "-p, --port"
+.BI "\-p, \-\-port"
 Specifies the TCP port number to which clients will connect; players must know
 this number to be able to connect if they are not to use the default of 5555
 decimal. You may need to use this if 5555 is not available for your use on your
 system.
 .TP
-.BI "-q, --quitidle"
+.BI "\-q, \-\-quitidle"
 Quit if no players present for the given number of seconds.
 .TP
-.BI "-e, --exit-on-end"
+.BI "\-e, \-\-exit\-on\-end"
 When a game ends, exit instead of restarting.
 .TP
-.BI "-r, --read"
+.BI "\-r, \-\-read"
 Specifies a file of server commands which the server will automatically read 
and
 process, as if you had typed them in at the server's prompt.
 .TP
-.BI "-v, --version"
+.BI "\-v, \-\-version"
 Causes the server to display its version number and exit.
 .SH EXAMPLES
-civserver --file oldgame.sav --port 2244
+civserver \-\-file oldgame.sav \-\-port 2244
 
-civserver -g gamelog -l logfile -r script -f oldgame.sav.gz
+civserver \-g gamelog \-l logfile \-r script \-f oldgame.sav.gz
 .SH COMMANDS
 You may enter commands into the server at any time, either before or during the
 running of a game.