git-help(1) (original) (raw)

help.format

If no command-line option is passed, the help.format configuration variable will be checked. The following values are supported for this variable; they make git help behave as their corresponding command- line option:

• "man" corresponds to -m|--man,
• "info" corresponds to -i|--info,
• "web" or "html" correspond to -w|--web.

help.browser, web.browser, and browser..path

The help.browser, web.browser and browser..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 git-web--browse(1).

man.viewer

The man.viewer configuration variable will be checked if the _man_format is chosen. 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 kfmclient to open the man page in a new konqueror tab (see Note about konqueror below).

Values for other tools can be used if there is a correspondingman..cmd configuration entry (see below).

Multiple values may be given to the man.viewer configuration variable. Their corresponding programs will be tried in the order listed in the configuration file.

For example, this configuration:

    [man]
            viewer = konqueror
            viewer = woman

will try to use konqueror first. But this may fail (for example, if DISPLAY is not set) and in that case emacs' woman mode will be tried.

If everything fails, or if no viewer is configured, the viewer specified in the GIT_MAN_VIEWER environment variable will be tried. If that fails too, the man program will be tried anyway.

man..path

You can explicitly provide a full path to your preferred man viewer by setting the configuration variable man..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.

man..cmd

When the man viewer, specified by the man.viewer configuration variables, is not among the supported ones, then the correspondingman..cmd configuration variable will be looked up. If this variable exists then the specified tool will be treated as a custom command and a shell eval will be used to run the command with the man page passed as arguments.

Note about konqueror

When konqueror is specified in the man.viewer configuration variable, we launch kfmclient to try to open the man page on an already opened konqueror in a new tab if possible.

For consistency, we also try such a trick if man.konqueror.path is set to something like A_PATH_TO/konqueror. That means we will try to launch A_PATH_TO/kfmclient instead.

If you really want to use konqueror, then you can use something like the following:

    [man]
            viewer = konq

    [man "konq"]
            cmd = A_PATH_TO/konqueror

Note about git config --global

Note that all these configuration variables should probably be set using the --global flag, for example like this:

$ git config --global help.format web $ git config --global web.browser firefox

as they are probably more user specific than repository specific. See git-config(1) for more information about this.