git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4] help: colorize man pages

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 20, 2021, 15:59 UTC
Message-ID
<60a6877fa8389_2747c20842@natae.notmuch>
In-Reply-To
<b58cbdcc-abd3-ec82-7d8d-771f47c484ff@gmail.com>
Phillip Wood wrote:
Show 25 quoted lines
> On 20/05/2021 14:58, Felipe Contreras wrote:
> > Phillip Wood wrote:
> >> On 20/05/2021 05:07, Felipe Contreras wrote:
> >>> We already colorize tools traditionally not colorized by default, like
> >>> diff and grep. Let's do the same for man.
> >>
> >> I think there is a distinction between 'diff' and 'grep' where we are
> >> generating the content and help where we are running man
> > 
> > It makes a difference for git developers, not for the user.
> > 
> > The user doesn't care how the output of `git grep` was generated, all
> > she sees is that it's different from `grep`. It's in fact more
> > surprising than a difference in `git help` because it's even the same
> > comand.
> > 
> > Maybe if the command was `git man` they would be equally surprising, but
> > it's not, in fact, `git help` can be used to 1) output directly to the
> > terminal 2) view in a browser, 3) view in info program, 4) view man page
> > in woman, 5) view the man page in koqueror 6) view the man page in man.
> > 
> > Only in one case among many would the user expect to see man, therefore
> > a colorized `git grep` is more surprising.
> 
> I'm not sure I follow that argument
Do this:
  git config --global help.format html
  git help git
Do you see a man page on less?
 
Show 17 quoted lines
> >>> If the user has already set the LESS variable in his/her environment,
> >>> that is respected, and nothing changes.
> >>
> >> However if they have specified the colors they would like by using the
> >> LESS_TERMCAP_xx environment variables that the previous versions of this
> >> patch used their choice is overridden by this new patch.
> > 
> > That is true. We could add a check for that:
> > 
> >    if (getenv("LESS_TERMCAP_md"))
> >            return;
> > 
> > However, it may not be necessary since many of the tips online set these
> > variables inside a function.
> 
> The only person who has tested this patch has reported a problem with 
> it, it seems unlikely that no other users will have similar issues.
The check above will fix your problem, will it not?
-- 
Felipe Contreras
Previous: Phillip WoodNext: Phillip Wood
Message 5 of 18 in “help: colorize man pages”
  1. help: colorize man pagesFelipe Contreras, May 20, 2021
  2. Phillip WoodMay 20, 2021
  3. Felipe ContrerasMay 20, 2021
  4. Phillip WoodMay 20, 2021
  5. Felipe ContrerasMay 20, 2021
  6. Phillip WoodMay 20, 2021
  7. Felipe ContrerasMay 21, 2021
  8. Junio C HamanoMay 21, 2021
  9. Jeff KingMay 21, 2021
  10. Felipe ContrerasMay 21, 2021
  11. Jeff KingMay 21, 2021
  12. Felipe ContrerasMay 21, 2021
  13. Jeff KingMay 22, 2021
  14. Philip OakleyMay 22, 2021
  15. Felipe ContrerasMay 22, 2021
  16. Felipe ContrerasMay 22, 2021
  17. Felipe ContrerasMay 21, 2021
  18. Leah NeukirchenMay 20, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.