manpage in txt format (extra build-depend on txt2man)
Enrico Tassi
10 years ago
| 1 | 1 | Section: interpreters |
| 2 | 2 | Priority: optional |
| 3 | 3 | Maintainer: Julian Wollrath <jwollrath@web.de> |
| 4 | Build-Depends: debhelper (>= 9), dh-lua (>= 16), lua-discount, lua-filesystem, lua-penlight | |
| 4 | Build-Depends: debhelper (>= 9), dh-lua (>= 16), lua-discount, lua-filesystem, lua-penlight, txt2man | |
| 5 | 5 | Standards-Version: 3.9.4 |
| 6 | 6 | Vcs-Git: git://git.debian.org/git/pkg-lua/lua-ldoc.git |
| 7 | 7 | Vcs-Browser: http://git.debian.org/?p=pkg-lua/lua-ldoc.git |
| 0 | .TH LDOC "1" "User Commands" | |
| 1 | .SH NAME | |
| 2 | ldoc \- A LuaDoc-compatible documentation generation system | |
| 3 | .SH DESCRIPTION | |
| 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-p\fR, --project" | |
| 23 | (default ldoc) project name | |
| 24 | .IP "\fB-t\fR, --title" | |
| 25 | (default Reference) page title | |
| 26 | .IP "\fB-f\fR, --format" | |
| 27 | (default plain) formatting, valid options are | |
| 28 | .I markdown | |
| 29 | , | |
| 30 | .I discount | |
| 31 | or | |
| 32 | .I plain | |
| 33 | .IP "\fB-b\fR, --package" | |
| 34 | (default .) top-level package basename (needed for module(...)) | |
| 35 | .IP "\fB-x\fR, --ext" | |
| 36 | (default html) output file extension | |
| 37 | .IP "\fB-c\fR, --config" | |
| 38 | (default config.ld) configuration name | |
| 39 | .IP "\fB-i\fR, --ignore" | |
| 40 | ignore any 'no doc comment or no module' warnings | |
| 41 | .IP "\fB-D\fR, --define" | |
| 42 | (default none) set a flag to be used in config.ld | |
| 43 | .IP "\fB-C\fR, --colon" | |
| 44 | use colon style | |
| 45 | .IP "\fB-B\fR, --boilerplate" | |
| 46 | ignore first comment in source files | |
| 47 | .IP "\fB-M\fR, --merge" | |
| 48 | allow module merging | |
| 49 | .IP "\fB-S\fR, --simple" | |
| 50 | no return or params, no summary | |
| 51 | .IP "\fB-O\fR, --one" | |
| 52 | one-column output layout | |
| 53 | .IP "\fB--dump\fR" | |
| 54 | debug output dump | |
| 55 | .IP "\fB--filter\fR" | |
| 56 | (default none) filter output as Lua data (e.g pl.pretty.dump) | |
| 57 | .IP "\fB--tags\fR" | |
| 58 | (default none) show all references to given tags, comma\-separated | |
| 59 | .IP "\fB<file>\fR" | |
| 60 | (string) source file or directory containing source | |
| 61 | .SH EXAMPLES | |
| 62 | .I ldoc . | |
| 63 | reads options from a | |
| 64 | .I config.ld | |
| 65 | file in the same directory | |
| 66 | .HP | |
| 67 | .I ldoc -c path/to/myconfig.ld . | |
| 68 | reads options from | |
| 69 | .I path/to/myconfig.ld | |
| 70 | .SH AUTHOR | |
| 71 | This manpage was written for Debian by Julian Wollrath and may be used by | |
| 72 | others. |
| 0 | NAME | |
| 1 | ldoc - A LuaDoc-compatible documentation generation system | |
| 2 | ||
| 3 | DESCRIPTION | |
| 4 | LDoc, a documentation generator for Lua compatible to LuaDoc. | |
| 5 | ||
| 6 | OPTIONS | |
| 7 | -d, --dir (default docs) output directory | |
| 8 | -o, --output (default 'index') output name | |
| 9 | -v, --verbose be verbose during doc generation | |
| 10 | -a, --all show local functions, etc, in docs | |
| 11 | -q, --quiet suppress output | |
| 12 | -m, --module module docs as text | |
| 13 | -s, --style (default !) directory for style sheet (ldoc.css) | |
| 14 | -l, --template (default !) directory for template (ldoc.ltp) | |
| 15 | -p, --project (default ldoc) project name | |
| 16 | -t, --title (default Reference) page title | |
| 17 | -f, --format (default plain) formatting, valid options are markdown, | |
| 18 | discount or plain | |
| 19 | -b, --package (default .) top-level package basename (needed for module(...)) | |
| 20 | -x, --ext (default html) output file extension | |
| 21 | -c, --config (default config.ld) configuration name | |
| 22 | -i, --ignore ignore any 'no doc comment or no module' warnings | |
| 23 | -D, --define (default none) set a flag to be used in config.ld | |
| 24 | -C, --colon use colon style | |
| 25 | -B, --boilerplate ignore first comment in source files | |
| 26 | -M, --merge allow module merging | |
| 27 | -S, --simple no return or params, no summary | |
| 28 | -O, --one one-column output layout | |
| 29 | --dump debug output dump | |
| 30 | --filter (default none) filter output as Lua data (e.g pl.pretty.dump) | |
| 31 | --tags (default none) show all references to given tags, | |
| 32 | comma-separated | |
| 33 | <file> (string) source file or directory containing source | |
| 34 | ||
| 35 | EXAMPLES | |
| 36 | ldoc . reads options from a config.ld file in the same directory | |
| 37 | ||
| 38 | ldoc -c path/to/myconfig.ld . reads options from path/to/myconfig.ld | |
| 39 | ||
| 40 | AUTHOR | |
| 41 | This manpage was written for Debian by Julian Wollrath and may be used | |
| 42 | by others. |
| 10 | 10 | debian/tmp/usr/bin/ldoc . |
| 11 | 11 | mv out/ html |
| 12 | 12 | |
| 13 | override_dh_installman: | |
| 14 | txt2man -v "" -r "ldoc" -t "ldoc 1" debian/ldoc.1.txt > debian/ldoc.1 | |
| 15 | dh_installman | |
| 16 | ||
| 13 | 17 | override_dh_auto_clean: |
| 14 | rm -rf tests/doc tests/*/doc html | |
| 18 | rm -rf tests/doc tests/*/doc html debian/ldoc.1 | |
| 15 | 19 | dh_auto_clean |