git-web--browse.html

   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" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, 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
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#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 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.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 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.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 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#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
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.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
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-web--browse(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-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">
 323 <div class="para"><p><em>git web--browse</em> [OPTIONS] URL/FILE &#8230;</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>This script tries, as much as possible, to display the URLs and FILEs
 328 that are passed as arguments, as HTML pages in new tabs on an already
 329 opened web browser.</p></div>
 330 <div class="para"><p>The following browsers (or commands) are currently supported:</p></div>
 331 <div class="ilist"><ul>
 332 <li>
 333 <p>
 334 firefox (this is the default under X Window when not using KDE)
 335 </p>
 336 </li>
 337 <li>
 338 <p>
 339 iceweasel
 340 </p>
 341 </li>
 342 <li>
 343 <p>
 344 konqueror (this is the default under KDE, see <em>Note about konqueror</em> below)
 345 </p>
 346 </li>
 347 <li>
 348 <p>
 349 w3m (this is the default outside graphical environments)
 350 </p>
 351 </li>
 352 <li>
 353 <p>
 354 links
 355 </p>
 356 </li>
 357 <li>
 358 <p>
 359 lynx
 360 </p>
 361 </li>
 362 <li>
 363 <p>
 364 dillo
 365 </p>
 366 </li>
 367 <li>
 368 <p>
 369 open (this is the default under Mac OS X GUI)
 370 </p>
 371 </li>
 372 <li>
 373 <p>
 374 start (this is the default under MinGW)
 375 </p>
 376 </li>
 377 </ul></div>
 378 <div class="para"><p>Custom commands may also be specified.</p></div>
 379 </div>
 380 <h2 id="_options">OPTIONS</h2>
 381 <div class="sectionbody">
 382 <div class="vlist"><dl>
 383 <dt>
 384 -b BROWSER
 385 </dt>
 386 <dt>
 387 --browser=BROWSER
 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>
 396 -t BROWSER
 397 </dt>
 398 <dt>
 399 --tool=BROWSER
 400 </dt>
 401 <dd>
 402 <p>
 403         Same as above.
 404 </p>
 405 </dd>
 406 <dt>
 407 -c CONF.VAR
 408 </dt>
 409 <dt>
 410 --config=CONF.VAR
 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>
 418 </dl></div>
 419 </div>
 420 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 421 <div class="sectionbody">
 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
 424 with the -c (or --config) command line option, or the <em>web.browser</em>
 425 configuration 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
 428 setting the configuration variable <em>browser.&lt;tool&gt;.path</em>. For example,
 429 you can configure the absolute path to firefox by setting
 430 <em>browser.firefox.path</em>. Otherwise, <em>git-web--browse</em> assumes the tool
 431 is 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
 434 not among the supported ones, then the corresponding
 435 <em>browser.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
 436 variable exists then <em>git-web--browse</em> will treat the specified tool
 437 as a custom command and will use a shell eval to run the command with
 438 the URLs passed as arguments.</p></div>
 439 </div>
 440 <h2 id="_note_about_konqueror">Note about konqueror</h2>
 441 <div class="sectionbody">
 442 <div class="para"><p>When <em>konqueror</em> is specified by a command line option or a
 443 configuration variable, we launch <em>kfmclient</em> to try to open the HTML
 444 man 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
 446 set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
 447 launch <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
 449 the following:</p></div>
 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>
 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
 460 the <em>--global</em> flag, for example like this:</p></div>
 461 <div class="listingblock">
 462 <div class="content">
 463 <pre><tt>$ git config --global web.browser firefox</tt></pre>
 464 </div></div>
 465 <div class="para"><p>as they are probably more user specific than repository specific.
 466 See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
 467 </div>
 468 <h2 id="_author">Author</h2>
 469 <div class="sectionbody">
 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>
 472 </div>
 473 <h2 id="_documentation">Documentation</h2>
 474 <div class="sectionbody">
 475 <div class="para"><p>Documentation by Christian Couder &lt;chriscool@tuxfamily.org&gt; and the
 476 git-list &lt;git@vger.kernel.org&gt;.</p></div>
 477 </div>
 478 <h2 id="_git">GIT</h2>
 479 <div class="sectionbody">
 480 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 481 </div>
 482 <div id="footer">
 483 <div id="footer-text">
 484 Last updated 2009-12-03 09:12:52 UTC
 485 </div>
 486 </div>
 487 </body>
 488 </html>