Mercurial > public > mercurial-scm > hg-stable
diff mercurial/help/pager.txt @ 31081:900996da577a
pager: move most help to a new help topic and deprecate extension
author | Augie Fackler <augie@google.com> |
---|---|
date | Tue, 07 Feb 2017 00:07:53 -0500 |
parents | |
children | 88203f26ea57 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mercurial/help/pager.txt Tue Feb 07 00:07:53 2017 -0500 @@ -0,0 +1,28 @@ +Some Mercurial commands produce a lot of output, and Mercurial will +attempt to use a pager to make those commands more pleasant. + +To set the pager that should be used, set the application variable:: + + [pager] + pager = less -FRX + +If no pager is set, the pager extensions uses the environment variable +$PAGER. If neither pager.pager, nor $PAGER is set, a default pager +will be used, typically `more`. + +You can disable the pager for certain commands by adding them to the +pager.ignore list:: + + [pager] + ignore = version, help, update + +To ignore global commands like :hg:`version` or :hg:`help`, you have +to specify them in your user configuration file. + +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).