Google Git
Sign in
chromium / external / gitster / git-htmldocs / 19107ef38294e3b64a70b32302416dd52c0e779a / . / git-web--browse.html
blob: 3304b39fad704f32dc9bf1c9a61d4d8aac3781ed [file] [log] [blame]
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]306</style>
307<title>git-web--browse(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-web--browse(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-web--browse -
317 git helper script to launch a web browser
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]323<div class="para"><p><em>git web--browse</em> [OPTIONS] URL/FILE &#8230;</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]326<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]327<div class="para"><p>This script tries, as much as possible, to display the URLs and FILEs
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]328that are passed as arguments, as HTML pages in new tabs on an already
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]329opened web browser.</p></div>
330<div class="para"><p>The following browsers (or commands) are currently supported:</p></div>
331<div class="ilist"><ul>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]332<li>
333<p>
334firefox (this is the default under X Window when not using KDE)
335</p>
336</li>
337<li>
338<p>
339iceweasel
340</p>
341</li>
342<li>
343<p>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]344konqueror (this is the default under KDE, see <em>Note about konqueror</em> below)
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]345</p>
346</li>
347<li>
348<p>
349w3m (this is the default outside graphical environments)
350</p>
351</li>
352<li>
353<p>
354links
355</p>
356</li>
357<li>
358<p>
359lynx
360</p>
361</li>
362<li>
363<p>
364dillo
365</p>
366</li>
367<li>
368<p>
369open (this is the default under Mac OS X GUI)
370</p>
371</li>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]372<li>
373<p>
374start (this is the default under MinGW)
375</p>
376</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]377</ul></div>
378<div class="para"><p>Custom commands may also be specified.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]379</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]380<h2 id="_options">OPTIONS</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]381<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]382<div class="vlist"><dl>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]383<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]384-b BROWSER
385</dt>
386<dt>
387--browser=BROWSER
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]388</dt>
389<dd>
390<p>
391 Use the specified BROWSER. It must be in the list of supported
392 browsers.
393</p>
394</dd>
395<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]396-t BROWSER
397</dt>
398<dt>
399--tool=BROWSER
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]400</dt>
401<dd>
402<p>
403 Same as above.
404</p>
405</dd>
406<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]407-c CONF.VAR
408</dt>
409<dt>
410--config=CONF.VAR
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]411</dt>
412<dd>
413<p>
414 CONF.VAR is looked up in the git config files. If it's set,
415 then its value specify the browser that should be used.
416</p>
417</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]418</dl></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]419</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]420<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]421<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]422<h3 id="_conf_var_from_c_option_and_web_browser">CONF.VAR (from -c option) and web.browser</h3><div style="clear:left"></div>
423<div class="para"><p>The web browser can be specified using a configuration variable passed
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]424with the -c (or --config) command line option, or the <em>web.browser</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]425configuration variable if the former is not used.</p></div>
426<h3 id="_browser_lt_tool_gt_path">browser.&lt;tool&gt;.path</h3><div style="clear:left"></div>
427<div class="para"><p>You can explicitly provide a full path to your preferred browser by
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]428setting the configuration variable <em>browser.&lt;tool&gt;.path</em>. For example,
429you can configure the absolute path to firefox by setting
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]430<em>browser.firefox.path</em>. Otherwise, <em>git-web--browse</em> assumes the tool
431is available in PATH.</p></div>
432<h3 id="_browser_lt_tool_gt_cmd">browser.&lt;tool&gt;.cmd</h3><div style="clear:left"></div>
433<div class="para"><p>When the browser, specified by options or configuration variables, is
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]434not among the supported ones, then the corresponding
435<em>browser.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]436variable exists then <em>git-web--browse</em> will treat the specified tool
Junio C Hamano8760ea62008-03-14 08:58:45[diff] [blame]437as a custom command and will use a shell eval to run the command with
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]438the URLs passed as arguments.</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]439</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]440<h2 id="_note_about_konqueror">Note about konqueror</h2>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]441<div class="sectionbody">
Junio C Hamano675570c2008-09-13 06:07:28[diff] [blame]442<div class="para"><p>When <em>konqueror</em> is specified by a command line option or a
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]443configuration variable, we launch <em>kfmclient</em> to try to open the HTML
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]444man page on an already opened konqueror in a new tab if possible.</p></div>
445<div class="para"><p>For consistency, we also try such a trick if <em>browser.konqueror.path</em> is
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]446set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]447launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
448<div class="para"><p>If you really want to use <em>konqueror</em>, then you can use something like
449the following:</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]450<div class="listingblock">
451<div class="content">
452<pre><tt> [web]
453 browser = konq
454
455 [browser "konq"]
456 cmd = A_PATH_TO/konqueror</tt></pre>
457</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]458<h3 id="_note_about_git_config_global">Note about git-config --global</h3><div style="clear:left"></div>
459<div class="para"><p>Note that these configuration variables should probably be set using
460the <em>--global</em> flag, for example like this:</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]461<div class="listingblock">
462<div class="content">
463<pre><tt>$ git config --global web.browser firefox</tt></pre>
464</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]465<div class="para"><p>as they are probably more user specific than repository specific.
466See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]467</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]468<h2 id="_author">Author</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]469<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]470<div class="para"><p>Written by Christian Couder &lt;chriscool@tuxfamily.org&gt; and the git-list
471&lt;git@vger.kernel.org&gt;, based on <em>git-mergetool</em> by Theodore Y. Ts'o.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]472</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]473<h2 id="_documentation">Documentation</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]474<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]475<div class="para"><p>Documentation by Christian Couder &lt;chriscool@tuxfamily.org&gt; and the
476git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]477</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]478<h2 id="_git">GIT</h2>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]479<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]480<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]481</div>
482<div id="footer">
483<div id="footer-text">
Junio C Hamanofa2ad882009-12-03 09:15:44[diff] [blame]484Last updated 2009-12-03 09:12:52 UTC
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]485</div>
486</div>
487</body>
488</html>