mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-26 20:52:45 +01:00
49 lines
1.3 KiB
Groff
49 lines
1.3 KiB
Groff
|
.\" Process this file with
|
||
|
|
.\" groff -man -Tascii limnoria-plugin-doc.1
|
||
|
|
.\"
|
||
|
|
.TH LIMNORIA-PLUGIN-DOC 1 "May 2009"
|
||
|
|
.SH NAME
|
||
|
|
limnoria-plugin-doc \- Generates the documentation for a Limnoria plugin
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.B limnoria-plugin-doc
|
||
|
|
.RI [ options ]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.B limnoria-plugin-doc
|
||
|
|
is used to generate documentation (StructuredText or reStructuredText format)
|
||
|
|
for a
|
||
|
|
.IR limnoria (1)
|
||
|
|
plugin.
|
||
|
|
.SH OPTIONS
|
||
|
|
.TP
|
||
|
|
.B \-\^\-version
|
||
|
|
Show version of program.
|
||
|
|
.TP
|
||
|
|
.BR \-h ", " \-\^\-help
|
||
|
|
Show summary of options.
|
||
|
|
.TP
|
||
|
|
.BR \-c ", " \-\^\-clean
|
||
|
|
Clean the various data/conf/log directories after generating the docs.
|
||
|
|
.TP
|
||
|
|
.BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR
|
||
|
|
Specifies the directory in which to write the documentation for the plugin.
|
||
|
|
.TP
|
||
|
|
.BR \-f ", " \-\^\-format= \fIFORMAT
|
||
|
|
Specifies which output format to use. Choices are 'rst' or 'stx'.
|
||
|
|
.TP
|
||
|
|
.BI \-\^\-plugins\-dir= PLUGINSDIRS
|
||
|
|
Looks in the given directory for plugins and generates documentation for all of
|
||
|
|
them.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IR python (1),
|
||
|
|
.IR limnoria (1),
|
||
|
|
.IR limnoria-test (1),
|
||
|
|
.IR limnoria-botchk (1),
|
||
|
|
.IR limnoria-wizard (1),
|
||
|
|
.IR limnoria-adduser (1),
|
||
|
|
.IR limnoria-plugin-create (1)
|
||
|
|
.SH AUTHOR
|
||
|
|
This manual page was originally written by James McCoy
|
||
|
|
<vega dot james at gmail dot com>. Permission is granted to copy,
|
||
|
|
distribute and/or modify this document under the terms of the Limnoria
|
||
|
|
license, a BSD-style license.
|