From: Zachary Ware <zachary.ware@gmail.com>
Date: Thu, 27 Nov 2014 05:44:25 +0000 (-0600)
Subject: pydoc: Add a note about setting PAGER to affect console output pagination.
X-Git-Tag: v2.7.10rc1~313
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6ac2b4db9463b366244b34cea6959426a645c1a2;p=python

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 494a48d607..57521f7902 100644
--- 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.