Documentation/git-instaweb.txt

   1 git-instaweb(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-instaweb - Instantly browse your working repository in gitweb
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git-instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
  12                [--browser=<browser>]
  13 'git-instaweb' [--start] [--stop] [--restart]
  14
  15 DESCRIPTION
  16 -----------
  17 A simple script to setup gitweb and a web server for browsing the local
  18 repository.
  19
  20 OPTIONS
  21 -------
  22
  23 -l|--local::
  24         Only bind the web server to the local IP (127.0.0.1).
  25
  26 -d|--httpd::
  27         The HTTP daemon command-line that will be executed.
  28         Command-line options may be specified here, and the
  29         configuration file will be added at the end of the command-line.
  30         Currently lighttpd, apache2 and webrick are supported.
  31         (Default: lighttpd)
  32
  33 -m|--module-path::
  34         The module path (only needed if httpd is Apache).
  35         (Default: /usr/lib/apache2/modules)
  36
  37 -p|--port::
  38         The port number to bind the httpd to.  (Default: 1234)
  39
  40 -b|--browser::
  41         The web browser that should be used to view the gitweb
  42         page. This will be passed to the 'git-web--browse' helper
  43         script along with the URL of the gitweb instance. If the
  44         script fails, the URL will be printed to stdout.
  45 +
  46 Note that the 'git-web--browse' script tries, as much as possible, to
  47 display the HTML page in a new tab on an already opened browser.
  48 +
  49 The following browsers are currently supported by 'git-web--browse':
  50 +
  51 * firefox (this is the default under X Window when not using KDE)
  52 * iceweasel
  53 * konqueror (this is the default under KDE)
  54 * w3m (this is the default outside X Window)
  55 * links
  56 * lynx
  57 * dillo
  58
  59 --start::
  60         Start the httpd instance and exit.  This does not generate
  61         any of the configuration files for spawning a new instance.
  62
  63 --stop::
  64         Stop the httpd instance and exit.  This does not generate
  65         any of the configuration files for spawning a new instance,
  66         nor does it close the browser.
  67
  68 --restart::
  69         Restart the httpd instance and exit.  This does not generate
  70         any of the configuration files for spawning a new instance.
  71
  72 CONFIGURATION
  73 -------------
  74
  75 You may specify configuration in your .git/config
  76
  77 -----------------------------------------------------------------------
  78 [instaweb]
  79         local = true
  80         httpd = apache2 -f
  81         port = 4321
  82         browser = konqueror
  83         modulepath = /usr/lib/apache2/modules
  84
  85 -----------------------------------------------------------------------
  86
  87 If the configuration variable 'instaweb.browser' is not set,
  88 'web.browser' will be used instead if it is defined.
  89
  90 You can explicitly provide a full path to your preferred browser by
  91 setting the configuration variable 'browser.<tool>.path'. For example,
  92 you can configure the absolute path to firefox by setting
  93 'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
  94 is available in PATH.
  95
  96 Author
  97 ------
  98 Written by Eric Wong <normalperson@yhbt.net>
  99
 100 Documentation
 101 --------------
 102 Documentation by Eric Wong <normalperson@yhbt.net>.
 103
 104 GIT
 105 ---
 106 Part of the linkgit:git[7] suite