1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
|
.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH LUADOC 1 "July 31, 2007"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
luadoc \- Generate documentation from files
.SH SYNOPSIS
.B luadoc
.RI [ options ]
files
.br
.SH DESCRIPTION
This manual page documents briefly the
.B luadoc
utility.
.PP
\fBluadoc\fP is a program that generates documentation from source files
.SH OPTIONS
.TP
\fB \-d \fIpath
output directory path; should be an empty, writable directory
.TP
\fB \-t \fIpath
template directory path
.TP
\fB \-\-noindexpage
do not generate global index page
.TP
\fB \-\-nofiles
do not generate documentation for files
.TP
\fB \-\-nomodules
do not generate documentation for modules
.TP
\fB \-\-doclet \fIdoclet_module
doclet module to generate output
.TP
\fB \-\-taglet \fItaglet_module
taglet module to parse input code
.TP
\fB \-q\fR, \fB\-\-quiet
suppress all normal output
.TP
\fB \-v\fR, \fB\-\-version
print version information.
.br
.SH AUTHOR
This manual page was written by Enrico Tassi <gareuselesinge@debian.org>,
for the Debian project (but may be used by others).
|