== Pager Extension ==
'''This extension is distributed with Mercurial.'''

''Author: [[DavidSoria|David Soria Parra]]''

/!\ '''This extension is no longer needed for most uses.''' The pager is now built-in. Removing this extension and all of its configuration should work for most people. If you require custom behaviour beyond using the default pager to page all long commands, consult the built-in docs (''hg help [[Topic:pager]]'') .

=== 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., [[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:

{{{
[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, {{{pager.ignore}}} will be ignored.

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

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

To control whether the pager is used at all for an individual command, you can use --pager=<value>:

 * use as needed: `auto`.
 * require the pager: `yes` or `on`.
 * suppress the pager: `no` or `off` (any unrecognized value will also work).

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

You can enable and disable paging for individual commands with the {{{attend-<command>}}} option. This setting takes precedence over existing attend and ignore options and defaults:

{{{
[pager]
attend-cat = false
}}}
=== See also ===
AutopagerExtension (obsolete)

----
CategoryBundledExtension