Documentation / git-instaweb.txton commit Merge branch 'jn/make' (2dcb927)
   1git-instaweb(1)
   2===============
   3
   4NAME
   5----
   6git-instaweb - instantly browse your working repository in gitweb
   7
   8SYNOPSIS
   9--------
  10'git-instaweb' [--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>]
  11
  12'git-instaweb' [--start] [--stop] [--restart]
  13
  14DESCRIPTION
  15-----------
  16A simple script to setup gitweb and a web server for browsing the local
  17repository.
  18
  19OPTIONS
  20-------
  21
  22-l|--local::
  23        Only bind the web server to the local IP (127.0.0.1).
  24
  25-d|--httpd::
  26        The HTTP daemon command-line that will be executed.
  27        Command-line options may be specified here, and the
  28        configuration file will be added at the end of the command-line.
  29        Currently, lighttpd and apache2 are the only supported servers.
  30        (Default: lighttpd)
  31
  32-m|--module-path::
  33        The module path (only needed if httpd is Apache).
  34        (Default: /usr/lib/apache2/modules)
  35
  36-p|--port::
  37        The port number to bind the httpd to.  (Default: 1234)
  38
  39-b|--browser::
  40
  41        The web browser command-line to execute to view the gitweb page.
  42        If blank, the URL of the gitweb instance will be printed to
  43        stdout.  (Default: 'firefox')
  44
  45--start::
  46        Start the httpd instance and exit.  This does not generate
  47        any of the configuration files for spawning a new instance.
  48
  49--stop::
  50        Stop the httpd instance and exit.  This does not generate
  51        any of the configuration files for spawning a new instance,
  52        nor does it close the browser.
  53
  54--restart::
  55        Restart the httpd instance and exit.  This does not generate
  56        any of the configuration files for spawning a new instance.
  57
  58CONFIGURATION
  59-------------
  60
  61You may specify configuration in your .git/config
  62
  63-----------------------------------------------------------------------
  64[instaweb]
  65        local = true
  66        httpd = apache2 -f
  67        port = 4321
  68        browser = konqueror
  69        modulepath = /usr/lib/apache2/modules
  70
  71-----------------------------------------------------------------------
  72
  73Author
  74------
  75Written by Eric Wong <normalperson@yhbt.net>
  76
  77Documentation
  78--------------
  79Documentation by Eric Wong <normalperson@yhbt.net>.
  80
  81GIT
  82---
  83Part of the gitlink:git[7] suite
  84