help: document color/pager pitfalls on Windows

Even though I figured this out a few weeks ago, I was initially puzzled where
the color went when I upgraded to 4.2 on a different Windows machine.  Let's
point users reading the help into the right direction.

I wonder if we should be even more explicit about cmd.exe/MSYS/pager/color
interplay, but at least all of the breadcrumbs are here (I think).
This commit is contained in:
Matt Harbison 2017-05-03 21:58:11 -04:00
parent eef0589d4f
commit ed8a9665e2
2 changed files with 14 additions and 0 deletions

View File

@ -17,6 +17,13 @@ To disable color use::
See :hg:`help config.ui.color` for details.
.. container:: windows
The default pager on Windows does not support color, so enabling the pager
will effectively disable color. See :hg:`help config.ui.paginate` to disable
the pager. Alternately, MSYS and Cygwin shells provide `less` as a pager,
which can be configured to support ANSI color mode.
Mode
====

View File

@ -10,6 +10,13 @@ If no pager is set, Mercurial uses the environment variable
$PAGER. If neither pager.pager, nor $PAGER is set, a default pager
will be used, typically `less` on Unix and `more` on Windows.
.. 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.
You can disable the pager for certain commands by adding them to the
pager.ignore list::