Autogenerated HTML docs for v1.4.1-gc31c
authorJunio C Hamano <junio@hera.kernel.org>
Fri, 7 Jul 2006 02:03:59 +0000 (02:03 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Fri, 7 Jul 2006 02:03:59 +0000 (02:03 +0000)
config.txt
git-instaweb.html [new file with mode: 0644]
git-instaweb.txt [new file with mode: 0644]
git-repo-config.html

index 16bdd55233f2f1a11a80f60dfa85b84145c836f6..f075f19815f4505068a1ca1aed7a0e5b46025435 100644 (file)
@@ -91,7 +91,7 @@ core.warnAmbiguousRefs::
        If true, git will warn you if the ref name you passed it is ambiguous
        and might match multiple refs in the .git/refs/ tree. True by default.
 
-core.compression:
+core.compression::
        An integer -1..9, indicating the compression level for objects that
        are not in a pack file. -1 is the zlib and git default. 0 means no
        compression, and 1..9 are various speed/size tradeoffs, 9 being
diff --git a/git-instaweb.html b/git-instaweb.html
new file mode 100644 (file)
index 0000000..a68cdb6
--- /dev/null
@@ -0,0 +1,395 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 7.0.2" />\r
+<style type="text/css">\r
+/* Debug borders */\r
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
+/*\r
+  border: 1px solid red;\r
+*/\r
+}\r
+\r
+body {\r
+  margin: 1em 5% 1em 5%;\r
+}\r
+\r
+a { color: blue; }\r
+a:visited { color: fuchsia; }\r
+\r
+em {\r
+  font-style: italic;\r
+}\r
+\r
+strong {\r
+  font-weight: bold;\r
+}\r
+\r
+tt {\r
+  color: navy;\r
+}\r
+\r
+h1, h2, h3, h4, h5, h6 {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  margin-top: 1.2em;\r
+  margin-bottom: 0.5em;\r
+  line-height: 1.3;\r
+}\r
+\r
+h1 {\r
+  border-bottom: 2px solid silver;\r
+}\r
+h2 {\r
+  border-bottom: 2px solid silver;\r
+  padding-top: 0.5em;\r
+}\r
+\r
+div.sectionbody {\r
+  font-family: serif;\r
+  margin-left: 0;\r
+}\r
+\r
+hr {\r
+  border: 1px solid silver;\r
+}\r
+\r
+p {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+pre {\r
+  padding: 0;\r
+  margin: 0;\r
+}\r
+\r
+span#author {\r
+  color: #527bbd;\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  font-size: 1.2em;\r
+}\r
+span#email {\r
+}\r
+span#revision {\r
+  font-family: sans-serif;\r
+}\r
+\r
+div#footer {\r
+  font-family: sans-serif;\r
+  font-size: small;\r
+  border-top: 2px solid silver;\r
+  padding-top: 0.5em;\r
+  margin-top: 4.0em;\r
+}\r
+div#footer-text {\r
+  float: left;\r
+  padding-bottom: 0.5em;\r
+}\r
+div#footer-badges {\r
+  float: right;\r
+  padding-bottom: 0.5em;\r
+}\r
+\r
+div#preamble,\r
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
+div.admonitionblock {\r
+  margin-right: 10%;\r
+  margin-top: 1.5em;\r
+  margin-bottom: 1.5em;\r
+}\r
+div.admonitionblock {\r
+  margin-top: 2.5em;\r
+  margin-bottom: 2.5em;\r
+}\r
+\r
+div.content { /* Block element content. */\r
+  padding: 0;\r
+}\r
+\r
+/* Block element titles. */\r
+div.title, caption.title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  text-align: left;\r
+  margin-top: 1.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+div.title + * {\r
+  margin-top: 0;\r
+}\r
+\r
+td div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content div.title:first-child {\r
+  margin-top: 0.0em;\r
+}\r
+div.content + div.title {\r
+  margin-top: 0.0em;\r
+}\r
+\r
+div.sidebarblock > div.content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.listingblock > div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock > div.content {\r
+  padding-left: 2.0em;\r
+}\r
+div.quoteblock .attribution {\r
+  text-align: right;\r
+}\r
+\r
+div.admonitionblock .icon {\r
+  vertical-align: top;\r
+  font-size: 1.1em;\r
+  font-weight: bold;\r
+  text-decoration: underline;\r
+  color: #527bbd;\r
+  padding-right: 0.5em;\r
+}\r
+div.admonitionblock td.content {\r
+  padding-left: 0.5em;\r
+  border-left: 2px solid silver;\r
+}\r
+\r
+div.exampleblock > div.content {\r
+  border-left: 2px solid silver;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.verseblock div.content {\r
+  white-space: pre;\r
+}\r
+\r
+div.imageblock div.content { padding-left: 0; }\r
+div.imageblock img { border: 1px solid silver; }\r
+span.image img { border-style: none; }\r
+\r
+dl {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+dt {\r
+  margin-top: 0.5em;\r
+  margin-bottom: 0;\r
+  font-style: italic;\r
+}\r
+dd > *:first-child {\r
+  margin-top: 0;\r
+}\r
+\r
+ul, ol {\r
+    list-style-position: outside;\r
+}\r
+ol.olist2 {\r
+  list-style-type: lower-alpha;\r
+}\r
+\r
+div.tableblock > table {\r
+  border-color: #527bbd;\r
+  border-width: 3px;\r
+}\r
+thead {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+}\r
+tfoot {\r
+  font-weight: bold;\r
+}\r
+\r
+div.hlist {\r
+  margin-top: 0.8em;\r
+  margin-bottom: 0.8em;\r
+}\r
+td.hlist1 {\r
+  vertical-align: top;\r
+  font-style: italic;\r
+  padding-right: 0.8em;\r
+}\r
+td.hlist2 {\r
+  vertical-align: top;\r
+}\r
+\r
+@media print {\r
+  div#footer-badges { display: none; }\r
+}\r
+include::./stylesheets/xhtml11-manpage.css[]\r
+/* Workarounds for IE6's broken and incomplete CSS2. */\r
+\r
+div.sidebar-content {\r
+  background: #ffffee;\r
+  border: 1px solid silver;\r
+  padding: 0.5em;\r
+}\r
+div.sidebar-title, div.image-title {\r
+  font-family: sans-serif;\r
+  font-weight: bold;\r
+  margin-top: 0.0em;\r
+  margin-bottom: 0.5em;\r
+}\r
+\r
+div.listingblock div.content {\r
+  border: 1px solid silver;\r
+  background: #f4f4f4;\r
+  padding: 0.5em;\r
+}\r
+\r
+div.quoteblock-content {\r
+  padding-left: 2.0em;\r
+}\r
+\r
+div.exampleblock-content {\r
+  border-left: 2px solid silver;\r
+  padding-left: 0.5em;\r
+}\r
+</style>\r
+<title>git-instaweb(1)</title>\r
+</head>\r
+<body>\r
+<div id="header">\r
+<h1>\r
+git-instaweb(1) Manual Page\r
+</h1>\r
+<h2>NAME</h2>\r
+<div class="sectionbody">\r
+<p>git-instaweb -\r
+   instantly browse your working repository in gitweb\r
+</p>\r
+</div>\r
+</div>\r
+<h2>SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<p><em>git-instaweb</em> [--local] [--httpd=&lt;httpd&gt;] [--port=&lt;port&gt;] [--browser=&lt;browser&gt;]</p>\r
+<p><em>git-instaweb</em> [--start] [--stop] [--restart]</p>\r
+</div>\r
+<h2>DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<p>A simple script to setup gitweb and a web server for browsing the local\r
+repository.</p>\r
+</div>\r
+<h2>OPTIONS</h2>\r
+<div class="sectionbody">\r
+<dl>\r
+<dt>\r
+-l|--local\r
+</dt>\r
+<dd>\r
+<p>\r
+        Only bind the web server to the local IP (127.0.0.1).\r
+</p>\r
+</dd>\r
+<dt>\r
+-d|--httpd\r
+</dt>\r
+<dd>\r
+<p>\r
+        The HTTP daemon command-line that will be executed.\r
+        Command-line options may be specified here, and the\r
+        configuration file will be added at the end of the command-line.\r
+        Currently, lighttpd and apache2 are the only supported servers.\r
+        (Default: lighttpd)\r
+</p>\r
+</dd>\r
+<dt>\r
+-m|--module-path\r
+</dt>\r
+<dd>\r
+<p>\r
+        The module path (only needed if httpd is Apache).\r
+        (Default: /usr/lib/apache2/modules)\r
+</p>\r
+</dd>\r
+<dt>\r
+-p|--port\r
+</dt>\r
+<dd>\r
+<p>\r
+        The port number to bind the httpd to.  (Default: 1234)\r
+</p>\r
+</dd>\r
+<dt>\r
+-b|--browser\r
+</dt>\r
+<dd>\r
+<p>\r
+        The web browser command-line to execute to view the gitweb page.\r
+        If blank, the URL of the gitweb instance will be printed to\r
+        stdout.  (Default: <em>firefox</em>)\r
+</p>\r
+</dd>\r
+<dt>\r
+--start\r
+</dt>\r
+<dd>\r
+<p>\r
+        Start the httpd instance and exit.  This does not generate\r
+        any of the configuration files for spawning a new instance.\r
+</p>\r
+</dd>\r
+<dt>\r
+--stop\r
+</dt>\r
+<dd>\r
+<p>\r
+        Stop the httpd instance and exit.  This does not generate\r
+        any of the configuration files for spawning a new instance,\r
+        nor does it close the browser.\r
+</p>\r
+</dd>\r
+<dt>\r
+--restart\r
+</dt>\r
+<dd>\r
+<p>\r
+        Restart the httpd instance and exit.  This does not generate\r
+        any of the configuration files for spawning a new instance.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>CONFIGURATION</h2>\r
+<div class="sectionbody">\r
+<p>You may specify configuration in your .git/config</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>[instaweb]\r
+        local = true\r
+        httpd = apache2 -f\r
+        port = 4321\r
+        browser = konqueror\r
+        modulepath = /usr/lib/apache2/modules\r
+</tt></pre>\r
+</div></div>\r
+</div>\r
+<h2>Author</h2>\r
+<div class="sectionbody">\r
+<p>Written by Eric Wong &lt;normalperson@yhbt.net&gt;</p>\r
+</div>\r
+<h2>Documentation</h2>\r
+<div class="sectionbody">\r
+<p>Documentation by Eric Wong &lt;normalperson@yhbt.net&gt;.</p>\r
+</div>\r
+<h2>GIT</h2>\r
+<div class="sectionbody">\r
+<p>Part of the <a href="git.html">git(7)</a> suite</p>\r
+</div>\r
+<div id="footer">\r
+<div id="footer-text">\r
+Last updated 07-Jul-2006 02:03:31 UTC\r
+</div>\r
+</div>\r
+</body>\r
+</html>\r
diff --git a/git-instaweb.txt b/git-instaweb.txt
new file mode 100644 (file)
index 0000000..7dd393b
--- /dev/null
@@ -0,0 +1,84 @@
+git-instaweb(1)
+===============
+
+NAME
+----
+git-instaweb - instantly browse your working repository in gitweb
+
+SYNOPSIS
+--------
+'git-instaweb' [--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>]
+
+'git-instaweb' [--start] [--stop] [--restart]
+
+DESCRIPTION
+-----------
+A simple script to setup gitweb and a web server for browsing the local
+repository.
+
+OPTIONS
+-------
+
+-l|--local::
+       Only bind the web server to the local IP (127.0.0.1).
+
+-d|--httpd::
+       The HTTP daemon command-line that will be executed.
+       Command-line options may be specified here, and the
+       configuration file will be added at the end of the command-line.
+       Currently, lighttpd and apache2 are the only supported servers.
+       (Default: lighttpd)
+
+-m|--module-path::
+       The module path (only needed if httpd is Apache).
+       (Default: /usr/lib/apache2/modules)
+
+-p|--port::
+       The port number to bind the httpd to.  (Default: 1234)
+
+-b|--browser::
+
+       The web browser command-line to execute to view the gitweb page.
+       If blank, the URL of the gitweb instance will be printed to
+       stdout.  (Default: 'firefox')
+
+--start::
+       Start the httpd instance and exit.  This does not generate
+       any of the configuration files for spawning a new instance.
+
+--stop::
+       Stop the httpd instance and exit.  This does not generate
+       any of the configuration files for spawning a new instance,
+       nor does it close the browser.
+
+--restart::
+       Restart the httpd instance and exit.  This does not generate
+       any of the configuration files for spawning a new instance.
+
+CONFIGURATION
+-------------
+
+You may specify configuration in your .git/config
+
+-----------------------------------------------------------------------
+[instaweb]
+       local = true
+       httpd = apache2 -f
+       port = 4321
+       browser = konqueror
+       modulepath = /usr/lib/apache2/modules
+
+-----------------------------------------------------------------------
+
+Author
+------
+Written by Eric Wong <normalperson@yhbt.net>
+
+Documentation
+--------------
+Documentation by Eric Wong <normalperson@yhbt.net>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+
index ca3912e67ec624ae348beb3814c000d3ae1c879f..e0b125ecfd6a522ff80105beaa15a3e0e5f74ea1 100644 (file)
@@ -638,13 +638,17 @@ core.warnAmbiguousRefs
         and might match multiple refs in the .git/refs/ tree. True by default.\r
 </p>\r
 </dd>\r
-</dl>\r
-<p>core.compression:\r
+<dt>\r
+core.compression\r
+</dt>\r
+<dd>\r
+<p>\r
         An integer -1..9, indicating the compression level for objects that\r
         are not in a pack file. -1 is the zlib and git default. 0 means no\r
         compression, and 1..9 are various speed/size tradeoffs, 9 being\r
-        slowest.</p>\r
-<dl>\r
+        slowest.\r
+</p>\r
+</dd>\r
 <dt>\r
 alias.*\r
 </dt>\r
@@ -884,7 +888,7 @@ imap
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 04-Jul-2006 04:55:18 UTC\r
+Last updated 07-Jul-2006 02:03:32 UTC\r
 </div>\r
 </div>\r
 </body>\r