Merge branch 'js/rebase-i-opt'

[git.git] / Documentation / git-web--browse.txt

diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index ddbae5b194790d7f76b53885e3d4ea642fda034a..278cf735279c13ab129ee28f1ef8e638ccf61dee 100644 (file)
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -7,7 +7,7 @@ git-web--browse - git helper script to launch a web browser
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-web--browse' [OPTIONS] URL/FILE ...
+'git web--browse' [OPTIONS] URL/FILE ...

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -20,25 +20,29 @@ The following browsers (or commands) are currently supported:
 
 * firefox (this is the default under X Window when not using KDE)
 * iceweasel
 
 * firefox (this is the default under X Window when not using KDE)
 * iceweasel

-* konqueror (this is the default under KDE)
+* konqueror (this is the default under KDE, see 'Note about konqueror' below)

 * w3m (this is the default outside graphical environments)
 * links
 * lynx
 * dillo
 * open (this is the default under Mac OS X GUI)
 * w3m (this is the default outside graphical environments)
 * links
 * lynx
 * dillo
 * open (this is the default under Mac OS X GUI)

+* start (this is the default under MinGW)

 
 Custom commands may also be specified.
 
 OPTIONS
 -------
 
 Custom commands may also be specified.
 
 OPTIONS
 -------

--b BROWSER|--browser=BROWSER::
+-b BROWSER::
+--browser=BROWSER::

        Use the specified BROWSER. It must be in the list of supported
        browsers.
 
        Use the specified BROWSER. It must be in the list of supported
        browsers.
 

--t BROWSER|--tool=BROWSER::
+-t BROWSER::
+--tool=BROWSER::

        Same as above.
 
        Same as above.
 

--c CONF.VAR|--config=CONF.VAR::
+-c CONF.VAR::
+--config=CONF.VAR::

        CONF.VAR is looked up in the git config files. If it's set,
        then its value specify the browser that should be used.
 
        CONF.VAR is looked up in the git config files. If it's set,
        then its value specify the browser that should be used.
 


@@ -67,11 +71,33 @@ browser.<tool>.cmd
 When the browser, specified by options or configuration variables, is
 not among the supported ones, then the corresponding
 'browser.<tool>.cmd' configuration variable will be looked up. If this
 When the browser, specified by options or configuration variables, is
 not among the supported ones, then the corresponding
 'browser.<tool>.cmd' configuration variable will be looked up. If this

-variable exists then "git web--browse" will treat the specified tool
+variable exists then 'git-web--browse' will treat the specified tool

 as a custom command and will use a shell eval to run the command with
 the URLs passed as arguments.
 
 as a custom command and will use a shell eval to run the command with
 the URLs passed as arguments.
 

-Note about git config --global
+Note about konqueror
+--------------------
+
+When 'konqueror' is specified by a command line option or a
+configuration variable, we launch 'kfmclient' to try to open the HTML
+man page on an already opened konqueror in a new tab if possible.
+
+For consistency, we also try such a trick if 'browser.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:
+
+------------------------------------------------
+       [web]
+               browser = konq
+
+       [browser "konq"]
+               cmd = A_PATH_TO/konqueror
+------------------------------------------------
+
+Note about git-config --global

 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Note that these configuration variables should probably be set using
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Note that these configuration variables should probably be set using


@@ -87,7 +113,7 @@ See linkgit:git-config[1] for more information about this.
 Author
 ------
 Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
 Author
 ------
 Written by Christian Couder <chriscool@tuxfamily.org> and the git-list

-<git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.
+<git@vger.kernel.org>, based on 'git-mergetool' by Theodore Y. Ts'o.

 
 Documentation
 -------------
 
 Documentation
 -------------


@@ -96,4 +122,4 @@ git-list <git@vger.kernel.org>.
 
 GIT
 ---
 
 GIT
 ---

-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite