GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
SUPYBOT-PLUGIN-DOC(1) FreeBSD General Commands Manual SUPYBOT-PLUGIN-DOC(1)

supybot-plugin-doc - Generates the documentation for a Supybot plugin

supybot-plugin-doc [options]

supybot-plugin-doc is used to generate documentation (StructuredText or reStructuredText format) for a supybot(1) plugin.

--version
Show version of program.
-h, --help
Show summary of options.
-c, --clean
Clean the various data/conf/log directories after generating the docs.
-o, --output-dir=OUTPUTDIR
Specifies the directory in which to write the documentation for the plugin.
-f, --format=FORMAT
Specifies which output format to use. Choices are 'rst' or 'stx'.
--plugins-dir=PLUGINSDIRS
Looks in the given directory for plugins and generates documentation for all of them.

python(1), supybot(1), supybot-test(1), supybot-botchk(1), supybot-wizard(1), supybot-adduser(1), supybot-plugin-create(1)

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 Supybot license, a BSD-style license.
May 2009
Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.