##// END OF EJS Templates
help: attempt to clarify that pager usage is not output length based...
help: attempt to clarify that pager usage is not output length based This may be too subtle of a change to get the point across, but when I first read the original text, I thought maybe the pager would only be invoked if writing more than a screenful. The distinction between this and a pager that simply exits after printing less than a screenful is important on Windows, given the inability of `more` to color output.

File last commit:

r32138:edbbd18a stable
r32138:edbbd18a stable
Show More
pager.txt
42 lines | 1.3 KiB | text/plain | TextLexer
Matt Harbison
help: attempt to clarify that pager usage is not output length based...
r32138 Some Mercurial commands can produce a lot of output, and Mercurial will
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 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
FUJIWARA Katsunori
help: use mercurial as a subject of colorization and pagination...
r32082 If no pager is set, Mercurial uses the environment variable
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 $PAGER. If neither pager.pager, nor $PAGER is set, a default pager
Yuya Nishihara
pager: use less as a fallback on Unix...
r32078 will be used, typically `less` on Unix and `more` on Windows.
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061
Matt Harbison
help: document color/pager pitfalls on Windows...
r32137 .. container:: windows
On Windows, `more` is not color aware, so using it effectively disables color.
MSYS and Cygwin shells provide `less` as a pager, which can be configured to
support ANSI color codes. See :hg:`help config.color.pagermode` to configure
the color mode when invoking a pager.
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 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,
FUJIWARA Katsunori
help: apply bulk fixes for indentation and literal blocking issues...
r32085 you can use --pager=<value>:
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061
- use as needed: `auto`.
- require the pager: `yes` or `on`.
- suppress the pager: `no` or `off` (any unrecognized value
FUJIWARA Katsunori
help: apply bulk fixes for indentation and literal blocking issues...
r32085 will also work).
Augie Fackler
pager: add a config knob to just globally turn off the pager
r31062
To globally turn off all attempts to use a pager, set::
Pierre-Yves David
pager: rename 'pager.enable' to 'ui.paginate'...
r32105 [ui]
paginate = never
Augie Fackler
pager: add a config knob to just globally turn off the pager
r31062
which will prevent the pager from running.