Skip to content

Commit 239b5ed

Browse files
jrngitster
authored andcommitted
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 <[email protected]> Signed-off-by: Jonathan Nieder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent f2dd8c3 commit 239b5ed

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/git.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -287,16 +287,16 @@ help ...`.
287287
the current setting and then exit.
288288

289289
--html-path::
290-
Print the path to wherever your git HTML documentation is installed
291-
and exit.
290+
Print the path, without trailing slash, where git's HTML
291+
documentation is installed and exit.
292292

293293
--man-path::
294-
Print the path to wherever your git man pages are installed
295-
and exit.
294+
Print the manpath (see `man(1)`) for the man pages for
295+
this version of git and exit.
296296

297297
--info-path::
298-
Print the path to wherever your git Info files are installed
299-
and exit.
298+
Print the path where the Info files documenting this
299+
version of git are installed and exit.
300300

301301
-p::
302302
--paginate::

0 commit comments

Comments
 (0)