diff options
| author | Zachary Ware <zachary.ware@gmail.com> | 2014-11-27 05:44:25 (GMT) |
|---|---|---|
| committer | Zachary Ware <zachary.ware@gmail.com> | 2014-11-27 05:44:25 (GMT) |
| commit | 48470354588ced3f635ad15cc77490f0d4536ab3 (patch) | |
| tree | 3ac7ba8aad2920c31f0085cabc20b752ab3177c9 /Doc/library/pydoc.rst | |
| parent | b004943e9bca2f938b313172367a271f69aa29a5 (diff) | |
| download | cpython-48470354588ced3f635ad15cc77490f0d4536ab3.zip cpython-48470354588ced3f635ad15cc77490f0d4536ab3.tar.gz cpython-48470354588ced3f635ad15cc77490f0d4536ab3.tar.bz2 | |
pydoc: Add a note about setting PAGER to affect console output pagination.
Suggested by James Lowden on docs@.
Diffstat (limited to 'Doc/library/pydoc.rst')
| -rw-r--r-- | Doc/library/pydoc.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index cec8a9a..b5e3233 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -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. |