revamp manpage
Julian Wollrath
10 years ago
| 0 | .TH LDOC "1" "February 2013" "ldoc 1.3.4" "User Commands" | |
| 0 | .TH LDOC "1" "User Commands" | |
| 1 | 1 | .SH NAME |
| 2 | 2 | ldoc \- A LuaDoc-compatible documentation generation system |
| 3 | 3 | .SH DESCRIPTION |
| 4 | 4 | LDoc, a documentation generator for Lua compatible to LuaDoc. |
| 5 | .SH OPTIONS | |
| 6 | .IP "\fB-d\fR, --dir" | |
| 7 | (default docs) output directory | |
| 8 | .IP "\fB-o\fR, --output" | |
| 9 | (default 'index') output name | |
| 10 | .IP "\fB-v\fR, --verbose" | |
| 11 | be verbose during doc generation | |
| 12 | .IP "\fB-a\fR, --all" | |
| 13 | show local functions, etc, in docs | |
| 14 | .IP "\fB-q\fR, --quiet" | |
| 15 | suppress output | |
| 16 | .IP "\fB-m\fR, --module" | |
| 17 | module docs as text | |
| 18 | .IP "\fB-s\fR, --style" | |
| 19 | (default !) directory for style sheet (ldoc.css) | |
| 20 | .IP "\fB-l\fR, --template" | |
| 21 | (default !) directory for template (ldoc.ltp) | |
| 22 | .IP "\fB-1\fR, --one" | |
| 23 | use one-column output layout | |
| 24 | .IP "\fB-p\fR, --project" | |
| 25 | (default ldoc) project name | |
| 26 | .IP "\fB-t\fR, --title" | |
| 27 | (default Reference) page title | |
| 28 | .IP "\fB-f\fR, --format" | |
| 29 | (default plain) formatting, valid options are | |
| 30 | .I markdown | |
| 31 | , | |
| 32 | .I discount | |
| 33 | or | |
| 34 | .I plain | |
| 35 | .IP "\fB-b\fR, --package" | |
| 36 | (default .) top-level package basename (needed for module(...)) | |
| 37 | .IP "\fB-x\fR, --ext" | |
| 38 | (default html) output file extension | |
| 39 | .IP "\fB-c\fR, --config" | |
| 40 | (default config.ld) configuration name | |
| 41 | .IP "\fB-i\fR, --ignore" | |
| 42 | ignore any 'no doc comment or no module' warnings | |
| 43 | .IP "\fB-D\fR, --define" | |
| 44 | (default none) set a flag to be used in config.ld | |
| 45 | .IP "\fB-C\fR, --colon" | |
| 46 | use colon style | |
| 47 | .IP "\fB-B\fR, --boilerplate" | |
| 48 | ignore first comment in source files | |
| 49 | .IP "\fB-M\fR, --merge" | |
| 50 | allow module merging | |
| 51 | .IP "\fB--dump\fR" | |
| 52 | debug output dump | |
| 53 | .IP "\fB--filter\fR" | |
| 54 | (default none) filter output as Lua data (e.g pl.pretty.dump) | |
| 55 | .IP "\fB--tags\fR" | |
| 56 | (default none) show all references to given tags, comma\-separated | |
| 57 | .IP "\fB<file>\fR" | |
| 58 | (string) source file or directory containing source | |
| 59 | .SH EXAMPLES | |
| 60 | .I ldoc . | |
| 61 | reads options from a | |
| 62 | .I config.ld | |
| 63 | file in the same directory | |
| 5 | 64 | .HP |
| 6 | \fB\-d\fR, \-\-dir | |
| 7 | (default docs) output directory | |
| 8 | .TP | |
| 9 | \fB\-o\fR, \-\-output | |
| 10 | (default 'index') output name | |
| 11 | .TP | |
| 12 | \fB\-v\fR, \-\-verbose | |
| 13 | verbose | |
| 14 | .TP | |
| 15 | \fB\-a\fR, \-\-all | |
| 16 | show local functions, etc, in docs | |
| 17 | .TP | |
| 18 | \fB\-q\fR, \-\-quiet | |
| 19 | suppress output | |
| 20 | .TP | |
| 21 | \fB\-m\fR, \-\-module | |
| 22 | module docs as text | |
| 23 | .HP | |
| 24 | \fB\-s\fR, \-\-style | |
| 25 | (default !) directory for style sheet (ldoc.css) | |
| 26 | .HP | |
| 27 | \fB\-l\fR, \-\-template | |
| 28 | (default !) directory for template (ldoc.ltp) | |
| 29 | .TP | |
| 30 | \fB\-1\fR, \-\-one | |
| 31 | use one\-column output layout | |
| 32 | .HP | |
| 33 | \fB\-p\fR, \-\-project | |
| 34 | (default ldoc) project name | |
| 35 | .HP | |
| 36 | \fB\-t\fR, \-\-title | |
| 37 | (default Reference) page title | |
| 38 | .HP | |
| 39 | \fB\-f\fR, \-\-format | |
| 40 | (default plain) formatting \- can be markdown, discount or plain | |
| 41 | .TP | |
| 42 | \fB\-b\fR, \-\-package | |
| 43 | (default .) top\-level package basename (needed for module(...)) | |
| 44 | .HP | |
| 45 | \fB\-x\fR, \-\-ext | |
| 46 | (default html) output file extension | |
| 47 | .HP | |
| 48 | \fB\-c\fR, \-\-config | |
| 49 | (default config.ld) configuration name | |
| 50 | .HP | |
| 51 | \fB\-i\fR, \-\-ignore | |
| 52 | ignore any 'no doc comment or no module' warnings | |
| 53 | .HP | |
| 54 | \fB\-D\fR, \-\-define | |
| 55 | (default none) set a flag to be used in config.ld | |
| 56 | .HP | |
| 57 | \fB\-C\fR, \-\-colon | |
| 58 | use colon style | |
| 59 | .HP | |
| 60 | \fB\-B\fR, \-\-boilerplate | |
| 61 | ignore first comment in source files | |
| 62 | .HP | |
| 63 | \fB\-M\fR, \-\-merge | |
| 64 | allow module merging | |
| 65 | .TP | |
| 66 | \fB\-\-dump\fR | |
| 67 | debug output dump | |
| 68 | .HP | |
| 69 | \fB\-\-filter\fR (default none) filter output as Lua data (e.g pl.pretty.dump) | |
| 70 | .HP | |
| 71 | \fB\-\-tags\fR (default none) show all references to given tags, comma\-separated | |
| 72 | .HP | |
| 73 | \fB<file>\fR | |
| 74 | (string) source file or directory containing source | |
| 75 | .SH "Examples" | |
| 76 | `ldoc .` reads options from an `config.ld` file in same directory | |
| 77 | .HP | |
| 78 | `ldoc -c path/to/myconfig.ld .` reads options from `path/to/myconfig.ld` | |
| 79 | .SH "Author" | |
| 80 | This manpage was written for Debian by Julian Wollrath. | |
| 65 | .I ldoc -c path/to/myconfig.ld . | |
| 66 | reads options from | |
| 67 | .I path/to/myconfig.ld | |
| 68 | .SH AUTHOR | |
| 69 | This manpage was written for Debian by Julian Wollrath and may be used by | |
| 70 | others. |