Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.kernel.org/pub/scm/git/git.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2011-05-02 10:07:45 +0400
committerJunio C Hamano <gitster@pobox.com>2011-05-02 19:49:32 +0400
commit239b5ed9c9b7b7f219b05c8d71e29db7b970eb48 (patch)
treec21f6403b40366fd36205977ef2cb3a57088e727 /Documentation
parentf2dd8c3799ddbd7df63a89a9043916f8545a70a3 (diff)
Documentation: clarify meaning of --html-path, --man-path, and --info-path
These options tell UI programs where git put its documentation, so "Help" actions can show the documentation for *this* version of git without regard to how MANPATH and INFOPATH are set up. Details: . Each variable tells where documentation is expected to be. They do not indicate whether documentation was actually installed. . The output of "git --html-path" is an absolute path and can be used in "file://$(git --html-path)/git-add.html" to name the HTML file documenting a particular command. . --man-path names a manual page hierarchy (e.g., /home/user/share/man). Its output can be passed to "man -M" or put at the beginning of $MANPATH. . --info-path names a directory with info files (e.g., /home/user/share/info). Its output is suitable as an argument to "info -d" or for inclusion in $INFOPATH. Helped-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git.txt12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 7e9b521cd9..5295315fe7 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -287,16 +287,16 @@ help ...`.
the current setting and then exit.
--html-path::
- Print the path to wherever your git HTML documentation is installed
- and exit.
+ Print the path, without trailing slash, where git's HTML
+ documentation is installed and exit.
--man-path::
- Print the path to wherever your git man pages are installed
- and exit.
+ Print the manpath (see `man(1)`) for the man pages for
+ this version of git and exit.
--info-path::
- Print the path to wherever your git Info files are installed
- and exit.
+ Print the path where the Info files documenting this
+ version of git are installed and exit.
-p::
--paginate::