Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2025-01-11 04:32:36 +01:00
Code Issues Projects Releases Wiki Activity

Update supybot-plugin-doc's manpage

Browse Source 
Signed-off-by: James Vega <jamessan@users.sourceforge.net>
This commit is contained in:
James Vega 2009-05-18 03:46:18 -04:00
parent 249180bc41
commit dbf58d5faa
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/man/supybot-plugin-doc.1
View File

@ -1,7 +1,7 @@
.\" Process this file with .\" Process this file with
.\" groff -man -Tascii supybot-plugin-doc.1 .\" groff -man -Tascii supybot-plugin-doc.1
.\" .\"
.TH SUPYBOT-PLUGIN-DOC 1 "APRIL 2005" .TH SUPYBOT-PLUGIN-DOC 1 "May 2009"
.SH NAME .SH NAME
supybot-plugin-doc \- Generates the documentation for a Supybot plugin supybot-plugin-doc \- Generates the documentation for a Supybot plugin
.SH SYNOPSIS .SH SYNOPSIS
@ -9,7 +9,8 @@ supybot-plugin-doc \- Generates the documentation for a Supybot plugin
.RI [ options ] .RI [ options ]
.SH DESCRIPTION .SH DESCRIPTION
.B supybot-plugin-doc .B supybot-plugin-doc
is used to generate documentation (STX format) for a is used to generate documentation (StructuredText or reStructuredText format)
for a
.IR supybot (1) .IR supybot (1)
plugin. plugin.
.SH OPTIONS .SH OPTIONS
@ -20,12 +21,14 @@ Show version of program.
.BR \-h ", " \-\^\-help .BR \-h ", " \-\^\-help
Show summary of options. Show summary of options.
.TP .TP
.BI \-c ", " \-\^\-clean .BR \-c ", " \-\^\-clean
Clean the various data/conf/log directories after generating the docs. Clean the various data/conf/log directories after generating the docs.
.TP .TP
.BR \-\^\-no\-escape .BR \-o ", " \-\^\-output\-dir= \fIOUTPUTDIR
Disables escaping of html entities e.g., < as &lt;. This is useful for making Specifies the directory in which to write the documentation for the plugin.
documentation that will not be rendered as STX on a website. .TP
.BR \-f ", " \-\^\-format= \fIFORMAT
Specifies which output format to use. Choices are 'rst' or 'stx'.
.TP .TP
.BI \-\^\-plugins\-dir= PLUGINSDIRS .BI \-\^\-plugins\-dir= PLUGINSDIRS
Looks in the given directory for plugins and generates documentation for all of Looks in the given directory for plugins and generates documentation for all of