Merge branch 'cc/help'
[git/git.git] / Documentation / git-web--browse.txt
1 git-web--browse(1)
2 ==================
3
4 NAME
5 ----
6 git-web--browse - git helper script to launch a web browser
7
8 SYNOPSIS
9 --------
10 'git-web--browse' [OPTIONS] URL/FILE ...
11
12 DESCRIPTION
13 -----------
14
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.
18
19 The following browsers (or commands) are currently supported:
20
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
30 Custom commands may also be specified.
31
32 OPTIONS
33 -------
34 -b BROWSER|--browser=BROWSER::
35 Use the specified BROWSER. It must be in the list of supported
36 browsers.
37
38 -t BROWSER|--tool=BROWSER::
39 Same as above.
40
41 -c CONF.VAR|--config=CONF.VAR::
42 CONF.VAR is looked up in the git config files. If it's set,
43 then its value specify the browser that should be used.
44
45 CONFIGURATION VARIABLES
46 -----------------------
47
48 CONF.VAR (from -c option) and web.browser
49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50
51 The web browser can be specified using a configuration variable passed
52 with the -c (or --config) command line option, or the 'web.browser'
53 configuration variable if the former is not used.
54
55 browser.<tool>.path
56 ~~~~~~~~~~~~~~~~~~~
57
58 You can explicitly provide a full path to your preferred browser by
59 setting the configuration variable 'browser.<tool>.path'. For example,
60 you can configure the absolute path to firefox by setting
61 'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
62 is available in PATH.
63
64 browser.<tool>.cmd
65 ~~~~~~~~~~~~~~~~~~
66
67 When the browser, specified by options or configuration variables, is
68 not among the supported ones, then the corresponding
69 'browser.<tool>.cmd' configuration variable will be looked up. If this
70 variable exists then "git web--browse" will treat the specified tool
71 as a custom command and will use a shell eval to run the command with
72 the URLs passed as arguments.
73
74 Note about konqueror
75 --------------------
76
77 When 'konqueror' is specified by the a command line option or a
78 configuration variable, we launch 'kfmclient' to try to open the HTML
79 man page on an already opened konqueror in a new tab if possible.
80
81 For consistency, we also try such a trick if 'brower.konqueror.path' is
82 set to something like 'A_PATH_TO/konqueror'. That means we will try to
83 launch 'A_PATH_TO/kfmclient' instead.
84
85 If you really want to use 'konqueror', then you can use something like
86 the following:
87
88 ------------------------------------------------
89 [web]
90 browser = konq
91
92 [browser "konq"]
93 cmd = A_PATH_TO/konqueror
94 ------------------------------------------------
95
96 Note about git config --global
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
99 Note that these configuration variables should probably be set using
100 the '--global' flag, for example like this:
101
102 ------------------------------------------------
103 $ git config --global web.browser firefox
104 ------------------------------------------------
105
106 as they are probably more user specific than repository specific.
107 See linkgit:git-config[1] for more information about this.
108
109 Author
110 ------
111 Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
112 <git@vger.kernel.org>, based on git-mergetool by Theodore Y. Ts'o.
113
114 Documentation
115 -------------
116 Documentation by Christian Couder <chriscool@tuxfamily.org> and the
117 git-list <git@vger.kernel.org>.
118
119 GIT
120 ---
121 Part of the linkgit:git[7] suite