Merge commit 'git/master'
[git/git-bigfiles.git] / Documentation / git-web--browse.txt
blob278cf735279c13ab129ee28f1ef8e638ccf61dee
1 git-web--browse(1)
2 ==================
4 NAME
5 ----
6 git-web--browse - git helper script to launch a web browser
8 SYNOPSIS
9 --------
10 'git web--browse' [OPTIONS] URL/FILE ...
12 DESCRIPTION
13 -----------
15 This script tries, as much as possible, to display the URLs and FILEs
16 that are passed as arguments, as HTML pages in new tabs on an already
17 opened web browser.
19 The following browsers (or commands) are currently supported:
21 * firefox (this is the default under X Window when not using KDE)
22 * iceweasel
23 * konqueror (this is the default under KDE, see 'Note about konqueror' below)
24 * w3m (this is the default outside graphical environments)
25 * links
26 * lynx
27 * dillo
28 * open (this is the default under Mac OS X GUI)
29 * start (this is the default under MinGW)
31 Custom commands may also be specified.
33 OPTIONS
34 -------
35 -b BROWSER::
36 --browser=BROWSER::
37         Use the specified BROWSER. It must be in the list of supported
38         browsers.
40 -t BROWSER::
41 --tool=BROWSER::
42         Same as above.
44 -c CONF.VAR::
45 --config=CONF.VAR::
46         CONF.VAR is looked up in the git config files. If it's set,
47         then its value specify the browser that should be used.
49 CONFIGURATION VARIABLES
50 -----------------------
52 CONF.VAR (from -c option) and web.browser
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 The web browser can be specified using a configuration variable passed
56 with the -c (or --config) command line option, or the 'web.browser'
57 configuration variable if the former is not used.
59 browser.<tool>.path
60 ~~~~~~~~~~~~~~~~~~~
62 You can explicitly provide a full path to your preferred browser by
63 setting the configuration variable 'browser.<tool>.path'. For example,
64 you can configure the absolute path to firefox by setting
65 'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
66 is available in PATH.
68 browser.<tool>.cmd
69 ~~~~~~~~~~~~~~~~~~
71 When the browser, specified by options or configuration variables, is
72 not among the supported ones, then the corresponding
73 'browser.<tool>.cmd' configuration variable will be looked up. If this
74 variable exists then 'git-web--browse' will treat the specified tool
75 as a custom command and will use a shell eval to run the command with
76 the URLs passed as arguments.
78 Note about konqueror
79 --------------------
81 When 'konqueror' is specified by a command line option or a
82 configuration variable, we launch 'kfmclient' to try to open the HTML
83 man page on an already opened konqueror in a new tab if possible.
85 For consistency, we also try such a trick if 'browser.konqueror.path' is
86 set to something like 'A_PATH_TO/konqueror'. That means we will try to
87 launch 'A_PATH_TO/kfmclient' instead.
89 If you really want to use 'konqueror', then you can use something like
90 the following:
92 ------------------------------------------------
93         [web]
94                 browser = konq
96         [browser "konq"]
97                 cmd = A_PATH_TO/konqueror
98 ------------------------------------------------
100 Note about git-config --global
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103 Note that these configuration variables should probably be set using
104 the '--global' flag, for example like this:
106 ------------------------------------------------
107 $ git config --global web.browser firefox
108 ------------------------------------------------
110 as they are probably more user specific than repository specific.
111 See linkgit:git-config[1] for more information about this.
113 Author
114 ------
115 Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
116 <git@vger.kernel.org>, based on 'git-mergetool' by Theodore Y. Ts'o.
118 Documentation
119 -------------
120 Documentation by Christian Couder <chriscool@tuxfamily.org> and the
121 git-list <git@vger.kernel.org>.
125 Part of the linkgit:git[1] suite