Add serialization syntax documentation. Clarify naming and wording in --help-output/--help-format
diff --git a/util/options.cc b/util/options.cc
index 7387a56..c5b619d 100644
--- a/util/options.cc
+++ b/util/options.cc
@@ -440,11 +440,13 @@
const char *text;
if (NULL == supported_formats)
- text = "Set output format";
+ text = "Set output serialization format";
else
{
char *items = g_strjoinv ("/", const_cast<char **> (supported_formats));
- text = g_strdup_printf ("Set output format\n\n Supported output formats are: %s", items);
+ text = g_strdup_printf ("Set output serialization format\n\n Supported output formats are: %s\n%s", items,
+ " text: [<glyph name or index>=<glyph cluster index within input>@<horizontal displacement>,<vertical displacement>+<horizontal advance>,<vertical advance>|...]\n"
+ " json: [{\"g\": <glyph name or index>, \"ax\": <horizontal advance>, \"ay\": <vertical advance>, \"dx\": <horizontal displacement>, \"dy\": <vertical displacement>, \"cl\": <glyph cluster index within input>}, ...]");
g_free (items);
parser->free_later ((char *) text);
}
@@ -457,8 +459,8 @@
};
parser->add_group (entries,
"output",
- "Output options:",
- "Options controlling the output",
+ "Output detination & format options (refer to --help-output-content for content options):",
+ "Options controlling the destination and form of the output",
this);
}
@@ -694,19 +696,19 @@
{
GOptionEntry entries[] =
{
- {"no-glyph-names", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_glyph_names, "Use glyph indices instead of names", NULL},
- {"no-positions", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_positions, "Do not show glyph positions", NULL},
- {"no-clusters", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_clusters, "Do not show cluster mapping", NULL},
- {"show-text", 0, 0, G_OPTION_ARG_NONE, &this->show_text, "Show input text", NULL},
- {"show-unicode", 0, 0, G_OPTION_ARG_NONE, &this->show_unicode, "Show input Unicode codepoints", NULL},
- {"show-line-num", 0, 0, G_OPTION_ARG_NONE, &this->show_line_num, "Show line numbers", NULL},
- {"verbose", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK,(gpointer) &parse_verbose, "Show everything", NULL},
+ {"show-text", 0, 0, G_OPTION_ARG_NONE, &this->show_text, "Prefix each line of output with its corresponding input text", NULL},
+ {"show-unicode", 0, 0, G_OPTION_ARG_NONE, &this->show_unicode, "Prefix each line of output with its corresponding input codepoint(s)", NULL},
+ {"show-line-num", 0, 0, G_OPTION_ARG_NONE, &this->show_line_num, "Prefix each line of output with its corresponding input line number", NULL},
+ {"verbose", 0, G_OPTION_FLAG_NO_ARG, G_OPTION_ARG_CALLBACK, (gpointer) &parse_verbose, "Prefix each line of output with each of the above", NULL},
+ {"no-glyph-names", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_glyph_names, "Output glyph indices instead of names", NULL},
+ {"no-positions", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_positions, "Do not output glyph positions", NULL},
+ {"no-clusters", 0, G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE, &this->show_clusters, "Do not output cluster indices", NULL},
{NULL}
};
parser->add_group (entries,
- "format",
- "Format options:",
- "Options controlling the formatting of buffer contents",
+ "output-content",
+ "Output content options (refer to --help-output for output syntax):",
+ "Options controlling the content of the output",
this);
}
