This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



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

NAME
     pydoc -- the Python documentation tool

SYNOPSIS
     pydoc name
     pydoc -k keyword
     pydoc -p port
     pydoc -g
     pydoc -w module ...
     pydoc --help

DESCRIPTION
     pydoc shows text documentation on something related to python(1).  The 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 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.

OPTIONS
     -k keyword     Search for a keyword in the synopsis lines of all available modules.

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

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

     -w 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 documentation
                    tion is written for all the contents.

     --help         Prints out a help message.

AUTHOR
     Moshe Zadka, based on "pydoc --help"

SEE ALSO
     python(1)

                                                Dec 19, 2003

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you? Yes It's good, but... Not helpful...