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.4.5" />
   7 <title>git-web&#45;&#45;browse(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-web&#45;&#45;browse(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-web--browse -
 411    git helper script to launch a web browser
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git web&#45;&#45;browse</em> [OPTIONS] URL/FILE &#8230;</div>
 419 <div class="verseblock-attribution">
 420 </div></div>
 421 </div>
 422 <h2 id="_description">DESCRIPTION</h2>
 423 <div class="sectionbody">
 424 <div class="paragraph"><p>This script tries, as much as possible, to display the URLs and FILEs
 425 that are passed as arguments, as HTML pages in new tabs on an already
 426 opened web browser.</p></div>
 427 <div class="paragraph"><p>The following browsers (or commands) are currently supported:</p></div>
 428 <div class="ulist"><ul>
 429 <li>
 430 <p>
 431 firefox (this is the default under X Window when not using KDE)
 432 </p>
 433 </li>
 434 <li>
 435 <p>
 436 iceweasel
 437 </p>
 438 </li>
 439 <li>
 440 <p>
 441 seamonkey
 442 </p>
 443 </li>
 444 <li>
 445 <p>
 446 iceape
 447 </p>
 448 </li>
 449 <li>
 450 <p>
 451 chromium (also supported as chromium-browser)
 452 </p>
 453 </li>
 454 <li>
 455 <p>
 456 google-chrome (also supported as chrome)
 457 </p>
 458 </li>
 459 <li>
 460 <p>
 461 konqueror (this is the default under KDE, see <em>Note about konqueror</em> below)
 462 </p>
 463 </li>
 464 <li>
 465 <p>
 466 opera
 467 </p>
 468 </li>
 469 <li>
 470 <p>
 471 w3m (this is the default outside graphical environments)
 472 </p>
 473 </li>
 474 <li>
 475 <p>
 476 elinks
 477 </p>
 478 </li>
 479 <li>
 480 <p>
 481 links
 482 </p>
 483 </li>
 484 <li>
 485 <p>
 486 lynx
 487 </p>
 488 </li>
 489 <li>
 490 <p>
 491 dillo
 492 </p>
 493 </li>
 494 <li>
 495 <p>
 496 open (this is the default under Mac OS X GUI)
 497 </p>
 498 </li>
 499 <li>
 500 <p>
 501 start (this is the default under MinGW)
 502 </p>
 503 </li>
 504 </ul></div>
 505 <div class="paragraph"><p>Custom commands may also be specified.</p></div>
 506 </div>
 507 <h2 id="_options">OPTIONS</h2>
 508 <div class="sectionbody">
 509 <div class="dlist"><dl>
 510 <dt class="hdlist1">
 511 -b &lt;browser&gt;
 512 </dt>
 513 <dt class="hdlist1">
 514 --browser=&lt;browser&gt;
 515 </dt>
 516 <dd>
 517 <p>
 518         Use the specified browser. It must be in the list of supported
 519         browsers.
 520 </p>
 521 </dd>
 522 <dt class="hdlist1">
 523 -t &lt;browser&gt;
 524 </dt>
 525 <dt class="hdlist1">
 526 --tool=&lt;browser&gt;
 527 </dt>
 528 <dd>
 529 <p>
 530         Same as above.
 531 </p>
 532 </dd>
 533 <dt class="hdlist1">
 534 -c &lt;conf.var&gt;
 535 </dt>
 536 <dt class="hdlist1">
 537 --config=&lt;conf.var&gt;
 538 </dt>
 539 <dd>
 540 <p>
 541         CONF.VAR is looked up in the git config files. If it&#8217;s set,
 542         then its value specifies the browser that should be used.
 543 </p>
 544 </dd>
 545 </dl></div>
 546 </div>
 547 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 548 <div class="sectionbody">
 549 <h3 id="_conf_var_from_c_option_and_web_browser">CONF.VAR (from -c option) and web.browser</h3><div style="clear:left"></div>
 550 <div class="paragraph"><p>The web browser can be specified using a configuration variable passed
 551 with the -c (or --config) command line option, or the <em>web.browser</em>
 552 configuration variable if the former is not used.</p></div>
 553 <h3 id="_browser_lt_tool_gt_path">browser.&lt;tool&gt;.path</h3><div style="clear:left"></div>
 554 <div class="paragraph"><p>You can explicitly provide a full path to your preferred browser by
 555 setting the configuration variable <em>browser.&lt;tool&gt;.path</em>. For example,
 556 you can configure the absolute path to firefox by setting
 557 <em>browser.firefox.path</em>. Otherwise, <em>git web&#45;&#45;browse</em> assumes the tool
 558 is available in PATH.</p></div>
 559 <h3 id="_browser_lt_tool_gt_cmd">browser.&lt;tool&gt;.cmd</h3><div style="clear:left"></div>
 560 <div class="paragraph"><p>When the browser, specified by options or configuration variables, is
 561 not among the supported ones, then the corresponding
 562 <em>browser.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
 563 variable exists then <em>git web&#45;&#45;browse</em> will treat the specified tool
 564 as a custom command and will use a shell eval to run the command with
 565 the URLs passed as arguments.</p></div>
 566 </div>
 567 <h2 id="_note_about_konqueror">Note about konqueror</h2>
 568 <div class="sectionbody">
 569 <div class="paragraph"><p>When <em>konqueror</em> is specified by a command line option or a
 570 configuration variable, we launch <em>kfmclient</em> to try to open the HTML
 571 man page on an already opened konqueror in a new tab if possible.</p></div>
 572 <div class="paragraph"><p>For consistency, we also try such a trick if <em>browser.konqueror.path</em> is
 573 set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
 574 launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
 575 <div class="paragraph"><p>If you really want to use <em>konqueror</em>, then you can use something like
 576 the following:</p></div>
 577 <div class="listingblock">
 578 <div class="content">
 579 <pre><tt>        [web]
 580                 browser = konq
 581
 582         [browser "konq"]
 583                 cmd = A_PATH_TO/konqueror</tt></pre>
 584 </div></div>
 585 <h3 id="_note_about_git_config_global">Note about git-config --global</h3><div style="clear:left"></div>
 586 <div class="paragraph"><p>Note that these configuration variables should probably be set using
 587 the <em>--global</em> flag, for example like this:</p></div>
 588 <div class="listingblock">
 589 <div class="content">
 590 <pre><tt>$ git config --global web.browser firefox</tt></pre>
 591 </div></div>
 592 <div class="paragraph"><p>as they are probably more user specific than repository specific.
 593 See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
 594 </div>
 595 <h2 id="_git">GIT</h2>
 596 <div class="sectionbody">
 597 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 598 </div>
 599 <div id="footer">
 600 <div id="footer-text">
 601 Last updated 2011-07-23 00:49:30 UTC
 602 </div>
 603 </div>
 604 </body>
 605 </html>