[Python-modules-commits] r5357 - in packages/python-buildutils/trunk/debian (pbu.1)

[thomasbl-guest at users.alioth.debian.org]

    Date: Monday, May 19, 2008 @ 21:13:04
  Author: thomasbl-guest
Revision: 5357

* add pbu.1 manpage

Added:
  packages/python-buildutils/trunk/debian/pbu.1

Added: packages/python-buildutils/trunk/debian/pbu.1
===================================================================
--- packages/python-buildutils/trunk/debian/pbu.1	                        (rev 0)
+++ packages/python-buildutils/trunk/debian/pbu.1	2008-05-19 21:13:04 UTC (rev 5357)
@@ -0,0 +1,191 @@
+.TH PBU "1" "February 2008" "http://buildutils.lesscode.org/" "User Commands"
+.SH NAME
+pbu \- distutils extensions for developing Python libraries and applications
+.SH SYNOPSIS
+.B pbu
+.RI [OPTIONS]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B pbu
+command.
+.PP
+buildutils provides several new commands for your package setup.py
+file to help make development easier. It integrates with distutils
+using \-\-command\-packages or automatically will add commands to all your
+setuptools projects.
+.SH OPTIONS
+
+.PP
+\fBaddcommand\fR
+.br
+	add a custom distutils command to a package/setup.cfg file
+
+.PP
+\fBannounce\fR
+.br
+	send a release announcement to mailing lists like python-announce-list at python.org
+
+.PP
+\fBbundle\fR
+.br
+	create a bundle of a package plus all its dependencies
+
+.PP
+\fBchecksum\fR
+.br
+	generate MD5 and SHA-1 checksum files for distributables.
+
+.PP
+\fBetags\fR
+.br
+	generate an TAGS file over all packages and module (for use in Emacs).
+
+.PP
+\fBflakes\fR
+.br
+	find lint using the pyflakes utility.
+
+.PP
+\fBinfo\fR
+.br
+	dumps information about the project.
+
+.PP
+\fBpublish\fR
+.br
+	push distributables and documentation up to a project site using ssh/scp/sftp.
+
+.PP
+\fBpudge\fR
+.br
+	build Python documentation from restructured text documents and Python doc strings,
+.br
+	using ``Pudge <http://pudge.lesscode.org>''.
+
+.PP
+\fBpytest\fR
+.br
+	run `py.test <http://codespeak.net/py/current/doc/test.html>`_ unittests.
+
+.PP
+\fBstats\fR
+.br
+	dump statistics on the number of lines, files, modules, packages, etc.
+
+.PP
+\fBsvntag\fR
+.br
+	make a Subversion tag for a versioned release
+
+.PP
+\fBuse\fR
+.br
+	bring in a working version of a dependency (uses setuptools egg stuff).
+
+.PP
+\fB\-d\fR, \fB\-\-dest\fR=\fIDIR\fR
+.br
+	Directory where documentation should be generated.
+
+.PP
+\fB\-i\fR, \fB\-\-documents\fR=\fIFILE\fR...
+.br
+	Comma seperated list of files
+
+.PP
+\fB\-c\fR, \fB\-\-title\fR=\fITEXT\fR
+.br
+	The title of the documentation set.
+.br
+	This is used in various places in generated documentation and defaults to "Module Reference".
+.br
+	If you include a document named "index", the title from that document is used.
+
+.PP
+\fB\-f\fR, \fB\-\-force\fR
+.br
+	Force creation of documentation files even if source files are older or the same age.
+
+.PP
+\fB\-\-license\fR=\fINAME\fR
+.br
+	Include a standard license document.
+.br
+	Current options are "gnu" for the GNU Free Documentation License and "cc" for a
+.br
+	Creative Commons Attribution, NonCommercial, Copyleft license.
+
+.PP
+\fB\-x\fR, \fB\-\-xhtml\fR
+.br
+	Generate XHTML 1.0 instead of HTML 4.01. HTML 4.01 is the default due to browser compatibility issues with XHTML 1.0.
+
+
+.PP
+\fB\-e\fR, \fB\-\-ext\fR=\fITEXT\fR
+.br
+	The file extension to use when writing (X)HTML files.
+.br
+	The default is '.html'
+
+.PP
+\fB\-\-stages\fR=\fILIST\fR
+.br
+	Specify the list of stages that should be performed.
+.br	
+	This allows only portions of the generation to take place.
+.br
+	Available stages are: copy, docs, reference, index, and source.
+
+.PP
+\fB\-t\fR, \fB\-\-templates=\fR..
+.br
+	The directory where we should look for templates.
+.br
+	See the 'pbu.templates' package directory for the default template set.
+
+.PP
+\fB\-\-theme\fR=\fINAME\fR
+.br
+	The name of a built\-in theme (overrides \fB\-\-templates\fR).
+
+.PP
+\fB\-\-trac\fR=\fIURL\fR
+.br
+	Adds navigational links to a Trac site.
+
+.PP
+\fB\-v\fR, \fB\-\-verbose\fR
+.br
+	Verbose output.
+
+.PP
+\fB\-q\fR, \fB\-\-quiet\fR
+.br
+	Shutup unless something important happens.
+
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.br
+	prints help screen.
+
+
+.SH EXAMPLES
+Generate documentation for 'foo' to current directory:
+.IP
+\f(CW$ pbu \-m foo\fR
+.PP
+Generate documentation for 'foo' module/package and two documents to 'build/doc':
+.IP
+\f(CW$ pbu \-\-modules=foo \-\-documents=docs/guide.rst,docs/reference.rst \-\-dest=build/doc\fR
+.PP
+Generate documentation for the 'foo' module/package and license the work
+under the GNU Free Documentation License:
+.IP
+\f(CW$ pbu \-\-license=gnu \-\-modules=foo\fR
+.SH AUTHOR
+pbu was written by Ryan Tomayko <rtomayko at gmail.com>.
+.PP
+This manual page was written by Piotr Ozarowski <piotr at debian.org>,
+for the Debian project (but may be used by others).