Diff for "PagerExtension"

Differences between revisions 1 and 27 (spanning 26 versions)

Pager Extension

This extension is distributed with Mercurial.

Overview

Browse command output using an external pager

Configuration

Configure your .hgrc to enable the extension and set the used pager adding these lines:

  [pager]
  pager = LESS='FRX' less

  [extensions]
  pager =

If no pager is set, the pager extension 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 setting:

  [pager]
  quiet = True

If you see WARNING: terminal is not fully functional messages (which can interfere with scripted use of Mercurial, e.g., Tramp in Emacs), set:

  [pager]
  pager = LESS='FRX' less -d

where the -d argument tells less not to complain about 'dumb' terminals.

The following options are only supported by the pager extension bundled with Mercurial version 1.1 or higher:

You can disable the pager for certain commands (e.g., commands that are interactive) by adding them to the pager.ignore list:

  [pager]
  ignore = version, help, update

You can also enable the pager only for certain commands using pager.attend. As of Mercurial 1.4, a default attend list with the following commands is provided:

  [pager]
  attend = annotate, cat, diff, export, glog, log, qdiff

If pager.attend is present, the resulting behaviour will be that the pager is used for all commands listed in pager.attend, minus those which also appear in pager.ignore (an empty pager.attend with a non-empty pager.ignore behaves as if the above attend line was specified).

To ignore global commands like hg version or hg help, you have to specify them in the global .hgrc

-  ⇤ ← Revision 1 as of 2008-06-01 15:50:09 → 
  Size: 1113
  Editor: RafaelVillarBurke
  Comment: Add missing pager extension page
+   ← Revision 27 as of 2013-08-28 07:39:31 → ⇥
  Size: 2049
  Editor: DavidSoria
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
-Line 5:
+Line 4:
-''Author: David Soria Parra''
+''Author: [[DavidSoria|David Soria Parra]]''
-Line 11:
+Line 10:
-Configure your .hgrc to enable the extension and set the used pager adding these lines:
+Configure your [[.hgrc]] to enable the extension and set the used pager adding these lines:
 Line 14:
-  pager = LESS='FSRX' less
+  pager = LESS='FRX' less

  [extensions]
  pager =
-Line 16:
+Line 19:
+If no pager is set, the pager extension uses the environment variable {{{$PAGER}}}. If neither {{{pager.pager}}}, nor {{{$PAGER}}} is set, no pager is used.
-Line 17:
+Line 21:
-If no pager is set, the pager extension 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 setting:
-Line 21:
+Line 23:
-If you notice {{{BROKEN PIPE}}} error messages, you can disable them
by setting:
 Line 27:
-You can disable the pager for certain commands by adding them to the
{{{pager.ignore}}} list:
+If you see `WARNING: terminal is not fully functional` messages (which can interfere with scripted use of Mercurial, e.g., [[http://www.gnu.org/software/tramp/|Tramp in Emacs]]), set:

{{{
  [pager]
  pager = LESS='FRX' less -d
}}}
where the `-d` argument tells `less` not to complain about 'dumb' terminals.

'''The following options are only supported by the pager extension bundled with Mercurial version 1.1 or higher:'''

You can disable the pager for certain commands (e.g., commands that are interactive) by adding them to the {{{pager.ignore}}} list:
-Line 33:
+Line 43:
-You can also enable the pager only for certain commands using {{{pager.attend}}}:
+You can also enable the pager only for certain commands using {{{pager.attend}}}. As of Mercurial 1.4, a default attend list with the following commands is provided:
-Line 36:
+Line 47:
-  attend = log
+  attend = annotate, cat, diff, export, glog, log, qdiff
-Line 38:
+Line 49:
-If {{{pager.attend}}} is present, {{{pager.ignore}}} will be ignored.
+If {{{pager.attend}}} is present, the resulting behaviour will be that the pager is used for all commands listed in pager.attend, minus those which also appear in {{{pager.ignore}}} (an empty {{{pager.attend}}} with a non-empty {{{pager.ignore}}} behaves as if the above attend line was specified).
-Line 40:
+Line 51:
-To ignore global commands like {{{hg version}}} or {{{hg help}}}, you have to specify
them in the global {{{.hgrc}}}
+To ignore global commands like {{{hg version}}} or {{{hg help}}}, you have to specify them in the global {{{.hgrc}}}

=== See also ===
AutopagerExtension (obsolete)
-Line 43:
+Line 57:
-CategoryExtension
+CategoryBundledExtension