mirror of
https://github.com/python/cpython.git
synced 2024-11-23 18:04:37 +08:00
pydoc: Add a note about setting PAGER to affect console output pagination.
Suggested by James Lowden on docs@.
This commit is contained in:
parent
b004943e9b
commit
4847035458
@ -51,6 +51,10 @@ produced for that file.
|
||||
executed on that occasion. Use an ``if __name__ == '__main__':`` guard to
|
||||
only execute code when a file is invoked as a script and not just imported.
|
||||
|
||||
When printing output to the console, :program:`pydoc` attempts to paginate the
|
||||
output for easier reading. If the :envvar:`PAGER` environment variable is set,
|
||||
:program:`pydoc` will use its value as a pagination program.
|
||||
|
||||
Specifying a ``-w`` flag before the argument will cause HTML documentation
|
||||
to be written out to a file in the current directory, instead of displaying text
|
||||
on the console.
|
||||
|
Loading…
Reference in New Issue
Block a user