Reference

pydoc2.1(1)

the Python documentation tool

NAME

python2.1 - the Python documentation tool

SYNOPSIS

python2.1 name

python2.1 -k keyword

python2.1 -p port

python2.1 -g

python2.1 -w module [...]

DESCRIPTION

python2.1 name shows text documentation on something. name may be the name of a function, module, or package, or a dotted reference to a class or function within a module or module in a package. If name contains a '/', it is used as the path to a Python source file to document.

python2.1 -k keyword searches for a keyword in the synopsis lines of all available modules.

python2.1 -p port start an HTTP server on the given port on the local machine.

python2.1 -g pops up a graphical interface for finding and serving documentation.

python2.1 -w name [...] writes out the HTML documentation for a module to a file in the current directory. If name contains a '/', it is treated as a filename; if it names a directory, documentation is written for all the contents.

AUTHOR

Moshe Zadka, based on "pydoc --help"

History