pydoc: Add a note about setting PAGER to affect console output pagination.

Suggested by James Lowden on docs@.

diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index 494a48d60712a878669c541aebe1226697b4cc50..57521f790224954caae0df427583c251de4ec08e 100644 (file)
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -53,6 +53,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.