pydoc.1   [plain text]


.Dd Dec 19, 2003
.Dt PYDOC 1
.Sh NAME
.Nm pydoc
.Nd the Python documentation tool
.Sh SYNOPSIS
.Nm 
.Ar name
.Nm 
.Fl k
.Ar keyword
.Nm
.Fl p
.Ar port
.Nm
.Fl g
.Nm
.Fl w
.Ar module ...
.Nm
.Fl -help
.Sh DESCRIPTION
.Nm
shows text documentation on something related to
.Xr python 1 .
The
.Ar name
argument may be the name of a Python keyword, topic, function, module, or
package, or a dotted reference to a class or function within a
module or module in a package.
If
.Ar name
contains a '/', it is used as the path to a Python source file to document.
If
.Ar name
is 'keywords', 'topics', or 'modules', a listing of these things is displayed.
.Sh OPTIONS
.Bl -tag -width "XwXmoduleXXXX"
.It Fl k Ar keyword
Search for a keyword in the synopsis lines of all available modules.
.It Fl p Ar port
Start an HTTP server on the given port on the local machine.
.It Fl g
Pop up a graphical interface for finding and serving documentation.
.It Fl w Ar module ...
Write out the HTML documentation for a module to a file in the current
directory.
If
.Ar module
contains a '/', it is treated as a filename; if it names a directory,
documentation is written for all the contents.
.It Fl -help
Prints out a help message.
.El
.Sh AUTHOR
Moshe Zadka, based on "pydoc --help"
.Sh "SEE ALSO"
.Ns Xr python 1