sys/lib/python/hgext/pager.py

   1 # pager.py - display output using a pager
   2 #
   3 # Copyright 2008 David Soria Parra <dsp@php.net>
   4 #
   5 # This software may be used and distributed according to the terms of the
   6 # GNU General Public License version 2, incorporated herein by reference.
   7 #
   8 # To load the extension, add it to your .hgrc file:
   9 #
  10 #   [extension]
  11 #   hgext.pager =
  12 #
  13 # Run "hg help pager" to get info on configuration.
  14
  15 '''browse command output with an external pager
  16
  17 To set the pager that should be used, set the application variable::
  18
  19   [pager]
  20   pager = LESS='FSRX' less
  21
  22 If no pager is set, the pager extensions uses the environment variable
  23 $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
  24
  25 If you notice "BROKEN PIPE" error messages, you can disable them by
  26 setting::
  27
  28   [pager]
  29   quiet = True
  30
  31 You can disable the pager for certain commands by adding them to the
  32 pager.ignore list::
  33
  34   [pager]
  35   ignore = version, help, update
  36
  37 You can also enable the pager only for certain commands using
  38 pager.attend::
  39
  40   [pager]
  41   attend = log
  42
  43 If pager.attend is present, pager.ignore will be ignored.
  44
  45 To ignore global commands like "hg version" or "hg help", you have to
  46 specify them in the global .hgrc
  47 '''
  48
  49 import sys, os, signal
  50 from mercurial import dispatch, util, extensions
  51
  52 def uisetup(ui):
  53     def pagecmd(orig, ui, options, cmd, cmdfunc):
  54         p = ui.config("pager", "pager", os.environ.get("PAGER"))
  55         if p and sys.stdout.isatty() and '--debugger' not in sys.argv:
  56             attend = ui.configlist('pager', 'attend')
  57             if (cmd in attend or
  58                 (cmd not in ui.configlist('pager', 'ignore') and not attend)):
  59                 sys.stderr = sys.stdout = util.popen(p, "wb")
  60                 if ui.configbool('pager', 'quiet'):
  61                     signal.signal(signal.SIGPIPE, signal.SIG_DFL)
  62         return orig(ui, options, cmd, cmdfunc)
  63
  64     extensions.wrapfunction(dispatch, '_runcommand', pagecmd)