Skip to content

Commit

Permalink
Documentation: clarify meaning of --html-path, --man-path, and --info…
Browse files Browse the repository at this point in the history
…-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>
  • Loading branch information
Jonathan Nieder authored and Junio C Hamano committed May 2, 2011
1 parent f2dd8c3 commit 239b5ed
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down

0 comments on commit 239b5ed

Please sign in to comment.