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

Co-authored-by: Adam Turner <[email protected]>
ebonnal · Jan 10, 2025 · 063fac1 · 063fac1
1 parent 4bdae17
commit 063fac1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/Doc/conf.py b/Doc/conf.py
@@ -199,6 +199,7 @@
     ('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
@@ -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