Doc: Note that pydoc uses and prefers ``MANPAGER`` (#125362)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

diff --git a/Doc/conf.py b/Doc/conf.py
index 5e65d52f3c08c1f80b0c0591879d2b604d4273b9..73d7d5db26ff7b9aae2278c203e9af8e51953b82 100644 (file)
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -199,6 +199,7 @@ nitpick_ignore = [
     ('envvar', 'LC_TIME'),
     ('envvar', 'LINES'),
     ('envvar', 'LOGNAME'),
+    ('envvar', 'MANPAGER'),
     ('envvar', 'PAGER'),
     ('envvar', 'PATH'),
     ('envvar', 'PATHEXT'),

diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index 70e9c604ebac4fa9e6fc2e883a7885005a22099c..e8f153ee1b35ce03b812ccc05e2fd0b5aca5b97c 100644 (file)
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -52,8 +52,9 @@ produced for that file.
    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.
+output for easier reading.  If either the :envvar:`MANPAGER` or the
+:envvar:`PAGER` environment variable is set, :program:`pydoc` will use its
+value as a pagination program. When both are set, :envvar:`MANPAGER` is used.
 
 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