PYDOC(1) BSD General Commands Manual PYDOC(1)

NAME
     ppyyddoocc - the Python documentation tool

SYNOPSIS
     ppyyddoocc name
     ppyyddoocc -kk keyword
     ppyyddoocc -pp port
     ppyyddoocc -gg
     ppyyddoocc -ww module ...
     ppyyddoocc --hheellpp

DESCRIPTION
     ppyyddoocc shows text documentation on something related to python(1).  The
     name argument may be the name of a Python keyword, topic, function, mod-
     ule, 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', 'top-
     ics', or 'modules', a listing of these things is displayed.

OOPPTTIIOONNSS
     -kk keyword     Search for a keyword in the synopsis lines of all avail-
                    able modules.

     -pp port        Start an HTTP server on the given port on the local
                    machine.

     -gg             Pop up a graphical interface for finding and serving docu-
                    mentation.

     -ww module ...  Write out the HTML documentation for a module to a file in
                    the current directory.  If module contains a '/', it is
                    treated as a filename; if it names a directory, documenta-
                    tion is written for all the contents.

     --hheellpp         Prints out a help message.

AUTHOR
     Moshe Zadka, based on "pydoc -help"

SEE ALSO
     python(1)

                                 Dec 19, 2003