git-instaweb.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-instaweb(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-instaweb(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-instaweb -
 317    Instantly browse your working repository in gitweb
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="verseblock">
 324 <div class="content"><em>git instaweb</em> [--local] [--httpd=&lt;httpd&gt;] [--port=&lt;port&gt;]
 325                [--browser=&lt;browser&gt;]
 326 <em>git instaweb</em> [--start] [--stop] [--restart]</div></div>
 327 </div>
 328 <h2 id="_description">DESCRIPTION</h2>
 329 <div class="sectionbody">
 330 <div class="para"><p>A simple script to set up <tt>gitweb</tt> and a web server for browsing the local
 331 repository.</p></div>
 332 </div>
 333 <h2 id="_options">OPTIONS</h2>
 334 <div class="sectionbody">
 335 <div class="vlist"><dl>
 336 <dt>
 337 -l
 338 </dt>
 339 <dt>
 340 --local
 341 </dt>
 342 <dd>
 343 <p>
 344         Only bind the web server to the local IP (127.0.0.1).
 345 </p>
 346 </dd>
 347 <dt>
 348 -d
 349 </dt>
 350 <dt>
 351 --httpd
 352 </dt>
 353 <dd>
 354 <p>
 355         The HTTP daemon command-line that will be executed.
 356         Command-line options may be specified here, and the
 357         configuration file will be added at the end of the command-line.
 358         Currently apache2, lighttpd, mongoose, plackup and webrick are supported.
 359         (Default: lighttpd)
 360 </p>
 361 </dd>
 362 <dt>
 363 -m
 364 </dt>
 365 <dt>
 366 --module-path
 367 </dt>
 368 <dd>
 369 <p>
 370         The module path (only needed if httpd is Apache).
 371         (Default: /usr/lib/apache2/modules)
 372 </p>
 373 </dd>
 374 <dt>
 375 -p
 376 </dt>
 377 <dt>
 378 --port
 379 </dt>
 380 <dd>
 381 <p>
 382         The port number to bind the httpd to.  (Default: 1234)
 383 </p>
 384 </dd>
 385 <dt>
 386 -b
 387 </dt>
 388 <dt>
 389 --browser
 390 </dt>
 391 <dd>
 392 <p>
 393         The web browser that should be used to view the gitweb
 394         page. This will be passed to the <em>git web&#45;&#45;browse</em> helper
 395         script along with the URL of the gitweb instance. See
 396         <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this. If
 397         the script fails, the URL will be printed to stdout.
 398 </p>
 399 </dd>
 400 <dt>
 401 start
 402 </dt>
 403 <dt>
 404 --start
 405 </dt>
 406 <dd>
 407 <p>
 408         Start the httpd instance and exit.  This does not generate
 409         any of the configuration files for spawning a new instance.
 410 </p>
 411 </dd>
 412 <dt>
 413 stop
 414 </dt>
 415 <dt>
 416 --stop
 417 </dt>
 418 <dd>
 419 <p>
 420         Stop the httpd instance and exit.  This does not generate
 421         any of the configuration files for spawning a new instance,
 422         nor does it close the browser.
 423 </p>
 424 </dd>
 425 <dt>
 426 restart
 427 </dt>
 428 <dt>
 429 --restart
 430 </dt>
 431 <dd>
 432 <p>
 433         Restart the httpd instance and exit.  This does not generate
 434         any of the configuration files for spawning a new instance.
 435 </p>
 436 </dd>
 437 </dl></div>
 438 </div>
 439 <h2 id="_configuration">CONFIGURATION</h2>
 440 <div class="sectionbody">
 441 <div class="para"><p>You may specify configuration in your .git/config</p></div>
 442 <div class="listingblock">
 443 <div class="content">
 444 <pre><tt>[instaweb]
 445         local = true
 446         httpd = apache2 -f
 447         port = 4321
 448         browser = konqueror
 449         modulepath = /usr/lib/apache2/modules
 450 </tt></pre>
 451 </div></div>
 452 <div class="para"><p>If the configuration variable <em>instaweb.browser</em> is not set,
 453 <em>web.browser</em> will be used instead if it is defined. See
 454 <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this.</p></div>
 455 </div>
 456 <h2 id="_author">Author</h2>
 457 <div class="sectionbody">
 458 <div class="para"><p>Written by Eric Wong &lt;normalperson@yhbt.net&gt;</p></div>
 459 </div>
 460 <h2 id="_documentation">Documentation</h2>
 461 <div class="sectionbody">
 462 <div class="para"><p>Documentation by Eric Wong &lt;normalperson@yhbt.net&gt;.</p></div>
 463 </div>
 464 <h2 id="_git">GIT</h2>
 465 <div class="sectionbody">
 466 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 467 </div>
 468 <div id="footer">
 469 <div id="footer-text">
 470 Last updated 2010-09-18 23:56:46 UTC
 471 </div>
 472 </div>
 473 </body>
 474 </html>