From 7ec15728dd6c76d7065c3b3b7614f0a799a38916 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Fri, 7 Jul 2006 02:03:59 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.4.1-gc31c --- config.txt | 2 +- git-instaweb.html | 395 +++++++++++++++++++++++++++++++++++++++++++ git-instaweb.txt | 84 +++++++++ git-repo-config.html | 14 +- 4 files changed, 489 insertions(+), 6 deletions(-) create mode 100644 git-instaweb.html create mode 100644 git-instaweb.txt diff --git a/config.txt b/config.txt index 16bdd5523..f075f1981 100644 --- a/config.txt +++ b/config.txt @@ -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 index 000000000..a68cdb601 --- /dev/null +++ b/git-instaweb.html @@ -0,0 +1,395 @@ + + + + + + +git-instaweb(1) + + + +

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 git(7) suite

+
+ + + diff --git a/git-instaweb.txt b/git-instaweb.txt new file mode 100644 index 000000000..7dd393b97 --- /dev/null +++ b/git-instaweb.txt @@ -0,0 +1,84 @@ +git-instaweb(1) +=============== + +NAME +---- +git-instaweb - instantly browse your working repository in gitweb + +SYNOPSIS +-------- +'git-instaweb' [--local] [--httpd=] [--port=] [--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 + +Documentation +-------------- +Documentation by Eric Wong . + +GIT +--- +Part of the gitlink:git[7] suite + diff --git a/git-repo-config.html b/git-repo-config.html index ca3912e67..e0b125ecf 100644 --- a/git-repo-config.html +++ b/git-repo-config.html @@ -638,13 +638,17 @@ core.warnAmbiguousRefs 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 - slowest.

-
+ slowest. +

+
alias.*
@@ -884,7 +888,7 @@ imap -- 2.26.2