From cd8d849f6e7f2132830b62aecafcd86eda07a361 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Sun, 11 Oct 2009 17:13:11 +0200 Subject: Add man pages --- doc/cli.xhtml | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 doc/cli.xhtml (limited to 'doc/cli.xhtml') diff --git a/doc/cli.xhtml b/doc/cli.xhtml new file mode 100644 index 0000000..2643266 --- /dev/null +++ b/doc/cli.xhtml @@ -0,0 +1,161 @@ + + + + + + CLI 1.0.0 Compiler Command Line Manual + + + + + + + + + + + +
+
+ +

NAME

+ +

cli - command line interface compiler for C++

+ +

SYNOPSIS

+ +
+
cli [options] file
+
+ +

DESCRIPTION

+ +

cli generates C++ implementation for command + line interface defined in the CLI language. For an input file in the + form name.cli the following C++ files are generated: + name.hxx (header file), name.ixx + (inline file, generated unless the --suppress-inline + option is specified), and name.cxx (source file).

+ +

OPTIONS

+ +
+
--help
+
Print usage information and exit.
+ +
--version
+
Print version and exit.
+ +
--output-dir | -o dir
+
Write generated files to dir instead of + the current directory.
+ +
--suppress-inline
+
Generate all functions non-inline. By default simple functions + are made inline. This option suppresses creation of the inline + file.
+ +
--hxx-suffix suffix
+
Use the provided suffix instead of the default + .hxx to construct the name of the generated header + file.
+ +
--ixx-suffix suffix
+
Use the provided suffix instead of the default + .ixx to construct the name of the generated inline + file.
+ +
--cxx-suffix suffix
+
Use the provided suffix instead of the default + .cxx to construct the name of the generated source + file.
+ +
--option-prefix prefix
+
Use the provided 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 separator
+
Use the provided separator instead of the default + -- as an optional separator between options and + arguments. All 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 generated + #include directives.
+ +
--include-prefix prefix
+
Add prefix to generated #include + directive paths.
+ +
--guard-prefix prefix
+
Add prefix to 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 to the list of names that should not + be used as identifiers. The name can optionally be followed by + = and the replacement name that should be + used instead. All C++ keywords are already in this list.
+ +
+ +

DIAGNOSTICS

+ +

If the input file is not a valid CLI definition, cli + will issue diagnostic messages to STDERR and exit with non-zero exit + code.

+ +

BUGS

+ +

Send bug reports to the + cli-users@codesynthesis.com mailing list.

+ +
+ +
+ + -- cgit v1.1