From c3f214e5f820d298129e558d64c10e8826bf84ef Mon Sep 17 00:00:00 2001
From: Boris Kolpackov
Date: Sat, 3 Sep 2016 16:38:40 +0200
Subject: Add --omit-link-check option
---
cli/context.cxx | 25 ++--
cli/options.cli | 6 +
cli/options.cxx | 11 ++
cli/options.hxx | 4 +
cli/options.ixx | 6 +
doc/cli.1 | 82 +++++++++---
doc/cli.xhtml | 394 ++++++++++++++++++++++++++++++++++----------------------
7 files changed, 342 insertions(+), 186 deletions(-)
diff --git a/cli/context.cxx b/cli/context.cxx
index 6e2ac4c..1513e8a 100644
--- a/cli/context.cxx
+++ b/cli/context.cxx
@@ -2158,21 +2158,24 @@ end_toc ()
void context::
verify_id_ref ()
{
- bool f (false);
-
- for (id_set_type::const_iterator i (ref_set.begin ());
- i != ref_set.end ();
- ++i)
+ if (!options.omit_link_check ())
{
- if (id_set.find (*i) == id_set.end ())
+ bool f (false);
+
+ for (id_set_type::const_iterator i (ref_set.begin ());
+ i != ref_set.end ();
+ ++i)
{
- cerr << "error: no id for fragment link '#" << *i << "'" << endl;
- f = true;
+ if (id_set.find (*i) == id_set.end ())
+ {
+ cerr << "error: no id for fragment link '#" << *i << "'" << endl;
+ f = true;
+ }
}
- }
- if (f)
- throw generation_failed ();
+ if (f)
+ throw generation_failed ();
+ }
id_set.clear ();
ref_set.clear ();
diff --git a/cli/options.cli b/cli/options.cli
index a7e1cee..8b9ff5f 100644
--- a/cli/options.cli
+++ b/cli/options.cli
@@ -278,6 +278,12 @@ class options
'\cb{h2}', etc)."
};
+ bool --omit-link-check
+ {
+ "Don't check that local fragment link references (\\l{#ref ...}) resolve
+ to ids."
+ };
+
// Prologues.
//
std::vector --hxx-prologue
diff --git a/cli/options.cxx b/cli/options.cxx
index 823dcd4..1511b1c 100644
--- a/cli/options.cxx
+++ b/cli/options.cxx
@@ -610,6 +610,7 @@ options ()
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -743,6 +744,7 @@ options (int& argc,
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -879,6 +881,7 @@ options (int start,
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -1015,6 +1018,7 @@ options (int& argc,
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -1153,6 +1157,7 @@ options (int start,
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -1287,6 +1292,7 @@ options (::cli::scanner& s,
link_regex_trace_ (),
html_heading_map_ (),
html_heading_map_specified_ (false),
+ omit_link_check_ (),
hxx_prologue_ (),
hxx_prologue_specified_ (false),
ixx_prologue_ (),
@@ -1475,6 +1481,9 @@ print_usage (::std::ostream& os, ::cli::usage_para p)
<< " 'h', and '2') to HTML heading (for example," << ::std::endl
<< " 'h1', 'h2', etc)." << ::std::endl;
+ os << "--omit-link-check Don't check that local fragment link references" << ::std::endl
+ << " (\\l{#ref ...}) resolve to ids." << ::std::endl;
+
os << "--hxx-prologue Insert at the beginning of the generated" << ::std::endl
<< " C++ header file." << ::std::endl;
@@ -1700,6 +1709,8 @@ struct _cli_options_map_init
_cli_options_map_["--html-heading-map"] =
&::cli::thunk< options, std::map, &options::html_heading_map_,
&options::html_heading_map_specified_ >;
+ _cli_options_map_["--omit-link-check"] =
+ &::cli::thunk< options, bool, &options::omit_link_check_ >;
_cli_options_map_["--hxx-prologue"] =
&::cli::thunk< options, std::vector, &options::hxx_prologue_,
&options::hxx_prologue_specified_ >;
diff --git a/cli/options.hxx b/cli/options.hxx
index ed54bb2..f47fa3c 100644
--- a/cli/options.hxx
+++ b/cli/options.hxx
@@ -534,6 +534,9 @@ class options
bool
html_heading_map_specified () const;
+ const bool&
+ omit_link_check () const;
+
const std::vector&
hxx_prologue () const;
@@ -831,6 +834,7 @@ class options
bool link_regex_trace_;
std::map html_heading_map_;
bool html_heading_map_specified_;
+ bool omit_link_check_;
std::vector hxx_prologue_;
bool hxx_prologue_specified_;
std::vector ixx_prologue_;
diff --git a/cli/options.ixx b/cli/options.ixx
index 609d5a9..df89810 100644
--- a/cli/options.ixx
+++ b/cli/options.ixx
@@ -493,6 +493,12 @@ html_heading_map_specified () const
return this->html_heading_map_specified_;
}
+inline const bool& options::
+omit_link_check () const
+{
+ return this->omit_link_check_;
+}
+
inline const std::vector& options::
hxx_prologue () const
{
diff --git a/doc/cli.1 b/doc/cli.1
index c1ebfde..7a922a5 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -83,9 +83,16 @@ Generate the option description list that can be examined at runtime\.
Generate the argv_file_scanner\fR implementation\. This scanner is capable of
reading command line arguments from the argv\fR array as well as files
specified with command line options\.
+.IP "\fB--generate-vector-scanner\fR"
+Generate the vector_scanner\fR implementation\. This scanner is capable of
+reading command line arguments from \fBvector\fR\.
.IP "\fB--suppress-inline\fR"
Generate all functions non-inline\. By default simple functions are made
inline\. This option suppresses creation of the inline file\.
+.IP "\fB--suppress-cli\fR"
+Do not generate the CLI support types (scanners, parser, etc)\. Normally, the
+support types are generated unless another \fB\.cli\fR was included, in which
+case the support types are expected to be provided by its generated code\.
.IP "\fB--cli-namespace\fR \fIns\fR"
Generate the CLI support types in the \fIns\fR namespace (\fBcli\fR by
default)\. The namespace can be nested, for example \fBdetails::cli\fR\. If
@@ -95,12 +102,14 @@ namespace\.
Output stream type instead of the default \fBstd::ostream\fR that should be
used to print usage and exception information\.
.IP "\fB--generate-cxx\fR"
-Generate C++ code\. If neither \fB--generate-man\fR nor \fB--generate-html\fR
-is specified, this mode is assumed by default\.
+Generate C++ code\. If neither \fB--generate-man\fR, \fB--generate-html\fR,
+nor \fB--generate-txt\fR is specified, this mode is assumed by default\.
.IP "\fB--generate-man\fR"
Generate documentation in the man page format\.
.IP "\fB--generate-html\fR"
Generate documentation in the HTML format\.
+.IP "\fB--generate-txt\fR"
+Generate documentation in the plain text format, similar to usage\.
.IP "\fB--stdout\fR"
Write output to STDOUT instead of a file\. This option is not valid when
generating C++ code and is normally used to combine generated documentation
@@ -145,8 +154,8 @@ and would like their usage to have the same indentation level\.
Use ANSI color escape sequences when printing usage\. By "color" we really
only mean the bold and underline modifiers\. Note that Windows console does
not recognize ANSI escape sequences and will display them as garbage\.
-However, if you pipe such output through \fBless\fR(1)\fR, it will display
-them correctly\.
+However, if you pipe such output through \fBless(1)\fR, it will display them
+correctly\.
.IP "\fB--exclude-base\fR"
Exclude base class information from usage and documentation\.
.IP "\fB--include-base-last\fR"
@@ -157,13 +166,13 @@ Specify the documentation \fIkind\fR that should be used for the options class
\fIname\fR\. The \fIname\fR value should be a fully-qualified class name, for
example, \fBapp::options\fR\. The \fIkind\fR value can be \fBshort\fR,
\fBlong\fR, or \fBexclude\fR\. If the value is \fBexclude\fR, then the class
-documentation is excluded from usage and man/HTML output\. For usage, the
+documentation is excluded from usage and man/HTML/text output\. For usage, the
\fBshort\fR and \fBlong\fR values determine which usage function will be
called when the class is used as base or as part of the page usage (see
-\fB--page-usage\fR)\. For man/HTML, these values determine which documentation
-strings are used in the output\.
+\fB--page-usage\fR)\. For man/HTML/text, these values determine which
+documentation strings are used in the output\.
.IP "\fB--class\fR \fIname\fR"
-Generate the man page or HTML documentation only for the options class
+Generate the man page, HTML, or text documentation only for the options class
\fIname\fR\. The \fIname\fR value should be a fully-qualified options class
name, for example, \fBapp::options\fR\. To generate documentation for multiple
classes, repeat this option and the documentation will be produced in the
@@ -177,6 +186,28 @@ variables can be substituted in prologues and epilogues (see
\fB$\fR\fIname\fR\fB$\fR expansion syntax (use \fB$$\fR to escape expansion)\.
They can also be defined in \fB\.cli\fR files using the
"\e\fIname\fR=\fIval\fR"\fR syntax\.
+.IP "\fB--link-regex\fR \fIregex\fR"
+Add \fIregex\fR to the list of regular expressions used to transform link
+targets in the generated documentation\. The argument to this option is a
+Perl-like regular expression in the form
+\fB/\fR\fIpattern\fR\fB/\fR\fIreplacement\fR\fB/\fR\fR\. Any character can be
+used as a delimiter instead of '\fB/\fR' and the delimiter can be escaped
+inside \fIpattern\fR and \fIreplacement\fR with a backslash (\fB\e\fR)\. You
+can specify multiple regular expressions by repeating this option\. All the
+regular expressions are tried in the order specified and the first expression
+that matches is used\. Use the \fB--link-regex-trace\fR option to debug link
+transformation\.
+.IP "\fB--link-regex-trace\fR"
+Trace the process of applying regular expressions specified with the
+\fB--link-regex\fR option\. Use this option to find out why your regular
+expressions don't do what you expected them to do\.
+.IP "\fB--html-heading-map\fR \fIc\fR=\fIh\fR"
+Map CLI heading \fIc\fR (valid values: '\fBH\fR', '\fB0\fR', '\fB1\fR',
+'\fBh\fR', and '\fB2\fR') to HTML heading \fIh\fR (for example, '\fBh1\fR',
+'\fBh2\fR', etc)\.
+.IP "\fB--omit-link-check\fR"
+Don't check that local fragment link references (\el{#ref \.\.\.}) resolve to
+ids\.
.IP "\fB--hxx-prologue\fR \fItext\fR"
Insert \fItext\fR at the beginning of the generated C++ header file\.
.IP "\fB--ixx-prologue\fR \fItext\fR"
@@ -187,6 +218,8 @@ Insert \fItext\fR at the beginning of the generated C++ source file\.
Insert \fItext\fR at the beginning of the generated man page file\.
.IP "\fB--html-prologue\fR \fItext\fR"
Insert \fItext\fR at the beginning of the generated HTML file\.
+.IP "\fB--txt-prologue\fR \fItext\fR"
+Insert \fItext\fR at the beginning of the generated text file\.
.IP "\fB--hxx-epilogue\fR \fItext\fR"
Insert \fItext\fR at the end of the generated C++ header file\.
.IP "\fB--ixx-epilogue\fR \fItext\fR"
@@ -194,9 +227,11 @@ Insert \fItext\fR at the end of the generated C++ inline file\.
.IP "\fB--cxx-epilogue\fR \fItext\fR"
Insert \fItext\fR at the end of the generated C++ source file\.
.IP "\fB--man-epilogue\fR \fItext\fR"
-Insert \fItext\fR at the end of the generated man page text\.
+Insert \fItext\fR at the end of the generated man page file\.
.IP "\fB--html-epilogue\fR \fItext\fR"
-Insert \fItext\fR at the end of the generated HTML text\.
+Insert \fItext\fR at the end of the generated HTML file\.
+.IP "\fB--txt-epilogue\fR \fItext\fR"
+Insert \fItext\fR at the end of the generated text file\.
.IP "\fB--hxx-prologue-file\fR \fIfile\fR"
Insert the content of \fIfile\fR at the beginning of the generated C++ header
file\.
@@ -211,6 +246,8 @@ Insert the content of \fIfile\fR at the beginning of the generated man page
file\.
.IP "\fB--html-prologue-file\fR \fIfile\fR"
Insert the content of \fIfile\fR at the beginning of the generated HTML file\.
+.IP "\fB--txt-prologue-file\fR \fIfile\fR"
+Insert the content of \fIfile\fR at the beginning of the generated text file\.
.IP "\fB--hxx-epilogue-file\fR \fIfile\fR"
Insert the content of \fIfile\fR at the end of the generated C++ header file\.
.IP "\fB--ixx-epilogue-file\fR \fIfile\fR"
@@ -221,6 +258,8 @@ Insert the content of \fIfile\fR at the end of the generated C++ source file\.
Insert the content of \fIfile\fR at the end of the generated man page file\.
.IP "\fB--html-epilogue-file\fR \fIfile\fR"
Insert the content of \fIfile\fR at the end of the generated HTML file\.
+.IP "\fB--txt-epilogue-file\fR \fIfile\fR"
+Insert the content of \fIfile\fR at the end of the generated text file\.
.IP "\fB--output-prefix\fR \fIprefix\fR"
Add \fIprefix\fR at the beginning of the generated output file name(s)\.
.IP "\fB--output-suffix\fR \fIsuffix\fR"
@@ -242,19 +281,22 @@ generated man page file\.
.IP "\fB--html-suffix\fR \fIsuffix\fR"
Use \fIsuffix\fR instead of the default \fB\.html\fR to construct the name of
the generated HTML file\.
+.IP "\fB--txt-suffix\fR \fIsuffix\fR"
+Use \fIsuffix\fR instead of the default \fB\.txt\fR to construct the name of
+the generated text file\.
.IP "\fB--option-prefix\fR \fIprefix\fR"
-Use \fIprefix\fR instead of the default \fB-\fR as an option prefix\. Unknown
-command line arguments that start with this prefix are treated as unknown
-options\. If you set the option prefix to the empty value, then all the
-unknown command line arguments will be treated as program arguments\.
+Use \fIprefix\fR instead of the default '\fB-\fR' as an option prefix\.
+Unknown command line arguments that start with this prefix are treated as
+unknown options\. If you set the option prefix to the empty value, then all
+the unknown command line arguments will be treated as program arguments\.
.IP "\fB--option-separator\fR \fIsep\fR"
-Use \fIsep\fR instead of the default \fB--\fR as an optional separator between
-options and arguments\. All the command line arguments that are parsed after
-this separator are treated as program arguments\. Set the option separator to
-the empty value if you don't want this functionality\.
+Use \fIsep\fR instead of the default '\fB--\fR' as an optional separator
+between options and arguments\. All the command line arguments that are parsed
+after this separator are treated as program arguments\. Set the option
+separator to the empty value if you don't want this functionality\.
.IP "\fB--include-with-brackets\fR"
-Use angle brackets (<>) instead of quotes ("") in the generated \fB#include\fR
-directives\.
+Use angle brackets (\fB<>\fR) instead of quotes (\fB""\fR) in the generated
+\fB#include\fR directives\.
.IP "\fB--include-prefix\fR \fIprefix\fR"
Add \fIprefix\fR to the generated \fB#include\fR directive paths\.
.IP "\fB--guard-prefix\fR \fIprefix\fR"
diff --git a/doc/cli.xhtml b/doc/cli.xhtml
index 99c2f78..dff4fba 100644
--- a/doc/cli.xhtml
+++ b/doc/cli.xhtml
@@ -77,15 +77,15 @@
--version
Print version and exit.
- --include-path
|-I
dir
- Search dir for bracket-included (<>
)
- options files.
+ --include-path
|-I
dir
+ Search dir
for bracket-included
+ (<>
) options files.
- --output-dir
|-o
dir
- Write the generated files to dir instead of the current
- directory.
+ --output-dir
|-o
dir
+ Write the generated files to dir
instead of the
+ current directory.
- --std
version
+ --std
version
Specify the C++ standard that should be used during compilation. Valid
values are c++98
(default), c++11
,
and c++14
.
@@ -113,24 +113,36 @@
argv
array as well as files specified with command line
options.
+ --generate-vector-scanner
+ Generate the vector_scanner
implementation. This scanner
+ is capable of reading command line arguments from
+ vector<string>
.
+
--suppress-inline
Generate all functions non-inline. By default simple functions are
made inline. This option suppresses creation of the inline file.
- --cli-namespace
ns
- Generate the CLI support types in the ns namespace
+ --suppress-cli
+ Do not generate the CLI support types (scanners, parser, etc).
+ Normally, the support types are generated unless another
+ .cli
was included, in which case the support types are
+ expected to be provided by its generated code.
+
+ --cli-namespace
ns
+ Generate the CLI support types in the ns
namespace
(cli
by default). The namespace can be nested, for
example details::cli
. If the namespace is empty, then
the support types are generated in the global namespace.
- --ostream-type
type
+ --ostream-type
type
Output stream type instead of the default
std::ostream
that should be used to print usage and
exception information.
--generate-cxx
- Generate C++ code. If neither --generate-man
nor
- --generate-html
is specified, this mode is assumed by
+ Generate C++ code. If neither --generate-man
,
+ --generate-html
, nor
+ --generate-txt
is specified, this mode is assumed by
default.
--generate-man
@@ -139,6 +151,10 @@
--generate-html
Generate documentation in the HTML format.
+ --generate-txt
+ Generate documentation in the plain text format, similar to
+ usage.
+
--stdout
Write output to STDOUT instead of a file. This option is not valid
when generating C++ code and is normally used to combine generated
@@ -163,16 +179,17 @@
implementation the long documentation string is always used, even if the
short version is provided.
- --page-usage
name
+ --page-usage
name
Generate the combined usage printing code for the entire page.
Specifically, this will include all the namespace-level documentation as
well as usage for all the options classes printed in the order they are
defined in the main translation unit (documentation/classes from included
units are ignored except for base classes).
- The name argument is used as a prefix to form the name of the
- usage printing function. It can include the namespace qualification as
- well as documentation variable expansion, for example:
+ The name
argument is used as a prefix to form the
+ name of the usage printing function. It can include the namespace
+ qualification as well as documentation variable expansion, for
+ example:
--page-usage print_ # print_usage() in global namespace
--page-usage app::print_ # print_usage() in app namespace
@@ -182,18 +199,18 @@
--short-usage
options are specified, then the long
usage function has the *long_usage()
suffix.
- --option-length
len
- Indent option descriptions len characters when printing usage.
- This is useful when you have multiple options classes, potentially in
- separate files, and would like their usage to have the same indentation
- level.
+ --option-length
len
+ Indent option descriptions len
characters when
+ printing usage. This is useful when you have multiple options classes,
+ potentially in separate files, and would like their usage to have the same
+ indentation level.
--ansi-color
Use ANSI color escape sequences when printing usage. By "color" we
really only mean the bold and underline modifiers. Note that Windows
console does not recognize ANSI escape sequences and will display them as
garbage. However, if you pipe such output through
- less(1)
, it will display them correctly.
+ less(1)
, it will display them correctly.
--exclude-base
Exclude base class information from usage and documentation.
@@ -202,179 +219,246 @@
Include base class information after derived for usage and
documentation. By default, base classes are included first.
- --class-doc
name=kind
- Specify the documentation kind that should be used for the
- options class name. The name value should be a
- fully-qualified class name, for example, app::options
.
- The kind value can be short
,
- long
, or exclude
. If the value is
- exclude
, then the class documentation is excluded from
- usage and man/HTML output. For usage, the short
and
+ --class-doc
name
=kind
+ Specify the documentation kind
that should be used
+ for the options class name
. The
+ name
value should be a fully-qualified class name, for
+ example, app::options
. The kind
+ value can be short
, long
, or
+ exclude
. If the value is exclude
,
+ then the class documentation is excluded from usage and man/HTML/text
+ output. For usage, the short
and
long
values determine which usage function will be
called when the class is used as base or as part of the page usage (see
- --page-usage
). For man/HTML, these values determine
- which documentation strings are used in the output.
-
- --class
name
- Generate the man page or HTML documentation only for the options class
- name. The name value should be a fully-qualified options
- class name, for example, app::options
. To generate
- documentation for multiple classes, repeat this option and the
- documentation will be produced in the order specified. This functionality
- is useful if you need to assemble documentation from multiple classes in a
- specific order or to insert custom documentation between options belonging
- to different classes.
-
- --docvar
|-v
name=val
- Set documentation variable name to the value val.
- Documentation variables can be substituted in prologues and epilogues (see
- --*-prologue*
and --*-epilogue*
- options) using the $
name$
+ --page-usage
). For man/HTML/text, these values
+ determine which documentation strings are used in the output.
+
+ --class
name
+ Generate the man page, HTML, or text documentation only for the
+ options class name
. The name
value
+ should be a fully-qualified options class name, for example,
+ app::options
. To generate documentation for multiple
+ classes, repeat this option and the documentation will be produced in the
+ order specified. This functionality is useful if you need to assemble
+ documentation from multiple classes in a specific order or to insert
+ custom documentation between options belonging to different classes.
+
+ --docvar
|-v
name
=val
+ Set documentation variable name
to the value
+ val
. Documentation variables can be substituted in
+ prologues and epilogues (see --*-prologue*
and
+ --*-epilogue*
options) using the
+ $
name
$
expansion syntax (use $$
to escape expansion). They
can also be defined in .cli
files using the
- "\name=val"
syntax.
+ "\name
=val
"
+ syntax.
+
+ --link-regex
regex
+ Add regex
to the list of regular expressions used
+ to transform link targets in the generated documentation. The argument to
+ this option is a Perl-like regular expression in the form
+ /pattern/replacement/
. Any
+ character can be used as a delimiter instead of '/
'
+ and the delimiter can be escaped inside pattern
and
+ replacement
with a backslash (\
).
+ You can specify multiple regular expressions by repeating this option. All
+ the regular expressions are tried in the order specified and the first
+ expression that matches is used. Use the
+ --link-regex-trace
option to debug link
+ transformation.
+
+ --link-regex-trace
+ Trace the process of applying regular expressions specified with the
+ --link-regex
option. Use this option to find out why
+ your regular expressions don't do what you expected them to do.
+
+ --html-heading-map
c
=h
+ Map CLI heading c
(valid values:
+ 'H
', '0
', '1
',
+ 'h
', and '2
') to HTML heading
+ h
(for example, 'h1
',
+ 'h2
', etc).
+
+ --omit-link-check
+ Don't check that local fragment link references (\l{#ref ...}) resolve
+ to ids.
+
+ --hxx-prologue
text
+ Insert text
at the beginning of the generated C++
+ header file.
- --hxx-prologue
text
- Insert text at the beginning of the generated C++ header
+ --ixx-prologue
text
+ Insert text
at the beginning of the generated C++
+ inline file.
+
+ --cxx-prologue
text
+ Insert text
at the beginning of the generated C++
+ source file.
+
+ --man-prologue
text
+ Insert text
at the beginning of the generated man
+ page file.
+
+ --html-prologue
text
+ Insert text
at the beginning of the generated HTML
file.
- --ixx-prologue
text
- Insert text at the beginning of the generated C++ inline
+ --txt-prologue
text
+ Insert text
at the beginning of the generated text
file.
- --cxx-prologue
text
- Insert text at the beginning of the generated C++ source
+ --hxx-epilogue
text
+ Insert text
at the end of the generated C++ header
file.
- --man-prologue
text
- Insert text at the beginning of the generated man page
+ --ixx-epilogue
text
+ Insert text
at the end of the generated C++ inline
file.
- --html-prologue
text
- Insert text at the beginning of the generated HTML file.
+ --cxx-epilogue
text
+ Insert text
at the end of the generated C++ source
+ file.
- --hxx-epilogue
text
- Insert text at the end of the generated C++ header file.
+ --man-epilogue
text
+ Insert text
at the end of the generated man page
+ file.
- --ixx-epilogue
text
- Insert text at the end of the generated C++ inline file.
+ --html-epilogue
text
+ Insert text
at the end of the generated HTML
+ file.
- --cxx-epilogue
text
- Insert text at the end of the generated C++ source file.
+ --txt-epilogue
text
+ Insert text
at the end of the generated text
+ file.
- --man-epilogue
text
- Insert text at the end of the generated man page text.
+ --hxx-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated C++ header file.
- --html-epilogue
text
- Insert text at the end of the generated HTML text.
+ --ixx-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated C++ inline file.
- --hxx-prologue-file
file
- Insert the content of file at the beginning of the generated
- C++ header file.
+ --cxx-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated C++ source file.
- --ixx-prologue-file
file
- Insert the content of file at the beginning of the generated
- C++ inline file.
+ --man-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated man page file.
- --cxx-prologue-file
file
- Insert the content of file at the beginning of the generated
- C++ source file.
+ --html-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated HTML file.
- --man-prologue-file
file
- Insert the content of file at the beginning of the generated
- man page file.
+ --txt-prologue-file
file
+ Insert the content of file
at the beginning of the
+ generated text file.
- --html-prologue-file
file
- Insert the content of file at the beginning of the generated
- HTML file.
+ --hxx-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated C++ header file.
- --hxx-epilogue-file
file
- Insert the content of file at the end of the generated C++
- header file.
+ --ixx-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated C++ inline file.
- --ixx-epilogue-file
file
- Insert the content of file at the end of the generated C++
- inline file.
+ --cxx-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated C++ source file.
- --cxx-epilogue-file
file
- Insert the content of file at the end of the generated C++
- source file.
+ --man-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated man page file.
- --man-epilogue-file
file
- Insert the content of file at the end of the generated man page
- file.
+ --html-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated HTML file.
- --html-epilogue-file
file
- Insert the content of file at the end of the generated HTML
- file.
+ --txt-epilogue-file
file
+ Insert the content of file
at the end of the
+ generated text file.
- --output-prefix
prefix
- Add prefix at the beginning of the generated output file
- name(s).
+ --output-prefix
prefix
+ Add prefix
at the beginning of the generated
+ output file name(s).
- --output-suffix
suffix
- Add suffix at the end of the generated output file name(s).
- Note that it is added before any file type-specific suffixes; see
+ --output-suffix
suffix
+ Add suffix
at the end of the generated output file
+ name(s). Note that it is added before any file type-specific suffixes; see
--*-suffix
below.
- --hxx-suffix
suffix
- Use suffix instead of the default .hxx
to
- construct the name of the generated header file.
+ --hxx-suffix
suffix
+ Use suffix
instead of the default
+ .hxx
to construct the name of the generated header
+ file.
+
+ --ixx-suffix
suffix
+ Use suffix
instead of the default
+ .ixx
to construct the name of the generated inline
+ file.
- --ixx-suffix
suffix
- Use suffix instead of the default .ixx
to
- construct the name of the generated inline file.
+ --cxx-suffix
suffix
+ Use suffix
instead of the default
+ .cxx
to construct the name of the generated source
+ file.
- --cxx-suffix
suffix
- Use suffix instead of the default .cxx
to
- construct the name of the generated source file.
+ --man-suffix
suffix
+ Use suffix
instead of the default
+ .1
to construct the name of the generated man page
+ file.
- --man-suffix
suffix
- Use suffix instead of the default .1
to
- construct the name of the generated man page file.
+ --html-suffix
suffix
+ Use suffix
instead of the default
+ .html
to construct the name of the generated HTML
+ file.
- --html-suffix
suffix
- Use suffix instead of the default .html
to
- construct the name of the generated HTML file.
+ --txt-suffix
suffix
+ Use suffix
instead of the default
+ .txt
to construct the name of the generated text
+ file.
- --option-prefix
prefix
- Use prefix instead of the default -
as an
- option prefix. Unknown command line arguments that start with this prefix
- are treated as unknown options. If you set the option prefix to the empty
- value, then all the unknown command line arguments will be treated as
- program arguments.
+ --option-prefix
prefix
+ Use prefix
instead of the default
+ '-
' as an option prefix. Unknown command line
+ arguments that start with this prefix are treated as unknown options. If
+ you set the option prefix to the empty value, then all the unknown command
+ line arguments will be treated as program arguments.
- --option-separator
sep
- Use sep instead of the default --
as an
- optional separator between options and arguments. All the command line
- arguments that are parsed after this separator are treated as program
- arguments. Set the option separator to the empty value if you don't want
- this functionality.
+ --option-separator
sep
+ Use sep
instead of the default
+ '--
' as an optional separator between options and
+ arguments. All the command line arguments that are parsed after this
+ separator are treated as program arguments. Set the option separator to
+ the empty value if you don't want this functionality.
--include-with-brackets
- Use angle brackets (<>) instead of quotes ("") in the generated
- #include
directives.
-
- --include-prefix
prefix
- Add prefix to the generated #include
- directive paths.
-
- --guard-prefix
prefix
- Add prefix to the generated header inclusion guards. The prefix
- is transformed to upper case and characters that are illegal in a
- preprocessor macro name are replaced with underscores.
-
- --reserved-name
name=rep
- Add name with an optional rep replacement to the list of
- names that should not be used as identifiers. If provided, the replacement
- name is used instead. All C++ keywords are already in this list.
-
- --options-file
file
- Read additional options from file with each option appearing on
- a separate line optionally followed by space and an option value. Empty
- lines and lines starting with #
are ignored. Option
- values can be enclosed in double ("
) or single
- ('
) quotes to preserve leading and trailing
+ Use angle brackets (<>
) instead of quotes
+ (""
) in the generated #include
+ directives.
+
+ --include-prefix
prefix
+ Add prefix
to the generated
+ #include
directive paths.
+
+ --guard-prefix
prefix
+ Add prefix
to the generated header inclusion
+ guards. The prefix is transformed to upper case and characters that are
+ illegal in a preprocessor macro name are replaced with underscores.
+
+ --reserved-name
name
=rep
+ Add name
with an optional rep
+ replacement to the list of names that should not be used as identifiers.
+ If provided, the replacement name is used instead. All C++ keywords are
+ already in this list.
+
+ --options-file
file
+ Read additional options from file
with each option
+ appearing on a separate line optionally followed by space and an option
+ value. Empty lines and lines starting with #
are
+ ignored. Option values can be enclosed in double ("
)
+ or single ('
) quotes to preserve leading and trailing
whitespaces as well as to specify empty values. If the value itself
contains trailing or leading quotes, enclose it with an extra pair of
quotes, for example '"x"'
. Non-leading and
--
cgit v1.1