changeset 2505:9708182ea7f2

Improve the help texts / descriptions of few options.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 28 Apr 2020 23:24:14 +0300
parents f90a97aef546
children 609c6bcf0dac
files tools/gfxconv.c
diffstat 1 files changed, 7 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/tools/gfxconv.c	Tue Apr 28 23:15:07 2020 +0300
+++ b/tools/gfxconv.c	Tue Apr 28 23:24:14 2020 +0300
@@ -180,7 +180,9 @@
     {  2, 'v', "verbose"         , "Be more verbose", OPT_NONE },
 
     { 10, 'o', "output"          , "Output filename", OPT_ARGREQ },
-    { 12, 's', "skip"            , "Skip N bytes in input from start (negative value will be offset from input end)", OPT_ARGREQ },
+    { 12, 's', "skip"            , "Skip N bytes in input from start "
+                                   "(a negative value will be offset "
+                                   "from end of input data)", OPT_ARGREQ },
     { 14, 'i', "informat"        , "Set input format (see --formats)", OPT_ARGREQ },
     { 16, 'f', "format"          , "Set output format (see --formats)", OPT_ARGREQ },
     { 18, 'F', "formats"         , "List supported input/output formats", OPT_NONE },
@@ -188,12 +190,14 @@
     { 22, 'm', "colormap"        , "Set color map definitions (see '-m help')", OPT_ARGREQ },
     { 24, 'n', "numitems"        , "How many 'items' to output (default: all)", OPT_ARGREQ },
     { 26, 'w', "width"           , "Item width (number of items per row, min 1)", OPT_ARGREQ },
-    { 28, 'S', "scale"           , "Scale output image by specified value(s) (see '-S help')", OPT_ARGREQ },
+    { 28, 'S', "scale"           , "Scale output image (see '-S help')", OPT_ARGREQ },
     { 30, 'P', "paletted"        , "Use indexed/paletted output IF possible.", OPT_NONE },
     { 32, 'N', "nplanes"         , "# of bitplanes (some output formats)", OPT_ARGREQ },
     { 34, 'B', "bpp"             , "Bits per plane (some output formats)", OPT_ARGREQ },
     { 36, 'I', "interleave"      , "Interleaved/planar output (some output formats)", OPT_NONE },
-    { 38, 'C', "compress"        , "Use compression -C <0-9>, 0 = disable, default is 9", OPT_ARGREQ },
+    { 38, 'C', "compress"        , "Use compression -C <0-9>, 0 = disable, default is 9. "
+                                   "(Not all formats support compression and the meaning "
+                                   "apart from 0 or >= 1 depends on the format.)", OPT_ARGREQ },
     { 42, 'R', "remap"           , "Remap output image colors (see '-R help')", OPT_ARGREQ },
     { 44,   0, "char-rom"        , "Set character ROM file to be used.", OPT_ARGREQ },
     { 46, 'p', "palette"         , "Set palette to be used (see '-p help'). "