# [PATCH] Documentation: help: explain 'man.viewer' multiple values 6 messages from 2008-03-13 to 2008-03-15. Participants: Christian Couder, Xavier Maillard, Junio C Hamano. Thread: https://gitlist.dev/t/12663 ## Christian Couder, 2008-03-13 05:48 Subject: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <20080313064846.b6b54c11.chriscool@tuxfamily.org> URL: https://gitlist.dev/e/20080313064846.b6b54c11.chriscool%40tuxfamily.org ``` Also add titles to paragraphs under "CONFIGURATION VARIABLES". Signed-off-by: Christian Couder --- Documentation/config.txt | 2 +- Documentation/git-help.txt | 29 ++++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index f64b269..c72c2e6 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -749,7 +749,7 @@ log.showroot:: normally hide the root commit will now show it. True by default. man.viewer:: - Specify the program that will be used to display help in the + Specify the programs that may be used to display help in the 'man' format. See linkgit:git-help[1]. merge.summary:: diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 73a51ae..89f6d25 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -43,7 +43,7 @@ OPTIONS + By default the 'man' program will be used to display the manual page, but the 'man.viewer' configuration variable may be used to choose -another display program (see below). +other display programs (see below). -w|--web:: Display manual page for the command in the 'web' (HTML) @@ -58,6 +58,9 @@ linkgit:git-web--browse[1] for more information about this. CONFIGURATION VARIABLES ----------------------- +help.format +~~~~~~~~~~~ + If no command line option is passed, the 'help.format' configuration variable will be checked. The following values are supported for this variable; they make 'git-help' behave as their corresponding command @@ -67,11 +70,17 @@ line option: * "info" corresponds to '-i|--info', * "web" or "html" correspond to '-w|--web'. +help.browser, web.browser and browser..path +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + The 'help.browser', 'web.browser' and 'browser..path' will also be checked if the 'web' format is chosen (either by command line option or configuration variable). See '-w|--web' in the OPTIONS section above and linkgit:git-web--browse[1]. +man.viewer +~~~~~~~~~~ + The 'man.viewer' config variable will be checked if the 'man' format is chosen. Only the following values are currently supported: @@ -80,6 +89,24 @@ is chosen. Only the following values are currently supported: (this only works starting with emacsclient versions 22), * "konqueror": use a man KIO slave in konqueror. +Multiple values may be given to this configuration variable. Their +corresponding programs will be tried in the order listed in the +configuration file. + +For example the following configuration: + +[man] + viewer = konqueror + viewer = woman + +will try to use konqueror first. But this may fail (for example if +DISPLAY is not set) and in that case emacs' woman mode will be tried. + +If everythings fails the 'man' program will be tried anyway. + +Note about git config --global +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Note that all these configuration variables should probably be set using the '--global' flag, for example like this: -- 1.5.4.3.395.g492b.dirty ``` ## Xavier Maillard, 2008-03-14 01:00 Subject: Re: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <200803140100.m2E107Zl004673@localhost.localdomain> URL: https://gitlist.dev/e/200803140100.m2E107Zl004673%40localhost.localdomain In-Reply-To: <20080313064846.b6b54c11.chriscool@tuxfamily.org> ``` Also add titles to paragraphs under "CONFIGURATION VARIABLES". Signed-off-by: Christian Couder man.viewer:: - Specify the program that will be used to display help in the + Specify the programs that may be used to display help in the I would have prefered the following wording: "List of viewer candidates used to display help in" +If everythings fails the 'man' program will be tried anyway. ^^^^^^^^^^^ everything :) Regards Xavier -- http://www.gnu.org http://www.april.org http://www.lolica.org ``` ## Junio C Hamano, 2008-03-14 05:14 Subject: Re: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <7vhcf9ubtk.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7vhcf9ubtk.fsf%40gitster.siamese.dyndns.org In-Reply-To: <200803140615.25266.chriscool@tuxfamily.org> ``` Christian Couder writes: > Le vendredi 14 mars 2008, Xavier Maillard a écrit : >> man.viewer:: >> - Specify the program that will be used to display help in the >> + Specify the programs that may be used to display help in the >> >> I would have prefered the following wording: >> >> "List of viewer candidates used to display help in" >> >> +If everythings fails the 'man' program will be tried anyway. >> ^^^^^^^^^^^ >> everything :) > > Thank you Xavier for reviewing and testing my patches. > But as my patch has already been commited (in next), could you send a patch > on top of it ? No need, I've locally fixed it up. ``` ## Christian Couder, 2008-03-14 05:15 Subject: Re: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <200803140615.25266.chriscool@tuxfamily.org> URL: https://gitlist.dev/e/200803140615.25266.chriscool%40tuxfamily.org In-Reply-To: <200803140100.m2E107Zl004673@localhost.localdomain> ``` Le vendredi 14 mars 2008, Xavier Maillard a écrit : > man.viewer:: > - Specify the program that will be used to display help in the > + Specify the programs that may be used to display help in the > > I would have prefered the following wording: > > "List of viewer candidates used to display help in" > > +If everythings fails the 'man' program will be tried anyway. > ^^^^^^^^^^^ > everything :) Thank you Xavier for reviewing and testing my patches. But as my patch has already been commited (in next), could you send a patch on top of it ? Thanks in advance, Christian. ``` ## Xavier Maillard, 2008-03-15 13:00 Subject: Re: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <200803151300.m2FD0P50003211@localhost.localdomain> URL: https://gitlist.dev/e/200803151300.m2FD0P50003211%40localhost.localdomain In-Reply-To: <200803140615.25266.chriscool@tuxfamily.org> ``` Thank you Xavier for reviewing and testing my patches. That's my pleasure :) Thank you too for the features implemented. Xavier -- http://www.gnu.org http://www.april.org http://www.lolica.org ``` ## Xavier Maillard, 2008-03-15 13:00 Subject: Re: [PATCH] Documentation: help: explain 'man.viewer' multiple values Message-ID: <200803151300.m2FD0TOH003233@localhost.localdomain> URL: https://gitlist.dev/e/200803151300.m2FD0TOH003233%40localhost.localdomain In-Reply-To: <7vhcf9ubtk.fsf@gitster.siamese.dyndns.org> ``` > Thank you Xavier for reviewing and testing my patches. > But as my patch has already been commited (in next), could you send a patch > on top of it ? No need, I've locally fixed it up. Thank you Junio, you are very reactive ! Xavier -- http://www.gnu.org http://www.april.org http://www.lolica.org ```