Man Page

Manual Section... (1) - page: pydoc

NAME

pydoc2.6 - the Python documentation tool

SYNOPSIS

pydoc2.6name

pydoc2.6 -kkeyword

pydoc2.6 -pport

pydoc2.6 -g

pydoc2.6 -wmodule [...]

DESCRIPTION

pydoc2.6name
Show text documentation on something.
name
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
name
contains a '/', it is used as the path to a
Python source file to document. If name is 'keywords', 'topics',
or 'modules', a listing of these things is displayed.

pydoc2.6 -kkeyword
Search for a keyword in the synopsis lines of all available modules.

pydoc2.6 -pport
Start an HTTP server on the given port on the local machine.

pydoc2.6 -g
Pop up a graphical interface for finding and serving documentation.

pydoc2.6 -wname [...]
Write 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.