diff options
| author | Igor Pashev <pashev.igor@gmail.com> | 2017-09-29 13:40:02 +0300 |
|---|---|---|
| committer | Igor Pashev <pashev.igor@gmail.com> | 2017-09-29 13:40:02 +0300 |
| commit | 424a50000a78fff715de4417dba9b4498aeeee4c (patch) | |
| tree | d27f003c7d140fef24efd1b2ca1325ae099154b9 /debian/pydoc.1.in | |
| download | python3.5-debian.tar.gz | |
Imported python3.5 3.5.4-4debian/3.5.4-4debian
Diffstat (limited to 'debian/pydoc.1.in')
| -rw-r--r-- | debian/pydoc.1.in | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/debian/pydoc.1.in b/debian/pydoc.1.in new file mode 100644 index 0000000..a646e15 --- /dev/null +++ b/debian/pydoc.1.in @@ -0,0 +1,53 @@ +.TH PYDOC@VER@ 1 +.SH NAME +pydoc@VER@ \- the Python documentation tool +.SH SYNOPSIS +.PP +.B pydoc@VER@ +.I name +.PP +.B pydoc@VER@ -k +.I keyword +.PP +.B pydoc@VER@ -p +.I port +.PP +.B pydoc@VER@ -g +.PP +.B pydoc@VER@ -w +.I module [...] +.SH DESCRIPTION +.PP +.B pydoc@VER@ +.I name +Show text documentation on something. +.I 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 +.I 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. +.PP +.B pydoc@VER@ -k +.I keyword +Search for a keyword in the synopsis lines of all available modules. +.PP +.B pydoc@VER@ -p +.I port +Start an HTTP server on the given port on the local machine. +.PP +.B pydoc@VER@ -g +Pop up a graphical interface for finding and serving documentation. +.PP +.B pydoc@VER@ -w +.I name [...] +Write out the HTML documentation for a module to a file in the current +directory. If +.I name +contains a '/', it is treated as a filename; if +it names a directory, documentation is written for all the contents. +.SH AUTHOR +Moshe Zadka, based on "pydoc --help" |