summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZachary Ware <zachary.ware@gmail.com>2014-11-27 05:56:10 (GMT)
committerZachary Ware <zachary.ware@gmail.com>2014-11-27 05:56:10 (GMT)
commitf25e3bfefa800c20c354843b345644ac80b646a8 (patch)
tree5b42268a167b8cee8695f24da3807ca2b10f961e
parent9b55089999bfb12b0c8f6e9ccd91f712831f31dc (diff)
parent48470354588ced3f635ad15cc77490f0d4536ab3 (diff)
downloadcpython-f25e3bfefa800c20c354843b345644ac80b646a8.zip
cpython-f25e3bfefa800c20c354843b345644ac80b646a8.tar.gz
cpython-f25e3bfefa800c20c354843b345644ac80b646a8.tar.bz2
Merge with 3.4
-rw-r--r--Doc/library/pydoc.rst4
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.