]>
Commit | Line | Data |
---|---|---|
28394787 JH |
1 | git-web{litdd}browse(1) |
2 | ======================= | |
cb45f83c CC |
3 | |
4 | NAME | |
5 | ---- | |
6 | git-web--browse - git helper script to launch a web browser | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
28394787 | 10 | 'git web{litdd}browse' [OPTIONS] URL/FILE ... |
cb45f83c CC |
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 | |
81f42f11 GB |
23 | * seamonkey |
24 | * iceape | |
14ea67c0 GB |
25 | * chromium (also supported as chromium-browser) |
26 | * google-chrome (also supported as chrome) | |
ac3a4a26 | 27 | * konqueror (this is the default under KDE, see 'Note about konqueror' below) |
81f42f11 | 28 | * opera |
cb45f83c | 29 | * w3m (this is the default outside graphical environments) |
81f42f11 | 30 | * elinks |
cb45f83c CC |
31 | * links |
32 | * lynx | |
33 | * dillo | |
34 | * open (this is the default under Mac OS X GUI) | |
3b9b1163 | 35 | * start (this is the default under MinGW) |
cb45f83c | 36 | |
1658c614 CC |
37 | Custom commands may also be specified. |
38 | ||
cb45f83c CC |
39 | OPTIONS |
40 | ------- | |
62b4698e ŠN |
41 | -b <browser>:: |
42 | --browser=<browser>:: | |
43 | Use the specified browser. It must be in the list of supported | |
cb45f83c CC |
44 | browsers. |
45 | ||
62b4698e ŠN |
46 | -t <browser>:: |
47 | --tool=<browser>:: | |
cb45f83c CC |
48 | Same as above. |
49 | ||
62b4698e ŠN |
50 | -c <conf.var>:: |
51 | --config=<conf.var>:: | |
cb45f83c | 52 | CONF.VAR is looked up in the git config files. If it's set, |
62b4698e | 53 | then its value specifies the browser that should be used. |
cb45f83c CC |
54 | |
55 | CONFIGURATION VARIABLES | |
56 | ----------------------- | |
57 | ||
1658c614 CC |
58 | CONF.VAR (from -c option) and web.browser |
59 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
60 | ||
cb45f83c CC |
61 | The web browser can be specified using a configuration variable passed |
62 | with the -c (or --config) command line option, or the 'web.browser' | |
63 | configuration variable if the former is not used. | |
64 | ||
1658c614 CC |
65 | browser.<tool>.path |
66 | ~~~~~~~~~~~~~~~~~~~ | |
67 | ||
cb45f83c CC |
68 | You can explicitly provide a full path to your preferred browser by |
69 | setting the configuration variable 'browser.<tool>.path'. For example, | |
70 | you can configure the absolute path to firefox by setting | |
0b444cdb | 71 | 'browser.firefox.path'. Otherwise, 'git web--browse' assumes the tool |
cb45f83c CC |
72 | is available in PATH. |
73 | ||
1658c614 CC |
74 | browser.<tool>.cmd |
75 | ~~~~~~~~~~~~~~~~~~ | |
76 | ||
77 | When the browser, specified by options or configuration variables, is | |
78 | not among the supported ones, then the corresponding | |
79 | 'browser.<tool>.cmd' configuration variable will be looked up. If this | |
28394787 | 80 | variable exists then 'git web{litdd}browse' will treat the specified tool |
1658c614 CC |
81 | as a custom command and will use a shell eval to run the command with |
82 | the URLs passed as arguments. | |
83 | ||
ac3a4a26 CC |
84 | Note about konqueror |
85 | -------------------- | |
86 | ||
b66e00f1 | 87 | When 'konqueror' is specified by a command line option or a |
ac3a4a26 CC |
88 | configuration variable, we launch 'kfmclient' to try to open the HTML |
89 | man page on an already opened konqueror in a new tab if possible. | |
90 | ||
ed020917 | 91 | For consistency, we also try such a trick if 'browser.konqueror.path' is |
ac3a4a26 CC |
92 | set to something like 'A_PATH_TO/konqueror'. That means we will try to |
93 | launch 'A_PATH_TO/kfmclient' instead. | |
94 | ||
95 | If you really want to use 'konqueror', then you can use something like | |
96 | the following: | |
97 | ||
98 | ------------------------------------------------ | |
99 | [web] | |
100 | browser = konq | |
101 | ||
102 | [browser "konq"] | |
103 | cmd = A_PATH_TO/konqueror | |
104 | ------------------------------------------------ | |
105 | ||
b1889c36 | 106 | Note about git-config --global |
1658c614 CC |
107 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
108 | ||
cb45f83c CC |
109 | Note that these configuration variables should probably be set using |
110 | the '--global' flag, for example like this: | |
111 | ||
112 | ------------------------------------------------ | |
113 | $ git config --global web.browser firefox | |
114 | ------------------------------------------------ | |
115 | ||
116 | as they are probably more user specific than repository specific. | |
117 | See linkgit:git-config[1] for more information about this. | |
118 | ||
119 | Author | |
120 | ------ | |
121 | Written by Christian Couder <chriscool@tuxfamily.org> and the git-list | |
0b444cdb | 122 | <git@vger.kernel.org>, based on 'git mergetool' by Theodore Y. Ts'o. |
cb45f83c CC |
123 | |
124 | Documentation | |
125 | ------------- | |
126 | Documentation by Christian Couder <chriscool@tuxfamily.org> and the | |
127 | git-list <git@vger.kernel.org>. | |
128 | ||
129 | GIT | |
130 | --- | |
9e1f0a85 | 131 | Part of the linkgit:git[1] suite |