From 5ef2ad8a5a64d0115099be75162ec311479af233 Mon Sep 17 00:00:00 2001 From: Marcelo Lira Date: Mon, 26 Oct 2009 17:04:32 -0300 Subject: applied patch from Didier Raboud, to fix mixed hyphens and minuses on manpage. --- generatorrunner.1 | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) (limited to 'generatorrunner.1') diff --git a/generatorrunner.1 b/generatorrunner.1 index c5ffc2413..60749d951 100644 --- a/generatorrunner.1 +++ b/generatorrunner.1 @@ -1,25 +1,25 @@ .TH GENERATORRUNNER 1 "SEPTEMBER 2009" Linux "User Manuals" .SH NAME -generatorrunner \- plugin-based code generator +generatorrunner - plugin-based binding source code generator .SH SYNOPSIS -.B generatorrunner --generatorSet= [options] header\-file typesystem\-file +.B generatorrunner \-\-generatorSet= [options] header-file typesystem-file .B ... .SH DESCRIPTION .B generatorrunner is a utility that uses the information taken from APIExtractor related to the provided C++ headers and typesystem files and execute generators using this information. Generators are plugins and you need -to specify one using the --generatorSet parameter. At the moment there +to specify one using the \-\-generatorSet parameter. At the moment there are two generators available: .B qtdoc -\- Generates Sphinx-based documentation for C++ libraries documented using -.B qdoc3 -documentation syntax, using the XML files created by the documentation tool +\- Generates Sphinx-based documentation for C++ libraries documented using +.B qdoc3 +documentation syntax, using the XML files created by the documentation tool .B (qdoc3). Can be called supplying -.B --generatorSet=qtdoc -to +.B \-\-generatorSet=qtdoc +to .B generatorrunner or by calling the convenience executable .B docgenerator. @@ -33,38 +33,38 @@ architecture and current limitations, refer to http://www.pyside.org/home-bindin .SH OPTIONS .SS "General options" -.IP --debug-level=[sparse|medium|full] +.IP \-\-debug-level=[sparse|medium|full] The amount of messages displayed. -.IP --documentation-only +.IP \-\-documentation-only Only generates the documentation. .TP -.BI --help \fR,\fP -h \fR,\fP -? +.BI \-\-help \fR,\fP \-h \fR,\fP -? Prints the usage message. -.IP --include-paths=\fI[:path:..]\fR +.IP \-\-include\-paths=\fI[:path:..]\fR The directories where the generator will search for the -headers. Works like gcc's -I flag. -.IP --license-file=\fI[licensefile]\fR +headers. Works like gcc's \-I flag. +.IP \-\-license\-file=\fI[licensefile]\fR Template for copyright headers of generated files. -.IP --no-supress-warnings +.IP \-\-no\-supress\-warnings Show all warnings. -.IP --output-directory=\fI[dir]\fR +.IP \-\-output\-directory=\fI[dir]\fR The directory where the generated files will be written. -.IP --silent +.IP \-\-silent Avoid printing any messages. -.IP --typesytem-paths=\fI[:path:..]\fR +.IP \-\-typesytem\-paths=\fI[:path:..]\fR The directories where the generator will search for the external typesystems referred by the main one. -.IP --version +.IP \-\-version Displays the current version. Drops support for named args. .SS "Specific to qtdoc plugin" -.IP --documentation-code-snippets-dir +.IP \-\-documentation\-code\-snippets\-dir Directory used to search code snippets used by the documentation -.IP --documentation-data-dir +.IP \-\-documentation\-data\-dir Directory with XML files generated by documentation tool (qdoc3 or Doxygen) -.IP --documentation-out-dir +.IP \-\-documentation\-out\-dir The directory where the generated documentation files will be written -.IP --library-source-dir +.IP \-\-library\-source\-dir Directory where library source code is located .SH AUTHORS -- cgit v1.2.3