File tree Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Original file line number Diff line number Diff line change @@ -16,12 +16,15 @@ class or function within a module or module in a package. If the
16
16
Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines
17
17
of all available modules.
18
18
19
+ Run "pydoc -n <hostname>" to start an HTTP server with the given
20
+ hostname (default: localhost) on the local machine.
21
+
19
22
Run "pydoc -p <port>" to start an HTTP server on the given port on the
20
23
local machine. Port number 0 can be used to get an arbitrary unused port.
21
24
22
25
Run "pydoc -b" to start an HTTP server on an arbitrary unused port and
23
- open a Web browser to interactively browse documentation. The -p option
24
- can be used with the -b option to explicitly specify the server port.
26
+ open a Web browser to interactively browse documentation. Combine with
27
+ the -n and -p options to control the hostname and port used .
25
28
26
29
Run "pydoc -w <name>" to write out the HTML documentation for a module
27
30
to a file named "<name>.html".
@@ -2687,8 +2690,8 @@ class BadUsage(Exception): pass
2687
2690
2688
2691
{cmd} -b
2689
2692
Start an HTTP server on an arbitrary unused port and open a Web browser
2690
- to interactively browse documentation. The -p option can be used with
2691
- the -b option to explicitly specify the server port .
2693
+ to interactively browse documentation. This option can be used in
2694
+ combination with -n and/or -p .
2692
2695
2693
2696
{cmd} -w <name> ...
2694
2697
Write out the HTML documentation for a module to a file in the current
You can’t perform that action at this time.
0 commit comments