Differences between revisions 1 and 31 (spanning 30 versions)
⇤ ← Revision 1 as of 2008-06-01 15:50:09 →
Size: 1113
Editor: RafaelVillarBurke
Comment: Add missing pager extension page
← Revision 31 as of 2019-07-03 01:02:31 → ⇥
Size: 2822
Editor: JordiGH
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
Line 5: Line 4:
''Author: David Soria Parra'' ''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]]'') .
Line 8: Line 9:
Browse command output using an external pager Browse command output using an external pager.
Line 11: Line 12:
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 13: Line 15:
  [pager]
  pager = LESS='FSRX' less		 [pager]
pager = LESS='FRX' less

[extensions]
pager =
Line 16: 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.
Line 17: Line 23:
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 25:
If you notice {{{BROKEN PIPE}}} error messages, you can disable them
by setting:
Line 24: Line 26:
  [pager]
  quiet = True		 [pager]
quiet = True
Line 27: Line 29:
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:
Line 30: Line 32:
  [pager]
  ignore = version, help, update		 [pager]
pager = LESS='FRX' less -d
Line 33: Line 35:
You can also enable the pager only for certain commands using {{{pager.attend}}}: 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 35: Line 42:
  [pager]
  attend = log		 [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
Line 40: Line 53:
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}}}

'''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)
Line 43: Line 75:
CategoryExtension CategoryBundledExtension

Pager Extension

This extension is distributed with Mercurial.

Author: 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 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., 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

PagerExtension (last edited 2019-07-03 01:05:56 by JordiGH)