Re: (PR#11996) incomplete manpage

This is a multi-part message in MIME format...

------------=_1107047579-6548-4
Content-Type: text/plain; charset="utf-8"


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

Here's a patch that fixes some of the issues in the two manpages
(civserver.6 and civclient.6).

Jason had given me a list of the environment variables, but some of
the descriptions are a bit brief as I don't know much about the inner
workings of the code.  If someone would like to send me improved
descriptions I'd be more than happy to add them to the manpages and
submit patches.

This patch was created using the latest cvs snapshot
(freeciv-cvs-Jan-28.tar.bz2).

-Ben Bettin


On Mon, 24 Jan 2005 23:48:59 -0800, Jason Short
<[email protected]> wrote:
> 
> <URL: http://bugs.freeciv.org/Ticket/Display.html?id=11996 >
> 
> I'm committing these manpages, because they're clearly an improvement.
> 
> However I think there are some things that could be improved further:
> 
> - Some grammar isn't perfect (esp. missing periods and sentence fragments).
> 
> - No mention of bugs-0/[email protected] for bug reporting.
> 
> - The list of environment variables is incomplete.  To find a full list
> you'd probably have to examine the code (searching the .c files for
> "getenv").  Most such variables apply to server and client.
> 
> - It mentions /usr/local/share/freeciv/scenarios/.  We *could* have this
> string (and other path-specific ones) be accurate, by using a
> civserver.in and @DATADIR@ (or something like that).
> 
> -jason
> 
>


------------=_1107047579-6548-4
Content-Type: text/x-patch; charset="ascii"; name="manpages.diff"
Content-Disposition: inline; filename="manpages.diff"
Content-Transfer-Encoding: 7bit

--- civserver.6.orig	2005-01-29 20:04:39.000000000 -0500
+++ civserver.6	2005-01-29 20:02:35.000000000 -0500
@@ -9,7 +9,7 @@
 .\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\"   GNU General Public License for more details.
 .\"
-.TH FREECIV 6 "January 24th 2005"
+.TH FREECIV 6 "January 29th 2005"
 .SH NAME
 civserver \- The server for the Freeciv game
 .SH SYNOPSIS
@@ -239,6 +239,21 @@
 with the capability facility in the source you may use it to enforce some
 constraints between clients and server.
 .TP
+.BI FREECIV_COMPRESSION_LEVEL
+Sets the compression level.
+.TP
+.BI FREECIV_DATA_ENCODING
+Sets the data encoding (used for data files, savegames, and network strings).
+.TP
+.BI FREECIV_INTERNAL_ENCODING
+Sets the internal encoding (used for GUI strings).
+.TP
+.BI FREECIV_LOCAL_ENCODING
+Sets the local encoding (used for terminal output).
+.TP 
+.BI FREECIV_MULTICAST_GROUP
+Sets the multicast group (for the LAN tab).
+.TP
 .BI FREECIV_PATH
 A colon separated list of directories pointing to the
 .B freeciv
@@ -247,17 +262,28 @@
 current directory; the subdirectory ".freeciv" in the user's home directory; and
 the directory where the files are placed by running "make install".
 .TP
-.BI FREECIV_LOCAL_ENCODING
-The local encoding to be used.
+.BI HOME
+Specifies the user's home directory.
 .TP
 .BI http_proxy
 Set this variable accordingly when using a proxy.
+.TP
+\fBLANG\fP  or  \fBLANGUAGE\fP
+Sets the language and locale (platform-dependent).
+.TP
+\fBLC_ALL\fP  or  \fBLC_CTYPE\fP
+Similar to LANG (platform-dependent).
+.TP
+.BI USER
+Specifies the username of the current user.
 .SH BUGS
 Please report bugs to
 .UR
 http://bugs.freeciv.org/
 .UE
 \.
+
+Tickets may also be created by sending an email to <bugs AT freeciv.org>.
 .SH "MORE INFO"
 The Freeciv homepage is located at
 .UR
--- civclient.6.orig	2005-01-29 20:04:30.000000000 -0500
+++ civclient.6	2005-01-29 20:02:46.000000000 -0500
@@ -9,7 +9,7 @@
 .\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\"   GNU General Public License for more details.
 .\"
-.TH FREECIV 6 "January 24th 2005"
+.TH FREECIV 6 "January 29th 2005"
 .SH NAME
 civclient \- The client for the Freeciv game
 .SH SYNOPSIS
@@ -164,6 +164,27 @@
 .SH ENVIRONMENT
 The Freeciv client accepts these environment variables:
 .TP
+.BI FREECIV_CAPS
+A string containing a list of "capabilities" provided by the server. The
+compiled-in default should be correct for most purposes, but if you are familiar
+with the capability facility in the source you may use it to enforce some
+constraints between clients and server.
+.TP
+.BI FREECIV_COMPRESSION_LEVEL
+Sets the compression level.
+.TP
+.BI FREECIV_DATA_ENCODING
+Sets the data encoding (used for data files, savegames, and network strings).
+.TP
+.BI FREECIV_INTERNAL_ENCODING
+Sets the internal encoding (used for GUI strings).
+.TP
+.BI FREECIV_LOCAL_ENCODING
+Sets the local encoding (used for terminal output).
+.TP 
+.BI FREECIV_MULTICAST_GROUP
+Sets the multicast group (for the LAN tab).
+.TP
 .BI FREECIV_PATH
 A colon separated list of directories pointing to the
 .B freeciv
@@ -172,17 +193,28 @@
 current directory; the subdirectory ".freeciv" in the user's home directory; and
 the directory where the files are placed by running "make install".
 .TP
-.BI FREECIV_LOCAL_ENCODING
-The local encoding to be used.
+.BI HOME
+Specifies the user's home directory.
 .TP
 .BI http_proxy
 Set this variable accordingly when using a proxy.
+.TP
+\fBLANG\fP  or  \fBLANGUAGE\fP
+Sets the language and locale (platform-dependent).
+.TP
+\fBLC_ALL\fP  or  \fBLC_CTYPE\fP
+Similar to LANG (platform-dependent).
+.TP
+.BI USER
+Specifies the username of the current user.
 .SH BUGS
 Please report bugs to
 .UR
 http://bugs.freeciv.org/
 .UE
 \.
+
+Tickets may also be created by sending an email to <bugs AT freeciv.org>.
 .SH "MORE INFO"
 The Freeciv homepage is located at
 .UR

------------=_1107047579-6548-4--