From 48470354588ced3f635ad15cc77490f0d4536ab3 Mon Sep 17 00:00:00 2001 From: Zachary Ware Date: Wed, 26 Nov 2014 23:44:25 -0600 Subject: [PATCH] pydoc: Add a note about setting PAGER to affect console output pagination. Suggested by James Lowden on docs@. --- Doc/library/pydoc.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index cec8a9a9381..b5e3233619c 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.