Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Mercurial HG 2.0.1 PagerExtension for Win32
# - display output using a pager
# Copyright 2008 David Soria Parra <>
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
# To load the extension, add it to your configuration file:
# [extension]
# pager =
# Run "hg help pager" to get info on configuration.
'''browse command output with an external pager
To set the pager that should be used, set the application variable::
pager = less -FRSX
If no pager is set, the pager extensions uses the environment variable
$PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
If you notice "BROKEN PIPE" error messages, you can disable them by
quiet = True
You can disable the pager for certain commands by adding them to the
pager.ignore list::
ignore = version, help, update
You can also enable the pager only for certain commands using
pager.attend. Below is the default list of commands to be paged::
attend = annotate, cat, diff, export, glog, log, qdiff
Setting pager.attend to an empty value will cause all commands to be
If pager.attend is present, pager.ignore will be ignored.
To ignore global commands like :hg:`version` or :hg:`help`, you have
to specify them in your user configuration file.
The --pager=... option can also be used to control when the pager is
used. Use a boolean value like yes, no, on, off, or use auto for
normal behavior.
import sys, os, signal, shlex, errno
from mercurial import commands, dispatch, util, extensions
from mercurial.i18n import _
def _runpager(p):
if not util.safehasattr(os, 'fork'):
sys.stdout = util.popen(p, 'wb')
if util.isatty(sys.stderr):
sys.stderr = sys.stdout
fdin, fdout = os.pipe()
pid = os.fork()
if pid == 0:
os.dup2(fdout, sys.stdout.fileno())
if util.isatty(sys.stderr):
os.dup2(fdout, sys.stderr.fileno())
os.dup2(fdin, sys.stdin.fileno())
os.execvp('/bin/sh', ['/bin/sh', '-c', p])
except OSError, e:
if e.errno == errno.ENOENT:
# no /bin/sh, try executing the pager directly
args = shlex.split(p)
os.execvp(args[0], args)
def _runpager_win32(p, orig, ui, options, cmd, cmdfunc):
import tempfile, subprocess
orig(ui, options, cmd, cmdfunc)
tobepaged = ui.popbuffer()
fn = tempfile.mkstemp()[1]
f = open(fn, 'w')
f.close()[p, fn], shell=True)
def uisetup(ui):
#if ui.plain() or '--debugger' in sys.argv or not util.isatty(sys.stdout):
if ui.plain() or '--debugger' in sys.argv or not util.isatty(sys.stdout) and 'HGPLAIN' not in os.environ:
def pagecmd(orig, ui, options, cmd, cmdfunc):
p = ui.config("pager", "pager", os.environ.get("PAGER"))
if p:
attend = ui.configlist('pager', 'attend', attended)
auto = options['pager'] == 'auto'
always = util.parsebool(options['pager'])
if (always or auto and
(cmd in attend or
(cmd not in ui.configlist('pager', 'ignore') and not attend))):
ui.setconfig('ui', 'formatted', ui.formatted())
ui.setconfig('ui', 'interactive', False)
if sys.platform == 'win32':
_runpager_win32(p, orig, ui, options, cmd, cmdfunc)
if ui.configbool('pager', 'quiet'):
signal.signal(signal.SIGPIPE, signal.SIG_DFL)
return orig(ui, options, cmd, cmdfunc)
extensions.wrapfunction(dispatch, '_runcommand', pagecmd)
def extsetup(ui):
('', 'pager', 'auto',
_("when to paginate (boolean, always, auto, or never)"),
attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff']

This comment has been minimized.

Copy link
Owner Author

@shimizukawa shimizukawa commented Dec 9, 2011


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment