.\" Text automatically generated by txt2man
.TH ldoc 1  "06 November 2017" "ldoc" ""
.SH NAME
\fBldoc \fP- A LuaDoc-compatible documentation generation system
\fB
.SH DESCRIPTION
LDoc, a documentation generator for Lua compatible to LuaDoc.
.SH OPTIONS
.TP
.B
\fB-d\fP, \fB--dir\fP
(default docs) output directory
.TP
.B
\fB-o\fP, \fB--output\fP
(default 'index') output name
.TP
.B
\fB-v\fP, \fB--verbose\fP
be verbose during doc generation
.TP
.B
\fB-a\fP, \fB--all\fP
show local functions, etc, in docs
.TP
.B
\fB-q\fP, \fB--quiet\fP
suppress output
.TP
.B
\fB-m\fP, \fB--module\fP
module docs as text
.TP
.B
\fB-s\fP, \fB--style\fP
(default !) directory for style sheet (ldoc.css)
.TP
.B
\fB-l\fP, \fB--template\fP
(default !) directory for template (ldoc.ltp)
.TP
.B
\fB-p\fP, \fB--project\fP
(default ldoc) project name
.TP
.B
\fB-t\fP, \fB--title\fP
(default Reference) page title
.TP
.B
\fB-f\fP, \fB--format\fP
(default  plain)  formatting, valid options are markdown,
discount or plain
.TP
.B
\fB-b\fP, \fB--package\fP
(default .) top-level package basename (needed for \fBmodule\fP(\.\.\.))
.TP
.B
\fB-x\fP, \fB--ext\fP
(default html) output file extension
.TP
.B
\fB-c\fP, \fB--config\fP
(default config.ld) configuration name
.TP
.B
\fB-u\fP, \fB--unqualified\fP
don't show package name in sidebar links
.TP
.B
\fB-i\fP, \fB--ignore\fP
ignore any 'no doc comment or no module' warnings
.TP
.B
\fB-X\fP, \fB--not_luadoc\fP
break LuaDoc compatibility. Descriptions may continue after
tags.
.TP
.B
\fB-D\fP, \fB--define\fP
(default none) set a flag to be used in config.ld
.TP
.B
\fB-C\fP, \fB--colon\fP
use colon style
.TP
.B
\fB-N\fP, \fB--no_args_infer\fP
don't infer arguments from source
.TP
.B
\fB-B\fP, \fB--boilerplate\fP
ignore first comment in source files
.TP
.B
\fB-M\fP, \fB--merge\fP
allow module merging
.TP
.B
\fB-S\fP, \fB--simple\fP
no return or params, no summary
.TP
.B
\fB-O\fP, \fB--one\fP
one-column output layout
.TP
.B
\fB--date\fP
(default system) use this date in generated doc
.TP
.B
\fB--dump\fP
debug output dump
.TP
.B
\fB--filter\fP
(default none) filter output as Lua data (e.g pl.pretty.dump)
.TP
.B
\fB--tags\fP
(default none) show all references to given tags,
comma-separated
.TP
.B
\fB--fatalwarnings\fP
non-zero exit status on any warning
.TP
.B
\fB--testing\fP
reproducible build; no date or version on output
.TP
.B
<file>
(string) source file or directory containing source
.SH EXAMPLES
.TP
.B
ldoc .
reads options from a config.ld file in the same directory
.TP
.B
ldoc \fB-c\fP path/to/myconfig.ld .
reads options from path/to/myconfig.ld
.SH AUTHOR
This manpage was written for Debian by Julian Wollrath and may be used
by others.