Blame


1 d9cf1ef0 2023-04-20 stsp <!DOCTYPE html>
2 d9cf1ef0 2023-04-20 stsp <html>
3 d9cf1ef0 2023-04-20 stsp <head>
4 d9cf1ef0 2023-04-20 stsp <meta charset="utf-8"/>
5 d9cf1ef0 2023-04-20 stsp <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 d9cf1ef0 2023-04-20 stsp <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
7 d9cf1ef0 2023-04-20 stsp <title>GITWRAPPER(1)</title>
8 d9cf1ef0 2023-04-20 stsp </head>
9 d9cf1ef0 2023-04-20 stsp <!-- This is an automatically generated file. Do not edit.
10 d9cf1ef0 2023-04-20 stsp Copyright (c) 2023 Stefan Sperling
11 d9cf1ef0 2023-04-20 stsp
12 d9cf1ef0 2023-04-20 stsp Permission to use, copy, modify, and distribute this software for any
13 d9cf1ef0 2023-04-20 stsp purpose with or without fee is hereby granted, provided that the above
14 d9cf1ef0 2023-04-20 stsp copyright notice and this permission notice appear in all copies.
15 d9cf1ef0 2023-04-20 stsp
16 d9cf1ef0 2023-04-20 stsp THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 d9cf1ef0 2023-04-20 stsp WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 d9cf1ef0 2023-04-20 stsp MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 d9cf1ef0 2023-04-20 stsp ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 d9cf1ef0 2023-04-20 stsp WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
21 d9cf1ef0 2023-04-20 stsp ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
22 d9cf1ef0 2023-04-20 stsp OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 d9cf1ef0 2023-04-20 stsp -->
24 d9cf1ef0 2023-04-20 stsp <body>
25 d9cf1ef0 2023-04-20 stsp <div class="head" role="doc-pageheader" aria-label="Manual header
26 d9cf1ef0 2023-04-20 stsp line"><span class="head-ltitle">GITWRAPPER(1)</span>
27 d9cf1ef0 2023-04-20 stsp <span class="head-vol">General Commands Manual</span>
28 d9cf1ef0 2023-04-20 stsp <span class="head-rtitle">GITWRAPPER(1)</span></div>
29 d9cf1ef0 2023-04-20 stsp <main class="manual-text">
30 d9cf1ef0 2023-04-20 stsp <section class="Sh">
31 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
32 d9cf1ef0 2023-04-20 stsp <p class="Pp"><code class="Nm">gitwrapper</code> &#x2014;
33 d9cf1ef0 2023-04-20 stsp <span class="Nd" role="doc-subtitle">invoke an appropriate Git repository
34 d9cf1ef0 2023-04-20 stsp server</span></p>
35 d9cf1ef0 2023-04-20 stsp </section>
36 d9cf1ef0 2023-04-20 stsp <section class="Sh">
37 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
38 d9cf1ef0 2023-04-20 stsp <table class="Nm">
39 d9cf1ef0 2023-04-20 stsp <tr>
40 d9cf1ef0 2023-04-20 stsp <td><code class="Nm">gitwrapper <code class="Fl">-c</code>
41 d9cf1ef0 2023-04-20 stsp &#x2018;<code class="Cm">git-receive-pack</code>
42 d9cf1ef0 2023-04-20 stsp <var class="Ar">repository-path</var>&#x2019;</code></td>
43 d9cf1ef0 2023-04-20 stsp <td></td>
44 d9cf1ef0 2023-04-20 stsp </tr>
45 d9cf1ef0 2023-04-20 stsp </table>
46 d9cf1ef0 2023-04-20 stsp <br/>
47 d9cf1ef0 2023-04-20 stsp <table class="Nm">
48 d9cf1ef0 2023-04-20 stsp <tr>
49 d9cf1ef0 2023-04-20 stsp <td><code class="Nm">gitwrapper <code class="Fl">-c</code>
50 d9cf1ef0 2023-04-20 stsp &#x2018;<code class="Cm">git-upload-pack</code>
51 d9cf1ef0 2023-04-20 stsp <var class="Ar">repository-path</var>&#x2019;</code></td>
52 d9cf1ef0 2023-04-20 stsp <td></td>
53 d9cf1ef0 2023-04-20 stsp </tr>
54 d9cf1ef0 2023-04-20 stsp </table>
55 d9cf1ef0 2023-04-20 stsp </section>
56 d9cf1ef0 2023-04-20 stsp <section class="Sh">
57 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
58 d9cf1ef0 2023-04-20 stsp <p class="Pp">At one time, the only Git repository server software easily
59 d9cf1ef0 2023-04-20 stsp available was built into <a class="Xr" aria-label="git-upload-pack, section
60 d9cf1ef0 2023-04-20 stsp 1">git-upload-pack(1)</a> and <a class="Xr" aria-label="git-receive-pack,
61 d9cf1ef0 2023-04-20 stsp section 1">git-receive-pack(1)</a> which are part of the
62 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="git, section 1">git(1)</a> suite. As a result of
63 d9cf1ef0 2023-04-20 stsp this, most Git client implementations had the path and calling conventions
64 d9cf1ef0 2023-04-20 stsp expected by <a class="Xr" aria-label="git, section 1">git(1)</a> compiled
65 d9cf1ef0 2023-04-20 stsp in.</p>
66 d9cf1ef0 2023-04-20 stsp <p class="Pp">Times have changed, however. On a modern system, the administrator
67 d9cf1ef0 2023-04-20 stsp may wish to use one of several available Git repository servers, such as
68 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="gotd, section 8">gotd(8)</a>.</p>
69 d9cf1ef0 2023-04-20 stsp <p class="Pp">It would be difficult to modify all Git client software typically
70 d9cf1ef0 2023-04-20 stsp available on a system, so most of the authors of alternative Git servers
71 d9cf1ef0 2023-04-20 stsp have written their programs so that they use the same calling conventions as
72 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="git-upload-pack, section 1">git-upload-pack(1)</a>
73 d9cf1ef0 2023-04-20 stsp and <a class="Xr" aria-label="git-receive-pack, section
74 d9cf1ef0 2023-04-20 stsp 1">git-receive-pack(1)</a> and may be put into place in their stead.</p>
75 d9cf1ef0 2023-04-20 stsp <p class="Pp">Although having drop-in replacements for
76 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="git-upload-pack, section 1">git-upload-pack(1)</a>
77 d9cf1ef0 2023-04-20 stsp and <a class="Xr" aria-label="git-receive-pack, section
78 d9cf1ef0 2023-04-20 stsp 1">git-receive-pack(1)</a> helps in installing alternative Git servers, it
79 d9cf1ef0 2023-04-20 stsp essentially makes the configuration of the system depend on hard installing
80 d9cf1ef0 2023-04-20 stsp new programs in <span class="Pa">/usr</span>. This leads to configuration
81 d9cf1ef0 2023-04-20 stsp problems for many administrators, since they may wish to install a new Git
82 d9cf1ef0 2023-04-20 stsp server without altering the system provided <span class="Pa">/usr</span>.
83 d9cf1ef0 2023-04-20 stsp (This may be, for example, to avoid having upgrade problems when a new
84 d9cf1ef0 2023-04-20 stsp version of the system is installed over the old.) They may also have a
85 d9cf1ef0 2023-04-20 stsp shared <span class="Pa">/usr</span> among several machines, and may wish to
86 d9cf1ef0 2023-04-20 stsp avoid placing implicit configuration information in a read-only
87 d9cf1ef0 2023-04-20 stsp <span class="Pa">/usr</span>.</p>
88 d9cf1ef0 2023-04-20 stsp <p class="Pp">The <code class="Nm">gitwrapper</code> program is designed to
89 d9cf1ef0 2023-04-20 stsp replace <a class="Xr" aria-label="git-upload-pack, section
90 d9cf1ef0 2023-04-20 stsp 1">git-upload-pack(1)</a> and <a class="Xr" aria-label="git-receive-pack,
91 d9cf1ef0 2023-04-20 stsp section 1">git-receive-pack(1)</a> and to invoke an appropriate Git server
92 d9cf1ef0 2023-04-20 stsp based on configuration information placed in
93 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>. This
94 d9cf1ef0 2023-04-20 stsp permits the administrator to configure which Git server is to be invoked on
95 d9cf1ef0 2023-04-20 stsp the system at run-time. Git repositories which are listed in
96 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a> and exist
97 d9cf1ef0 2023-04-20 stsp on the filesystem will be served by <a class="Xr" aria-label="gotsh, section
98 d9cf1ef0 2023-04-20 stsp 1">gotsh(1)</a>. Any other Git repositories will be served by
99 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="git-upload-pack, section 1">git-upload-pack(1)</a>
100 d9cf1ef0 2023-04-20 stsp and <a class="Xr" aria-label="git-receive-pack, section
101 d9cf1ef0 2023-04-20 stsp 1">git-receive-pack(1)</a> as found in Git's <span class="Pa">libexec</span>
102 d9cf1ef0 2023-04-20 stsp directory, which is <span class="Pa">/usr/local/libexec/git/</span> by
103 d9cf1ef0 2023-04-20 stsp default on <span class="Ux">OpenBSD</span>.</p>
104 d9cf1ef0 2023-04-20 stsp </section>
105 d9cf1ef0 2023-04-20 stsp <section class="Sh">
106 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h2>
107 d9cf1ef0 2023-04-20 stsp <dl class="Bl-tag">
108 d9cf1ef0 2023-04-20 stsp <dt id="GOTD_CONF_PATH"><a class="permalink" href="#GOTD_CONF_PATH"><code class="Ev">GOTD_CONF_PATH</code></a></dt>
109 d9cf1ef0 2023-04-20 stsp <dd>Set the path to the configuration file for <a class="Xr" aria-label="gotd,
110 d9cf1ef0 2023-04-20 stsp section 8">gotd(8)</a>. If not specified, the default path
111 d9cf1ef0 2023-04-20 stsp <span class="Pa">/etc/gotd.conf</span> will be used.</dd>
112 d9cf1ef0 2023-04-20 stsp </dl>
113 d9cf1ef0 2023-04-20 stsp </section>
114 d9cf1ef0 2023-04-20 stsp <section class="Sh">
115 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
116 d9cf1ef0 2023-04-20 stsp <p class="Pp">Configuration for <a class="Xr" aria-label="gotd, section
117 d9cf1ef0 2023-04-20 stsp 8">gotd(8)</a> is kept in <span class="Pa">/etc/gotd.conf</span>.</p>
118 d9cf1ef0 2023-04-20 stsp <p class="Pp"><span class="Pa">git-upload-pack</span> and
119 d9cf1ef0 2023-04-20 stsp <span class="Pa">git-receive-pack</span> are typically set up as a symlink
120 d9cf1ef0 2023-04-20 stsp to <code class="Nm">gitwrapper</code> which is not usually invoked on its
121 d9cf1ef0 2023-04-20 stsp own.</p>
122 d9cf1ef0 2023-04-20 stsp </section>
123 d9cf1ef0 2023-04-20 stsp <section class="Sh">
124 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
125 d9cf1ef0 2023-04-20 stsp ALSO</a></h2>
126 d9cf1ef0 2023-04-20 stsp <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
127 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>,
128 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="gotd, section 8">gotd(8)</a>,
129 d9cf1ef0 2023-04-20 stsp <a class="Xr" aria-label="mailwrapper, section 8">mailwrapper(8)</a></p>
130 d9cf1ef0 2023-04-20 stsp </section>
131 d9cf1ef0 2023-04-20 stsp <section class="Sh">
132 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
133 d9cf1ef0 2023-04-20 stsp <p class="Pp"><span class="An">Stefan Sperling</span>
134 d9cf1ef0 2023-04-20 stsp &lt;<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>&gt;</p>
135 d9cf1ef0 2023-04-20 stsp </section>
136 d9cf1ef0 2023-04-20 stsp <section class="Sh">
137 d9cf1ef0 2023-04-20 stsp <h2 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h2>
138 d9cf1ef0 2023-04-20 stsp <p class="Pp">The entire reason this program exists is a crock. Instead, a
139 d9cf1ef0 2023-04-20 stsp command for invoking a Git server should be standardized or the Git protocol
140 d9cf1ef0 2023-04-20 stsp should be changed to make the path to the program discoverable by Git
141 d9cf1ef0 2023-04-20 stsp clients.</p>
142 d9cf1ef0 2023-04-20 stsp </section>
143 d9cf1ef0 2023-04-20 stsp </main>
144 d9cf1ef0 2023-04-20 stsp <div class="foot" role="doc-pagefooter" aria-label="Manual footer
145 16fecf30 2024-07-11 op line"><span class="foot-left"></span><span class="foot-date">July 11,
146 2b1d45b9 2024-03-11 stsp 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
147 d9cf1ef0 2023-04-20 stsp </body>
148 d9cf1ef0 2023-04-20 stsp </html>