doc/source/en/TortoiseGit/git_doc/git-instaweb.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-instaweb(1)">\r
   5 <articleinfo>\r
   6     <title>git-instaweb(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-instaweb(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-instaweb - Instantly browse your working repository in gitweb</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git instaweb</emphasis> [--local] [--httpd=&lt;httpd&gt;] [--port=&lt;port&gt;]\r
  19                [--browser=&lt;browser&gt;]\r
  20 <emphasis>git instaweb</emphasis> [--start] [--stop] [--restart]</literallayout>\r
  21 </blockquote>\r
  22 </simplesect>\r
  23 <simplesect id="_description">\r
  24 <title>DESCRIPTION</title>\r
  25 <simpara>A simple script to set up <emphasis>gitweb</emphasis> and a web server for browsing the local\r
  26 repository.</simpara>\r
  27 </simplesect>\r
  28 <simplesect id="_options">\r
  29 <title>OPTIONS</title>\r
  30 <variablelist>\r
  31 <varlistentry>\r
  32 <term>\r
  33 -l\r
  34 </term>\r
  35 <term>\r
  36 --local\r
  37 </term>\r
  38 <listitem>\r
  39 <simpara>\r
  40         Only bind the web server to the local IP (127.0.0.1).\r
  41 </simpara>\r
  42 </listitem>\r
  43 </varlistentry>\r
  44 <varlistentry>\r
  45 <term>\r
  46 -d\r
  47 </term>\r
  48 <term>\r
  49 --httpd\r
  50 </term>\r
  51 <listitem>\r
  52 <simpara>\r
  53         The HTTP daemon command-line that will be executed.\r
  54         Command-line options may be specified here, and the\r
  55         configuration file will be added at the end of the command-line.\r
  56         Currently apache2, lighttpd, mongoose, plackup and webrick are supported.\r
  57         (Default: lighttpd)\r
  58 </simpara>\r
  59 </listitem>\r
  60 </varlistentry>\r
  61 <varlistentry>\r
  62 <term>\r
  63 -m\r
  64 </term>\r
  65 <term>\r
  66 --module-path\r
  67 </term>\r
  68 <listitem>\r
  69 <simpara>\r
  70         The module path (only needed if httpd is Apache).\r
  71         (Default: /usr/lib/apache2/modules)\r
  72 </simpara>\r
  73 </listitem>\r
  74 </varlistentry>\r
  75 <varlistentry>\r
  76 <term>\r
  77 -p\r
  78 </term>\r
  79 <term>\r
  80 --port\r
  81 </term>\r
  82 <listitem>\r
  83 <simpara>\r
  84         The port number to bind the httpd to.  (Default: 1234)\r
  85 </simpara>\r
  86 </listitem>\r
  87 </varlistentry>\r
  88 <varlistentry>\r
  89 <term>\r
  90 -b\r
  91 </term>\r
  92 <term>\r
  93 --browser\r
  94 </term>\r
  95 <listitem>\r
  96 <simpara>\r
  97         The web browser that should be used to view the gitweb\r
  98         page. This will be passed to the <emphasis>git web&#45;&#45;browse</emphasis> helper\r
  99         script along with the URL of the gitweb instance. See\r
 100         <xref linkend="git-web&#45;&#45;browse(1)" /> for more information about this. If\r
 101         the script fails, the URL will be printed to stdout.\r
 102 </simpara>\r
 103 </listitem>\r
 104 </varlistentry>\r
 105 <varlistentry>\r
 106 <term>\r
 107 start\r
 108 </term>\r
 109 <term>\r
 110 --start\r
 111 </term>\r
 112 <listitem>\r
 113 <simpara>\r
 114         Start the httpd instance and exit.  Regenerate configuration files\r
 115         as necessary for spawning a new instance.\r
 116 </simpara>\r
 117 </listitem>\r
 118 </varlistentry>\r
 119 <varlistentry>\r
 120 <term>\r
 121 stop\r
 122 </term>\r
 123 <term>\r
 124 --stop\r
 125 </term>\r
 126 <listitem>\r
 127 <simpara>\r
 128         Stop the httpd instance and exit.  This does not generate\r
 129         any of the configuration files for spawning a new instance,\r
 130         nor does it close the browser.\r
 131 </simpara>\r
 132 </listitem>\r
 133 </varlistentry>\r
 134 <varlistentry>\r
 135 <term>\r
 136 restart\r
 137 </term>\r
 138 <term>\r
 139 --restart\r
 140 </term>\r
 141 <listitem>\r
 142 <simpara>\r
 143         Restart the httpd instance and exit.  Regenerate configuration files\r
 144         as necessary for spawning a new instance.\r
 145 </simpara>\r
 146 </listitem>\r
 147 </varlistentry>\r
 148 </variablelist>\r
 149 </simplesect>\r
 150 <simplesect id="_configuration">\r
 151 <title>CONFIGURATION</title>\r
 152 <simpara>You may specify configuration in your .git/config</simpara>\r
 153 <screen>[instaweb]\r
 154         local = true\r
 155         httpd = apache2 -f\r
 156         port = 4321\r
 157         browser = konqueror\r
 158         modulepath = /usr/lib/apache2/modules</screen>\r
 159 <simpara>If the configuration variable <emphasis>instaweb.browser</emphasis> is not set,\r
 160 <emphasis>web.browser</emphasis> will be used instead if it is defined. See\r
 161 <xref linkend="git-web&#45;&#45;browse(1)" /> for more information about this.</simpara>\r
 162 </simplesect>\r
 163 <simplesect id="_see_also">\r
 164 <title>SEE ALSO</title>\r
 165 <simpara><xref linkend="gitweb(1)" /></simpara>\r
 166 </simplesect>\r
 167 <simplesect id="_git">\r
 168 <title>GIT</title>\r
 169 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 170 </simplesect>\r
 171 </article>\r