diff options
Diffstat (limited to 'doc/man/taurusdoc.1')
-rw-r--r-- | doc/man/taurusdoc.1 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/man/taurusdoc.1 b/doc/man/taurusdoc.1 new file mode 100644 index 00000000..15ccacb4 --- /dev/null +++ b/doc/man/taurusdoc.1 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.4. +.TH TAURUSDOC "1" "February 2015" "taurusdoc 3.4.0" "User Commands" +.SH NAME +taurusdoc \- manual page for taurusdoc 3.4.0 +.SH SYNOPSIS +.B taurusdoc +[\fI\,options\/\fR] +.SH DESCRIPTION +a tool to help developers preview the documentation generated by their code +.SH OPTIONS +.TP +\fB\-\-version\fR +show program's version number and exit +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-v\fR, \fB\-\-verbose\fR +display a lot of information [default] +.TP +\fB\-q\fR, \fB\-\-quiet\fR +be really silent +.TP +\fB\-\-build\-dir\fR=\fI\,BUILD_DIR\/\fR +build directory [default=./build] +.TP +\fB\-a\fR, \fB\-\-all\-files\fR +generate from scratch [default] +.TP +\fB\-\-cache\fR +use previously generated files +.TP +\fB\-\-format\fR=\fI\,BUILDER\/\fR +output format [default=html] +.TP +\fB\-\-prefix\fR=\fI\,PREFIX\/\fR +output directory +.TP +\fB\-\-class\fR=\fI\,KLASS\/\fR +full class name to generate doc for (ex.: +taurus.qt.qtgui.display.TaurusLabel +.TP +\fB\-\-package\fR=\fI\,PACKAGE\/\fR +full package name to generate doc for (ex.: +taurus.qt.qtgui.display) +.TP +\fB\-\-file\fR=\fI\,FILENAME\/\fR +RST file |