##// END OF EJS Templates
pager: drop -S option for less in example for pager configuration...
Thomas Arendsen Hein -
r17305:e66fa4d5 stable
parent child Browse files
Show More
@@ -1,140 +1,140 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 or any later version.
6 # GNU General Public License version 2 or any later version.
7 #
7 #
8 # To load the extension, add it to your configuration file:
8 # To load the extension, add it to your configuration file:
9 #
9 #
10 # [extension]
10 # [extension]
11 # pager =
11 # 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 -FRSX
20 pager = less -FRX
21
21
22 If no pager is set, the pager extensions uses the environment variable
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.
23 $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.
24
24
25 You can disable the pager for certain commands by adding them to the
25 You can disable the pager for certain commands by adding them to the
26 pager.ignore list::
26 pager.ignore list::
27
27
28 [pager]
28 [pager]
29 ignore = version, help, update
29 ignore = version, help, update
30
30
31 You can also enable the pager only for certain commands using
31 You can also enable the pager only for certain commands using
32 pager.attend. Below is the default list of commands to be paged::
32 pager.attend. Below is the default list of commands to be paged::
33
33
34 [pager]
34 [pager]
35 attend = annotate, cat, diff, export, glog, log, qdiff
35 attend = annotate, cat, diff, export, glog, log, qdiff
36
36
37 Setting pager.attend to an empty value will cause all commands to be
37 Setting pager.attend to an empty value will cause all commands to be
38 paged.
38 paged.
39
39
40 If pager.attend is present, pager.ignore will be ignored.
40 If pager.attend is present, pager.ignore will be ignored.
41
41
42 To ignore global commands like :hg:`version` or :hg:`help`, you have
42 To ignore global commands like :hg:`version` or :hg:`help`, you have
43 to specify them in your user configuration file.
43 to specify them in your user configuration file.
44
44
45 The --pager=... option can also be used to control when the pager is
45 The --pager=... option can also be used to control when the pager is
46 used. Use a boolean value like yes, no, on, off, or use auto for
46 used. Use a boolean value like yes, no, on, off, or use auto for
47 normal behavior.
47 normal behavior.
48 '''
48 '''
49
49
50 import atexit, sys, os, signal, subprocess
50 import atexit, sys, os, signal, subprocess
51 from mercurial import commands, dispatch, util, extensions
51 from mercurial import commands, dispatch, util, extensions
52 from mercurial.i18n import _
52 from mercurial.i18n import _
53
53
54 testedwith = 'internal'
54 testedwith = 'internal'
55
55
56 def _pagerfork(ui, p):
56 def _pagerfork(ui, p):
57 if not util.safehasattr(os, 'fork'):
57 if not util.safehasattr(os, 'fork'):
58 sys.stdout = util.popen(p, 'wb')
58 sys.stdout = util.popen(p, 'wb')
59 if ui._isatty(sys.stderr):
59 if ui._isatty(sys.stderr):
60 sys.stderr = sys.stdout
60 sys.stderr = sys.stdout
61 return
61 return
62 fdin, fdout = os.pipe()
62 fdin, fdout = os.pipe()
63 pid = os.fork()
63 pid = os.fork()
64 if pid == 0:
64 if pid == 0:
65 os.close(fdin)
65 os.close(fdin)
66 os.dup2(fdout, sys.stdout.fileno())
66 os.dup2(fdout, sys.stdout.fileno())
67 if ui._isatty(sys.stderr):
67 if ui._isatty(sys.stderr):
68 os.dup2(fdout, sys.stderr.fileno())
68 os.dup2(fdout, sys.stderr.fileno())
69 os.close(fdout)
69 os.close(fdout)
70 return
70 return
71 os.dup2(fdin, sys.stdin.fileno())
71 os.dup2(fdin, sys.stdin.fileno())
72 os.close(fdin)
72 os.close(fdin)
73 os.close(fdout)
73 os.close(fdout)
74 try:
74 try:
75 os.execvp('/bin/sh', ['/bin/sh', '-c', p])
75 os.execvp('/bin/sh', ['/bin/sh', '-c', p])
76 except OSError, e:
76 except OSError, e:
77 if e.errno == errno.ENOENT:
77 if e.errno == errno.ENOENT:
78 # no /bin/sh, try executing the pager directly
78 # no /bin/sh, try executing the pager directly
79 args = shlex.split(p)
79 args = shlex.split(p)
80 os.execvp(args[0], args)
80 os.execvp(args[0], args)
81 else:
81 else:
82 raise
82 raise
83
83
84 def _pagersubprocess(ui, p):
84 def _pagersubprocess(ui, p):
85 pager = subprocess.Popen(p, shell=True, bufsize=-1,
85 pager = subprocess.Popen(p, shell=True, bufsize=-1,
86 close_fds=util.closefds, stdin=subprocess.PIPE,
86 close_fds=util.closefds, stdin=subprocess.PIPE,
87 stdout=sys.stdout, stderr=sys.stderr)
87 stdout=sys.stdout, stderr=sys.stderr)
88
88
89 stdout = os.dup(sys.stdout.fileno())
89 stdout = os.dup(sys.stdout.fileno())
90 stderr = os.dup(sys.stderr.fileno())
90 stderr = os.dup(sys.stderr.fileno())
91 os.dup2(pager.stdin.fileno(), sys.stdout.fileno())
91 os.dup2(pager.stdin.fileno(), sys.stdout.fileno())
92 if ui._isatty(sys.stderr):
92 if ui._isatty(sys.stderr):
93 os.dup2(pager.stdin.fileno(), sys.stderr.fileno())
93 os.dup2(pager.stdin.fileno(), sys.stderr.fileno())
94
94
95 @atexit.register
95 @atexit.register
96 def killpager():
96 def killpager():
97 pager.stdin.close()
97 pager.stdin.close()
98 os.dup2(stdout, sys.stdout.fileno())
98 os.dup2(stdout, sys.stdout.fileno())
99 os.dup2(stderr, sys.stderr.fileno())
99 os.dup2(stderr, sys.stderr.fileno())
100 pager.wait()
100 pager.wait()
101
101
102 def _runpager(ui, p):
102 def _runpager(ui, p):
103 # The subprocess module shipped with Python <= 2.4 is buggy (issue3533).
103 # The subprocess module shipped with Python <= 2.4 is buggy (issue3533).
104 # The compat version is buggy on Windows (issue3225), but has been shipping
104 # The compat version is buggy on Windows (issue3225), but has been shipping
105 # with hg for a long time. Preserve existing functionality.
105 # with hg for a long time. Preserve existing functionality.
106 if sys.version_info >= (2, 5):
106 if sys.version_info >= (2, 5):
107 _pagersubprocess(ui, p)
107 _pagersubprocess(ui, p)
108 else:
108 else:
109 _pagerfork(ui, p)
109 _pagerfork(ui, p)
110
110
111 def uisetup(ui):
111 def uisetup(ui):
112 if '--debugger' in sys.argv or not ui.formatted():
112 if '--debugger' in sys.argv or not ui.formatted():
113 return
113 return
114
114
115 def pagecmd(orig, ui, options, cmd, cmdfunc):
115 def pagecmd(orig, ui, options, cmd, cmdfunc):
116 p = ui.config("pager", "pager", os.environ.get("PAGER"))
116 p = ui.config("pager", "pager", os.environ.get("PAGER"))
117
117
118 if p:
118 if p:
119 attend = ui.configlist('pager', 'attend', attended)
119 attend = ui.configlist('pager', 'attend', attended)
120 auto = options['pager'] == 'auto'
120 auto = options['pager'] == 'auto'
121 always = util.parsebool(options['pager'])
121 always = util.parsebool(options['pager'])
122 if (always or auto and
122 if (always or auto and
123 (cmd in attend or
123 (cmd in attend or
124 (cmd not in ui.configlist('pager', 'ignore') and not attend))):
124 (cmd not in ui.configlist('pager', 'ignore') and not attend))):
125 ui.setconfig('ui', 'formatted', ui.formatted())
125 ui.setconfig('ui', 'formatted', ui.formatted())
126 ui.setconfig('ui', 'interactive', False)
126 ui.setconfig('ui', 'interactive', False)
127 if util.safehasattr(signal, "SIGPIPE"):
127 if util.safehasattr(signal, "SIGPIPE"):
128 signal.signal(signal.SIGPIPE, signal.SIG_DFL)
128 signal.signal(signal.SIGPIPE, signal.SIG_DFL)
129 _runpager(ui, p)
129 _runpager(ui, p)
130 return orig(ui, options, cmd, cmdfunc)
130 return orig(ui, options, cmd, cmdfunc)
131
131
132 extensions.wrapfunction(dispatch, '_runcommand', pagecmd)
132 extensions.wrapfunction(dispatch, '_runcommand', pagecmd)
133
133
134 def extsetup(ui):
134 def extsetup(ui):
135 commands.globalopts.append(
135 commands.globalopts.append(
136 ('', 'pager', 'auto',
136 ('', 'pager', 'auto',
137 _("when to paginate (boolean, always, auto, or never)"),
137 _("when to paginate (boolean, always, auto, or never)"),
138 _('TYPE')))
138 _('TYPE')))
139
139
140 attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff']
140 attended = ['annotate', 'cat', 'diff', 'export', 'glog', 'log', 'qdiff']
General Comments 0
You need to be logged in to leave comments. Login now