Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

supybot-plugin-doc(1) [debian man page]

SUPYBOT-PLUGIN-DOC(1)					      General Commands Manual					     SUPYBOT-PLUGIN-DOC(1)

NAME

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

SYNOPSIS

       supybot-plugin-doc [options]

DESCRIPTION

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

OPTIONS

       --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.

SEE ALSO

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

AUTHOR

       This manual page was originally written by James Vega <jamessan at supybot dot com>.  Permission is granted to copy, distribute and/or mod-
       ify this document under the terms of the Supybot license, a BSD-style license.

								     May 2009						     SUPYBOT-PLUGIN-DOC(1)

Check Out this Related Man Page

SUPYBOT-WIZARD(1)					      General Commands Manual						 SUPYBOT-WIZARD(1)

NAME

       supybot-wizard - A wizard for creating Supybot configuration files

SYNOPSIS

       supybot-wizard [options]

DESCRIPTION

       supybot-wizard is an in-depth wizard that provides a nice user interface for creating configuration files for supybot(1).

OPTIONS

       --version
	      Show version of program.

       -h, --help
	      Show summary of options.

       --allow-root
	      Determines  whether the wizard will be allowed to run as root.  You do not want this.  Do not do it.  Even if you think you want it,
	      you do not.

       --no-network
	      Determines whether the wizard will be allowed to run without a network connection.

SEE ALSO

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

AUTHOR

       This manual page was originally written by James Vega <jamessan at supybot dot com>.  Permission is granted to copy, distribute and/or mod-
       ify this document under the terms of the Supybot license, a BSD-style license.

								  SEPTEMBER 2004						 SUPYBOT-WIZARD(1)
Man Page