man-pages/man1/pydoc3.8.1.html
2021-03-31 01:06:50 +01:00

117 lines
2.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PYDOC3.8</TITLE>
</HEAD><BODY>
<H1>PYDOC3.8</H1>
Section: User Commands (1)<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pydoc3.8 - the Python documentation tool
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>pydoc3.8</B>
<I>name</I>
<P>
<B>pydoc3.8 -k</B>
<I>keyword</I>
<P>
<B>pydoc3.8 -p</B>
<I>port</I>
<P>
<B>pydoc3.8 -g</B>
<P>
<B>pydoc3.8 -w</B>
<I>module [...]</I>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>pydoc3.8</B>
<I>name</I>
Show text documentation on something.
<I>name</I>
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</I>
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.
<P>
<B>pydoc3.8 -k</B>
<I>keyword</I>
Search for a keyword in the synopsis lines of all available modules.
<P>
<B>pydoc3.8 -p</B>
<I>port</I>
Start an HTTP server on the given port on the local machine.
<P>
<B>pydoc3.8 -g</B>
Pop up a graphical interface for finding and serving documentation.
<P>
<B>pydoc3.8 -w</B>
<I>name [...]</I>
Write out the HTML documentation for a module to a file in the current
directory. If
<I>name</I>
contains a '/', it is treated as a filename; if
it names a directory, documentation is written for all the contents.
<A NAME="lbAE">&nbsp;</A>
<H2>AUTHOR</H2>
Moshe Zadka, based on &quot;pydoc --help&quot;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:26 GMT, March 31, 2021
</BODY>
</HTML>