man1/git-instaweb.1

   1 '\" t
   2 .\"     Title: git-instaweb
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-04-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.0.31.gd4cc1ec35f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-INSTAWEB" "1" "2024\-04\-30" "Git 2\&.45\&.0\&.31\&.gd4cc1ec" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-instaweb \- Instantly browse your working repository in gitweb
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit instaweb\fR [\-\-local] [\-\-httpd=<httpd>] [\-\-port=<port>]
  36                [\-\-browser=<browser>]
  37 \fIgit instaweb\fR [\-\-start] [\-\-stop] [\-\-restart]
  38 .fi
  39 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 A simple script to set up \fBgitweb\fR and a web server for browsing the local repository\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-l, \-\-local
  46 .RS 4
  47 Only bind the web server to the local IP (127\&.0\&.0\&.1)\&.
  48 .RE
  49 .PP
  50 \-d, \-\-httpd
  51 .RS 4
  52 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 apache2, lighttpd, mongoose, plackup, python and webrick are supported\&. (Default: lighttpd)
  53 .RE
  54 .PP
  55 \-m, \-\-module\-path
  56 .RS 4
  57 The module path (only needed if httpd is Apache)\&. (Default: /usr/lib/apache2/modules)
  58 .RE
  59 .PP
  60 \-p, \-\-port
  61 .RS 4
  62 The port number to bind the httpd to\&. (Default: 1234)
  63 .RE
  64 .PP
  65 \-b, \-\-browser
  66 .RS 4
  67 The web browser that should be used to view the gitweb page\&. This will be passed to the
  68 \fIgit web\-\-browse\fR
  69 helper script along with the URL of the gitweb instance\&. See
  70 \fBgit-web--browse\fR(1)
  71 for more information about this\&. If the script fails, the URL will be printed to stdout\&.
  72 .RE
  73 .PP
  74 start, \-\-start
  75 .RS 4
  76 Start the httpd instance and exit\&. Regenerate configuration files as necessary for spawning a new instance\&.
  77 .RE
  78 .PP
  79 stop, \-\-stop
  80 .RS 4
  81 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\&.
  82 .RE
  83 .PP
  84 restart, \-\-restart
  85 .RS 4
  86 Restart the httpd instance and exit\&. Regenerate configuration files as necessary for spawning a new instance\&.
  87 .RE
  88 .SH "CONFIGURATION"
  89 .sp
  90 You may specify configuration in your \&.git/config
  91 .sp
  92 .if n \{\
  93 .RS 4
  94 .\}
  95 .nf
  96 [instaweb]
  97         local = true
  98         httpd = apache2 \-f
  99         port = 4321
 100         browser = konqueror
 101         modulePath = /usr/lib/apache2/modules
 102 .fi
 103 .if n \{\
 104 .RE
 105 .\}
 106 .sp
 107 .sp
 108 If the configuration variable \fBinstaweb\&.browser\fR is not set, \fBweb\&.browser\fR will be used instead if it is defined\&. See \fBgit-web--browse\fR(1) for more information about this\&.
 109 .SH "SEE ALSO"
 110 .sp
 111 \fBgitweb\fR(1)
 112 .SH "GIT"
 113 .sp
 114 Part of the \fBgit\fR(1) suite