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

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