[PATCH] Documentation: help: describe 'man.viewer' config variable.

[PATCH] Documentation: help: describe 'man.viewer' config variable.

[Christian Couder]

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 Documentation/config.txt   |    4 ++++
 Documentation/git-help.txt |   32 ++++++++++++++++++++++----------
 2 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 45bf8cd..3920285 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -743,6 +743,10 @@ log.showroot::
 	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
 	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
+	'man' format. See linkgit:git-help[1].
+
 merge.summary::
 	Whether to include summaries of merged commits in newly created
 	merge commit messages. False by default.
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 0926dc1..09227b3 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -33,17 +33,21 @@ OPTIONS
 	option supersedes any other option.
 
 -i|--info::
-	Use the 'info' program to display the manual page, instead of
-	the 'man' program that is used by default.
+	Display manual documentation about the command in Info
+	format. The 'info' program will be used for that purpose.
 
 -m|--man::
-	Use the 'man' program to display the manual page. This may be
-	used to override a value set in the 'help.format'
-	configuration variable.
+	Display manual documentation about the command in Man format.
+	This option may be used to override a value set in the
+	'help.format' configuration variable.
++
+By default the 'man' program will be used to display the man pages,
+but the 'man.viewer' configuration variable may be used to choose
+another display program (see below).
 
 -w|--web::
-	Use a web browser to display the HTML manual page, instead of
-	the 'man' program that is used by default.
+	Display manual documentation about the command in HTLM format.
+	A web browser will be used for that purpose.
 +
 The web browser can be specified using the configuration variable
 'help.browser', or 'web.browser' if the former is not set. If none of
@@ -61,15 +65,23 @@ line option:
 
 * "man" corresponds to '-m|--man',
 * "info" corresponds to '-i|--info',
-* "web" or "html" correspond to '-w|--web',
+* "web" or "html" correspond to '-w|--web'.
 
 The 'help.browser', 'web.browser' and 'browser.<tool>.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].
 
-Note that these configuration variables should probably be set using
-the '--global' flag, for example like this:
+The 'man.viewer' config variable will be checked if the 'man' format
+is chosen. Only the following values are currently supported:
+
+* "man": use the 'man' program as usual,
+* "woman": use 'emacsclient' to launch the "woman" mode in emacs
+(this only works starting with emacsclient versions 22),
+* "konqueror": use a man KIO slave in konqueror.
+
+Note that all these configuration variables should probably be set
+using the '--global' flag, for example like this:
 
 ------------------------------------------------
 $ git config --global help.format web
-- 
1.5.4.2.233.gf355.dirty

Re: [PATCH] Documentation: help: describe 'man.viewer' config variable.

[しらいしななこ]

Quoting Christian Couder <chriscool@tuxfamily.org>:

> +man.viewer::
> +	Specify the program that will be used to display help in the
> +	'man' format. See linkgit:git-help[1].
> +
>  -i|--info::
> -	Use the 'info' program to display the manual page, instead of
> -	the 'man' program that is used by default.
> +	Display manual documentation about the command in Info
> +	format. The 'info' program will be used for that purpose.

I am not a native speaker of the English language, but "manual documentation about" feels duplicatedly redundant, at least to me.  I think it is more common to say "the manual page for", or "the man page for".

>  -m|--man::
> -	Use the 'man' program to display the manual page. This may be
> -	used to override a value set in the 'help.format'
> -	configuration variable.
> +	Display manual documentation about the command in Man format.

An earlier description for man.viewer says "in the 'man' format".

> +	This option may be used to override a value set in the
> +	'help.format' configuration variable.
> ++
> +By default the 'man' program will be used to display the man pages,

And this part says "the man pages".

>  -w|--web::
> -	Use a web browser to display the HTML manual page, instead of
> -	the 'man' program that is used by default.
> +	Display manual documentation about the command in HTLM format.
> +	A web browser will be used for that purpose.

Is this a mistyped "HTML format"?

-- 
Nanako Shiraishi
http://ivory.ap.teacup.com/nanako3/

----------------------------------------------------------------------
Get a free email address with REAL anti-spam protection.
http://www.bluebottle.com/tag/1

Re: [PATCH] Documentation: help: describe 'man.viewer' config variable.

[Christian Couder]

Le mercredi 27 février 2008, しらいしななこ a écrit :
> Quoting Christian Couder <chriscool@tuxfamily.org>:
> > +man.viewer::
> > +	Specify the program that will be used to display help in the
> > +	'man' format. See linkgit:git-help[1].
> > +
> >  -i|--info::
> > -	Use the 'info' program to display the manual page, instead of
> > -	the 'man' program that is used by default.
> > +	Display manual documentation about the command in Info
> > +	format. The 'info' program will be used for that purpose.
>
> I am not a native speaker of the English language, but "manual
> documentation about" feels duplicatedly redundant, at least to me.  I
> think it is more common to say "the manual page for", or "the man page
> for".

Yes, I will send an updated patch saying "manual page for" soon. 

> >  -m|--man::
> > -	Use the 'man' program to display the manual page. This may be
> > -	used to override a value set in the 'help.format'
> > -	configuration variable.
> > +	Display manual documentation about the command in Man format.
>
> An earlier description for man.viewer says "in the 'man' format".

Ok, it will say "'man' format" everywhere.

> > +	This option may be used to override a value set in the
> > +	'help.format' configuration variable.
> > ++
> > +By default the 'man' program will be used to display the man pages,
>
> And this part says "the man pages".
>
> >  -w|--web::
> > -	Use a web browser to display the HTML manual page, instead of
> > -	the 'man' program that is used by default.
> > +	Display manual documentation about the command in HTLM format.
> > +	A web browser will be used for that purpose.
>
> Is this a mistyped "HTML format"?

Right, it will be fixed.

Thanks,
Christian.