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