[mkgmap-dev] options: description

Tue Aug 25 07:48:15 BST 2009

Valentijn, Steve, list,

On Tue, Aug 25, 2009 at 07:42:59AM +0200, Valentijn Sessink wrote:
> This may be a better description of --description, it sort of warns for
> the description that splitter puts in the args file.

> Index: resources/help/en/options
> ===================================================================
> --- resources/help/en/options	(revision 1144)
> +++ resources/help/en/options	(working copy)
> @@ -36,7 +36,12 @@
>  
>  --description=text
>  	Sets the descriptive text for the map. This may be displayed in
> -	QLandkarte, MapSource on on a GPS etc. 
> +	QLandkarte, MapSource on on a GPS etc, where it is normally shown
> +	below the family name. Example: --description="Germany, Denmark"

"on on" should be "or on"

> +	Please note: if you use splitter.jar to build a template.args file
> +	and use -c template.args, then that file may contain a
> +	"description" that will override this option. Use "--description" in
> +	splitter.jar to change the description in the template.args file.

I think that this is a general remark that would better be documented with
the -c option, something like this:

-c filename
--read-config=filename
	The given file is opened and each line is an option setting of
	the form option=value, any option that could be used on the command
	line can be used, however you omit the leading '--'.  The short
	option names with a single '-' cannot be used, simply use the
	long name instead.
+	Note: mkgmap will process options from left to right.  Options given
+	in the command line after "-c filename" will override any options
+	given in the file.  Likewise, command line options specified before
+	"-c filename" will be overridden by the option file.

Please feel free to improve the wording.  I wouldn't mention splitter.jar
in the help text, because the config file may be edited by hand.

Best regards,

	Marko