logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-instaweb.1 (3612B)

    

  1. '\" t
  2. .\"     Title: git-instaweb
  3. .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GIT\-INSTAWEB" "1" "2025-03-14" "Git 2\&.49\&.0" "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. .SH "DESCRIPTION"
  40. .sp
  41. A simple script to set up \fBgitweb\fR and a web server for browsing the local repository\&.
  42. .SH "OPTIONS"
  43. .PP
  44. \-l, \-\-local
  45. .RS 4
  46. Only bind the web server to the local IP (127\&.0\&.0\&.1)\&.
  47. .RE
  48. .PP
  49. \-d, \-\-httpd
  50. .RS 4
  51. 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)
  52. .RE
  53. .PP
  54. \-m, \-\-module\-path
  55. .RS 4
  56. The module path (only needed if httpd is Apache)\&. (Default: /usr/lib/apache2/modules)
  57. .RE
  58. .PP
  59. \-p, \-\-port
  60. .RS 4
  61. The port number to bind the httpd to\&. (Default: 1234)
  62. .RE
  63. .PP
  64. \-b, \-\-browser
  65. .RS 4
  66. The web browser that should be used to view the gitweb page\&. This will be passed to the
  67. \fIgit web\-\-browse\fR
  68. helper script along with the URL of the gitweb instance\&. See
  69. \fBgit-web--browse\fR(1)
  70. for more information about this\&. If the script fails, the URL will be printed to stdout\&.
  71. .RE
  72. .PP
  73. start, \-\-start
  74. .RS 4
  75. Start the httpd instance and exit\&. Regenerate configuration files as necessary for spawning a new instance\&.
  76. .RE
  77. .PP
  78. stop, \-\-stop
  79. .RS 4
  80. 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\&.
  81. .RE
  82. .PP
  83. restart, \-\-restart
  84. .RS 4
  85. Restart the httpd instance and exit\&. Regenerate configuration files as necessary for spawning a new instance\&.
  86. .RE
  87. .SH "CONFIGURATION"
  88. .sp
  89. You may specify configuration in your \&.git/config
  90. .sp
  91. .if n \{\
  92. .RS 4
  93. .\}
  94. .nf
  95. [instaweb]
  96.         local = true
  97.         httpd = apache2 \-f
  98.         port = 4321
  99.         browser = konqueror
  100.         modulePath = /usr/lib/apache2/modules
  101. .fi
  102. .if n \{\
  103. .RE
  104. .\}
  105. .sp
  106. 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\&.
  107. .SH "SEE ALSO"
  108. .sp
  109. \fBgitweb\fR(1)
  110. .SH "GIT"
  111. .sp
  112. Part of the \fBgit\fR(1) suite