pydoc2.1(1)

pydoc2.11

The python documentation tool

Usage

python2.1 name

python2.1 -k keyword

python2.1 -p port

python2.1 -g

python2.1 -w module []

Overview

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.

Releases

2 releases since Debian 3.0 (Woody); the text changed 1 time.

  1. 3.0
  2. 3.1

Author

Moshe Zadka, based on "pydoc --help"

From python2.1 2.1.3dfsg-1sarge1 in Debian 3.1 (Sarge). Parsed by carta from the page's man source.