threads / patch / 12739

patch, 2 partsdocumentation: help: add "man.<tool>.path" config variable

Subject: [PATCH 2/2] documentation: help: add "man.<tool>.path" config variable

## tl;dr

One message between Mar 18, 2008 and Mar 18, 2008. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Christian Couder· Mar 18, 2008, 05:22 UTC · lore

This patch documents the "man.<tool>.path" configuration variable.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 Documentation/config.txt   |    4 ++++
 Documentation/git-help.txt |    9 +++++++++
 2 files changed, 13 insertions(+), 0 deletions(-)
Show changes to 2 files +13 −0

Documentation/config.txt, Documentation/git-help.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index f156b1d..32689b8 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -761,6 +761,10 @@ man.viewer::
 	Specify the programs that may be used to display help in the
 	'man' format. See linkgit:git-help[1].
 
+man.<tool>.path::
+	Override the path for the given tool that may 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 be2ae53..4c6cb21 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -104,6 +104,15 @@ DISPLAY is not set) and in that case emacs' woman mode will be tried.
 
 If everything fails the 'man' program will be tried anyway.
 
+man.<tool>.path
+~~~~~~~~~~~~~~~
+
+You can explicitly provide a full path to your preferred man viewer by
+setting the configuration variable 'man.<tool>.path'. For example, you
+can configure the absolute path to konqueror by setting
+'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
+available in PATH.
+
 Note about git config --global
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
1.5.4.4.685.g3070a.dirty

← back to recent threads