Blame


1 1a21a6dd 2021-09-12 stsp <!DOCTYPE html>
2 1a21a6dd 2021-09-12 stsp <html>
3 63657f42 2022-09-07 stsp <head>
4 63657f42 2022-09-07 stsp <meta charset="utf-8"/>
5 63657f42 2022-09-07 stsp <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 63657f42 2022-09-07 stsp <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
7 63657f42 2022-09-07 stsp <title>GOT.CONF(5)</title>
8 63657f42 2022-09-07 stsp </head>
9 1a21a6dd 2021-09-12 stsp <!-- This is an automatically generated file. Do not edit.
10 1a21a6dd 2021-09-12 stsp Copyright (c) 2020 Stefan Sperling <stsp@openbsd.org>
11 1a21a6dd 2021-09-12 stsp
12 1a21a6dd 2021-09-12 stsp Permission to use, copy, modify, and distribute this software for any
13 1a21a6dd 2021-09-12 stsp purpose with or without fee is hereby granted, provided that the above
14 1a21a6dd 2021-09-12 stsp copyright notice and this permission notice appear in all copies.
15 1a21a6dd 2021-09-12 stsp
16 1a21a6dd 2021-09-12 stsp THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 1a21a6dd 2021-09-12 stsp WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 1a21a6dd 2021-09-12 stsp MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 1a21a6dd 2021-09-12 stsp ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 1a21a6dd 2021-09-12 stsp WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
21 1a21a6dd 2021-09-12 stsp ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
22 1a21a6dd 2021-09-12 stsp OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 1a21a6dd 2021-09-12 stsp -->
24 1a21a6dd 2021-09-12 stsp <body>
25 63657f42 2022-09-07 stsp <div class="head" role="doc-pageheader" aria-label="Manual header
26 63657f42 2022-09-07 stsp line"><span class="head-ltitle">GOT.CONF(5)</span> <span class="head-vol">File
27 63657f42 2022-09-07 stsp Formats Manual</span> <span class="head-rtitle">GOT.CONF(5)</span></div>
28 63657f42 2022-09-07 stsp <main class="manual-text">
29 1a21a6dd 2021-09-12 stsp <section class="Sh">
30 63657f42 2022-09-07 stsp <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
31 63657f42 2022-09-07 stsp <p class="Pp"><code class="Nm">got.conf</code> &#x2014;
32 63657f42 2022-09-07 stsp <span class="Nd" role="doc-subtitle">Game of Trees configuration
33 63657f42 2022-09-07 stsp file</span></p>
34 1a21a6dd 2021-09-12 stsp </section>
35 1a21a6dd 2021-09-12 stsp <section class="Sh">
36 63657f42 2022-09-07 stsp <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
37 1a21a6dd 2021-09-12 stsp <p class="Pp"><code class="Nm">got.conf</code> is the run-time configuration
38 376d4d52 2022-07-04 stsp file for <a class="Xr" aria-label="got, section 1">got(1)</a>.</p>
39 1a21a6dd 2021-09-12 stsp <p class="Pp"><code class="Nm">got.conf</code> may be present in the root
40 1a21a6dd 2021-09-12 stsp directory of a Git repository for repository-wide settings, or in the
41 1a21a6dd 2021-09-12 stsp <span class="Pa">.got</span> meta-data directory of a work tree to override
42 376d4d52 2022-07-04 stsp repository-wide settings for <a class="Xr" aria-label="got, section
43 376d4d52 2022-07-04 stsp 1">got(1)</a> commands executed within this work tree.</p>
44 1a21a6dd 2021-09-12 stsp <p class="Pp">The file format is line-based, with one configuration directive
45 1a21a6dd 2021-09-12 stsp per line. Any lines beginning with a &#x2018;#&#x2019; are treated as
46 1a21a6dd 2021-09-12 stsp comments and ignored.</p>
47 1a21a6dd 2021-09-12 stsp <p class="Pp">The available configuration directives are as follows:</p>
48 1a21a6dd 2021-09-12 stsp <dl class="Bl-tag">
49 1a21a6dd 2021-09-12 stsp <dt id="author"><a class="permalink" href="#author"><code class="Ic">author</code></a>
50 1a21a6dd 2021-09-12 stsp &#x201C;Real Name &lt;email address&gt;&#x201D;</dt>
51 1a21a6dd 2021-09-12 stsp <dd>Configure the author's name and email address for <code class="Cm">got
52 1a21a6dd 2021-09-12 stsp commit</code> and <code class="Cm">got import</code> when operating on
53 1a21a6dd 2021-09-12 stsp this repository. Author information specified here overrides the
54 1a21a6dd 2021-09-12 stsp <code class="Ev">GOT_AUTHOR</code> environment variable.
55 376d4d52 2022-07-04 stsp <p class="Pp">Because <a class="Xr" aria-label="git, section 1">git(1)</a>
56 376d4d52 2022-07-04 stsp may fail to parse commits without an email address in author data,
57 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got, section 1">got(1)</a> attempts to reject
58 376d4d52 2022-07-04 stsp author information with a missing email address.</p>
59 1a21a6dd 2021-09-12 stsp </dd>
60 51683866 2022-07-14 stsp <dt id="signer_id"><a class="permalink" href="#signer_id"><code class="Ic">signer_id</code></a>
61 51683866 2022-07-14 stsp <span class="Pa">signer-id</span></dt>
62 51683866 2022-07-14 stsp <dd>Configure a <var class="Ar">signer-id</var> to sign tag objects. This key
63 51683866 2022-07-14 stsp will be used to sign all tag objects unless overridden by
64 51683866 2022-07-14 stsp <code class="Cm">got tag</code> <code class="Fl">-s</code>
65 51683866 2022-07-14 stsp <var class="Ar">signer-id</var>.
66 51683866 2022-07-14 stsp <p class="Pp">For SSH-based signatures, <var class="Ar">signer-id</var> is
67 51683866 2022-07-14 stsp the path to a file which may refer to either a private SSH key, or a
68 51683866 2022-07-14 stsp public SSH key with the private half available via
69 51683866 2022-07-14 stsp <a class="Xr" aria-label="ssh-agent, section 1">ssh-agent(1)</a>.</p>
70 51683866 2022-07-14 stsp </dd>
71 376d4d52 2022-07-04 stsp <dt id="allowed_signers"><a class="permalink" href="#allowed_signers"><code class="Ic">allowed_signers</code></a>
72 376d4d52 2022-07-04 stsp <span class="Pa">path</span></dt>
73 376d4d52 2022-07-04 stsp <dd>Configure a <var class="Ar">path</var> to the &quot;allowed signers&quot;
74 376d4d52 2022-07-04 stsp file which contains a list of trusted SSH signer identities. The file will
75 376d4d52 2022-07-04 stsp be passed to <a class="Xr" aria-label="ssh-keygen, section
76 376d4d52 2022-07-04 stsp 1">ssh-keygen(1)</a> during verification of SSH-based signatures with
77 376d4d52 2022-07-04 stsp <code class="Cm">got tag</code> <code class="Fl">-V</code>. The format of
78 376d4d52 2022-07-04 stsp the &quot;allowed signers&quot; file is documented in the ALLOWED SIGNERS
79 376d4d52 2022-07-04 stsp section of <a class="Xr" aria-label="ssh-keygen, section
80 376d4d52 2022-07-04 stsp 1">ssh-keygen(1)</a>.
81 376d4d52 2022-07-04 stsp <p class="Pp">Verification of SSH-based signatures is impossible unless the
82 376d4d52 2022-07-04 stsp <code class="Ic">allowed_signers</code> option is set in
83 376d4d52 2022-07-04 stsp <code class="Nm">got.conf</code>.</p>
84 376d4d52 2022-07-04 stsp </dd>
85 376d4d52 2022-07-04 stsp <dt id="revoked_signers"><a class="permalink" href="#revoked_signers"><code class="Ic">revoked_signers</code></a>
86 376d4d52 2022-07-04 stsp <span class="Pa">path</span></dt>
87 376d4d52 2022-07-04 stsp <dd>Configure a <var class="Ar">path</var> to the optional &quot;revoked
88 376d4d52 2022-07-04 stsp signers&quot; file, which contains a list of revoked SSH signer
89 376d4d52 2022-07-04 stsp identities. This file is passed to <a class="Xr" aria-label="ssh-keygen,
90 376d4d52 2022-07-04 stsp section 1">ssh-keygen(1)</a> during signature verification with
91 376d4d52 2022-07-04 stsp <code class="Cm">got tag</code> <code class="Fl">-V</code>. Revoked
92 376d4d52 2022-07-04 stsp identities are no longer considered trustworthy and verification of
93 376d4d52 2022-07-04 stsp relevant signatures will fail.</dd>
94 1a21a6dd 2021-09-12 stsp <dt id="remote"><a class="permalink" href="#remote"><code class="Ic">remote</code></a>
95 1a21a6dd 2021-09-12 stsp <var class="Ar">name</var> {...}</dt>
96 1a21a6dd 2021-09-12 stsp <dd>Define a remote repository. The specified <var class="Ar">name</var> can
97 1a21a6dd 2021-09-12 stsp be used to refer to the remote repository on the command line of
98 1a21a6dd 2021-09-12 stsp <code class="Cm">got fetch</code> and <code class="Cm">got send</code>.
99 fd9580e1 2022-11-03 stsp <p class="Pp">When repositories are shared between multiple users on the
100 fd9580e1 2022-11-03 stsp system, it is recommended that users configure their trusted remote
101 fd9580e1 2022-11-03 stsp repositories in each of their work-trees'
102 fd9580e1 2022-11-03 stsp <code class="Nm">got.conf</code> files, overriding corresponding
103 fd9580e1 2022-11-03 stsp repository-wide settings. This can avoid potentially undesirable
104 fd9580e1 2022-11-03 stsp connections to remote repositories placed into the shared repository's
105 fd9580e1 2022-11-03 stsp <code class="Nm">got.conf</code> file by other users.</p>
106 fd9580e1 2022-11-03 stsp <p class="Pp">Information about a repository is declared in a block of
107 1a21a6dd 2021-09-12 stsp options enclosed in curly brackets:</p>
108 1a21a6dd 2021-09-12 stsp <dl class="Bl-tag">
109 1a21a6dd 2021-09-12 stsp <dt id="server"><a class="permalink" href="#server"><code class="Ic">server</code></a>
110 1a21a6dd 2021-09-12 stsp <var class="Ar">hostname</var></dt>
111 1a21a6dd 2021-09-12 stsp <dd>Defines the hostname to use for contacting the remote repository's
112 1a21a6dd 2021-09-12 stsp server.</dd>
113 1a21a6dd 2021-09-12 stsp <dt id="repository"><a class="permalink" href="#repository"><code class="Ic">repository</code></a>
114 1a21a6dd 2021-09-12 stsp <var class="Ar">path</var></dt>
115 1a21a6dd 2021-09-12 stsp <dd>Defines the path to the repository on the remote repository's
116 1a21a6dd 2021-09-12 stsp server.</dd>
117 1a21a6dd 2021-09-12 stsp <dt id="protocol"><a class="permalink" href="#protocol"><code class="Ic">protocol</code></a>
118 1a21a6dd 2021-09-12 stsp <var class="Ar">scheme</var></dt>
119 1a21a6dd 2021-09-12 stsp <dd>Defines the protocol to use for communicating with the remote
120 1a21a6dd 2021-09-12 stsp repository's server.
121 1a21a6dd 2021-09-12 stsp <p class="Pp">The following protocol schemes are supported:</p>
122 1a21a6dd 2021-09-12 stsp <dl class="Bl-tag">
123 1a21a6dd 2021-09-12 stsp <dt>git</dt>
124 1a21a6dd 2021-09-12 stsp <dd>The Git protocol as implemented by the
125 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-daemon, section 1">git-daemon(1)</a>
126 376d4d52 2022-07-04 stsp server. Use of this protocol is discouraged since it supports
127 376d4d52 2022-07-04 stsp neither authentication nor encryption.</dd>
128 dfc34448 2024-05-06 stsp <dt>ssh</dt>
129 1a21a6dd 2021-09-12 stsp <dd>The Git protocol wrapped in an authenticated and encrypted
130 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> tunnel. With
131 376d4d52 2022-07-04 stsp this protocol the hostname may contain an embedded username for
132 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> to use:
133 376d4d52 2022-07-04 stsp <a class="Mt" href="mailto:user@hostname">user@hostname</a></dd>
134 dfc34448 2024-05-06 stsp <dt>http</dt>
135 dfc34448 2024-05-06 stsp <dd>The &#x201C;smart&#x201D; Git HTTP protocol. Not compatible with
136 dfc34448 2024-05-06 stsp servers using the &#x201C;dumb&#x201D; Git HTTP protocol.
137 dfc34448 2024-05-06 stsp <p class="Pp">The &#x201C;smart&#x201D; Git HTTP protocol is
138 dfc34448 2024-05-06 stsp supported by <code class="Cm">got clone</code> and
139 dfc34448 2024-05-06 stsp <code class="Cm">got fetch</code>, but not by
140 dfc34448 2024-05-06 stsp <code class="Cm">got send</code>. To send from a repository
141 dfc34448 2024-05-06 stsp cloned over HTTP, add a <code class="Ic">send</code> block (see
142 dfc34448 2024-05-06 stsp below) to ensure that the &#x201C;ssh://&#x201D; protocol will
143 dfc34448 2024-05-06 stsp be used by <code class="Cm">got send</code>.</p>
144 dfc34448 2024-05-06 stsp <p class="Pp">Use of this protocol is discouraged since it supports
145 dfc34448 2024-05-06 stsp neither authentication nor encryption.</p>
146 dfc34448 2024-05-06 stsp </dd>
147 dfc34448 2024-05-06 stsp <dt>https</dt>
148 dfc34448 2024-05-06 stsp <dd>The &#x201C;smart&#x201D; Git HTTP protocol wrapped in
149 dfc34448 2024-05-06 stsp SSL/TLS.</dd>
150 1a21a6dd 2021-09-12 stsp </dl>
151 1a21a6dd 2021-09-12 stsp </dd>
152 1a21a6dd 2021-09-12 stsp <dt id="port"><a class="permalink" href="#port"><code class="Ic">port</code></a>
153 1a21a6dd 2021-09-12 stsp <var class="Ar">port</var></dt>
154 1a21a6dd 2021-09-12 stsp <dd>Defines the port to use for connecting to the remote repository's
155 1a21a6dd 2021-09-12 stsp server. The <var class="Ar">port</var> can be specified by number or
156 1a21a6dd 2021-09-12 stsp name. The port name to number mappings are found in the file
157 1a21a6dd 2021-09-12 stsp <span class="Pa">/etc/services</span>; see
158 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="services, section 5">services(5)</a> for
159 376d4d52 2022-07-04 stsp details. If not specified, the default port of the specified
160 376d4d52 2022-07-04 stsp <code class="Cm">protocol</code> will be used.</dd>
161 1a21a6dd 2021-09-12 stsp <dt id="branch"><a class="permalink" href="#branch"><code class="Ic">branch</code></a>
162 1a21a6dd 2021-09-12 stsp {<var class="Ar">branch ...</var>}</dt>
163 1a21a6dd 2021-09-12 stsp <dd>Specify one or more branches which <code class="Cm">got fetch</code>
164 1a21a6dd 2021-09-12 stsp and <code class="Cm">got send</code> should fetch from and send to the
165 1a21a6dd 2021-09-12 stsp remote repository by default. The list of branches specified here can
166 1a21a6dd 2021-09-12 stsp be overridden at the <code class="Cm">got fetch</code> and
167 1a21a6dd 2021-09-12 stsp <code class="Cm">got send</code> command lines with the
168 1a21a6dd 2021-09-12 stsp <code class="Fl">-b</code> option.</dd>
169 376d4d52 2022-07-04 stsp <dt id="fetch_all_branches"><a class="permalink" href="#fetch_all_branches"><code class="Ic">fetch_all_branches</code></a>
170 1a21a6dd 2021-09-12 stsp <var class="Ar">yes</var> | <var class="Ar">no</var></dt>
171 1a21a6dd 2021-09-12 stsp <dd>This option controls whether <code class="Cm">got fetch</code> will
172 1a21a6dd 2021-09-12 stsp fetch all branches from the remote repository by default. If enabled,
173 1a21a6dd 2021-09-12 stsp this behaviour can be overridden at the <code class="Cm">got
174 1a21a6dd 2021-09-12 stsp fetch</code> command line with the <code class="Fl">-b</code> option,
175 1a21a6dd 2021-09-12 stsp and any <code class="Cm">branch</code> configuration settings for this
176 1a21a6dd 2021-09-12 stsp remote repository will be ignored.</dd>
177 1a21a6dd 2021-09-12 stsp <dt id="reference"><a class="permalink" href="#reference"><code class="Ic">reference</code></a>
178 1a21a6dd 2021-09-12 stsp {<var class="Ar">reference ...</var>}</dt>
179 1a21a6dd 2021-09-12 stsp <dd>Specify one or more arbitrary references which <code class="Cm">got
180 1a21a6dd 2021-09-12 stsp fetch</code> should fetch by default, in addition to the branches and
181 1a21a6dd 2021-09-12 stsp tags that will be fetched. The list of references specified here can
182 1a21a6dd 2021-09-12 stsp be overridden at the <code class="Cm">got fetch</code> command line
183 1a21a6dd 2021-09-12 stsp with the <code class="Fl">-R</code> option. <code class="Cm">got
184 1a21a6dd 2021-09-12 stsp fetch</code> will refuse to fetch references from the remote
185 1a21a6dd 2021-09-12 stsp repository's &#x201C;refs/remotes/&#x201D; or
186 1a21a6dd 2021-09-12 stsp &#x201C;refs/got/&#x201D; namespace. In any case, references in the
187 1a21a6dd 2021-09-12 stsp &#x201C;refs/tags/&#x201D; namespace will always be fetched and mapped
188 1a21a6dd 2021-09-12 stsp directly to local references in the same namespace.</dd>
189 376d4d52 2022-07-04 stsp <dt id="mirror_references"><a class="permalink" href="#mirror_references"><code class="Ic">mirror_references</code></a>
190 1a21a6dd 2021-09-12 stsp <var class="Ar">yes</var> | <var class="Ar">no</var></dt>
191 1a21a6dd 2021-09-12 stsp <dd>This option controls the behaviour of <code class="Cm">got
192 1a21a6dd 2021-09-12 stsp fetch</code> when updating references.
193 1a21a6dd 2021-09-12 stsp <a class="permalink" href="#Enabling"><b class="Sy" id="Enabling">Enabling
194 1a21a6dd 2021-09-12 stsp this option can lead to the loss of local commits.</b></a> Maintaining
195 1a21a6dd 2021-09-12 stsp custom changes in a mirror repository is therefore discouraged.
196 1a21a6dd 2021-09-12 stsp <p class="Pp">If this option is not specified or set to
197 1a21a6dd 2021-09-12 stsp <var class="Ar">no</var>, <code class="Cm">got fetch</code> will map
198 1a21a6dd 2021-09-12 stsp references of the remote repository into the local repository's
199 1a21a6dd 2021-09-12 stsp &#x201C;refs/remotes/&#x201D; namespace.</p>
200 1a21a6dd 2021-09-12 stsp <p class="Pp">If this option is set to <var class="Ar">yes</var>, all
201 1a21a6dd 2021-09-12 stsp branches in the &#x201C;refs/heads/&#x201D; namespace will be
202 1a21a6dd 2021-09-12 stsp updated directly to match the corresponding branches in the remote
203 1a21a6dd 2021-09-12 stsp repository.</p>
204 1a21a6dd 2021-09-12 stsp </dd>
205 1a21a6dd 2021-09-12 stsp <dt id="fetch"><a class="permalink" href="#fetch"><code class="Ic">fetch</code></a>
206 1a21a6dd 2021-09-12 stsp {...}</dt>
207 1a21a6dd 2021-09-12 stsp <dd>An optional <code class="Ic">fetch</code> block may contain any of the
208 1a21a6dd 2021-09-12 stsp following configuration settings for use by <code class="Cm">got
209 1a21a6dd 2021-09-12 stsp fetch</code>, overriding corresponding settings in the containing
210 1a21a6dd 2021-09-12 stsp <code class="Ic">remote</code> <var class="Ar">name</var> {...} block.
211 1a21a6dd 2021-09-12 stsp <ul class="Bl-bullet">
212 1a21a6dd 2021-09-12 stsp <li id="server~2"><a class="permalink" href="#server~2"><code class="Ic">server</code></a>
213 1a21a6dd 2021-09-12 stsp <var class="Ar">hostname</var></li>
214 1a21a6dd 2021-09-12 stsp <li id="repository~2"><a class="permalink" href="#repository~2"><code class="Ic">repository</code></a>
215 1a21a6dd 2021-09-12 stsp <var class="Ar">path</var></li>
216 1a21a6dd 2021-09-12 stsp <li id="protocol~2"><a class="permalink" href="#protocol~2"><code class="Ic">protocol</code></a>
217 744ec008 2021-09-12 stsp <var class="Ar">scheme</var></li>
218 1a21a6dd 2021-09-12 stsp <li id="port~2"><a class="permalink" href="#port~2"><code class="Ic">port</code></a>
219 1a21a6dd 2021-09-12 stsp <var class="Ar">port</var></li>
220 1a21a6dd 2021-09-12 stsp <li id="branch~2"><a class="permalink" href="#branch~2"><code class="Ic">branch</code></a>
221 1a21a6dd 2021-09-12 stsp {<var class="Ar">branch ...</var>}</li>
222 1a21a6dd 2021-09-12 stsp </ul>
223 1a21a6dd 2021-09-12 stsp </dd>
224 1a21a6dd 2021-09-12 stsp <dt id="send"><a class="permalink" href="#send"><code class="Ic">send</code></a>
225 1a21a6dd 2021-09-12 stsp {...}</dt>
226 1a21a6dd 2021-09-12 stsp <dd>An optional <code class="Ic">send</code> block may contain any of the
227 1a21a6dd 2021-09-12 stsp following configuration settings for use by <code class="Cm">got
228 1a21a6dd 2021-09-12 stsp send</code>, overriding corresponding settings in the containing
229 1a21a6dd 2021-09-12 stsp <code class="Ic">remote</code> <var class="Ar">name</var> {...} block.
230 1a21a6dd 2021-09-12 stsp <ul class="Bl-bullet">
231 1a21a6dd 2021-09-12 stsp <li id="server~3"><a class="permalink" href="#server~3"><code class="Ic">server</code></a>
232 1a21a6dd 2021-09-12 stsp <var class="Ar">hostname</var></li>
233 1a21a6dd 2021-09-12 stsp <li id="repository~3"><a class="permalink" href="#repository~3"><code class="Ic">repository</code></a>
234 1a21a6dd 2021-09-12 stsp <var class="Ar">path</var></li>
235 1a21a6dd 2021-09-12 stsp <li id="protocol~3"><a class="permalink" href="#protocol~3"><code class="Ic">protocol</code></a>
236 744ec008 2021-09-12 stsp <var class="Ar">scheme</var></li>
237 1a21a6dd 2021-09-12 stsp <li id="port~3"><a class="permalink" href="#port~3"><code class="Ic">port</code></a>
238 1a21a6dd 2021-09-12 stsp <var class="Ar">port</var></li>
239 1a21a6dd 2021-09-12 stsp <li id="branch~3"><a class="permalink" href="#branch~3"><code class="Ic">branch</code></a>
240 1a21a6dd 2021-09-12 stsp {<var class="Ar">branch ...</var>}</li>
241 1a21a6dd 2021-09-12 stsp </ul>
242 1a21a6dd 2021-09-12 stsp </dd>
243 1a21a6dd 2021-09-12 stsp </dl>
244 1a21a6dd 2021-09-12 stsp </dd>
245 1a21a6dd 2021-09-12 stsp </dl>
246 1a21a6dd 2021-09-12 stsp </section>
247 1a21a6dd 2021-09-12 stsp <section class="Sh">
248 47f19dd5 2023-01-17 stsp <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
249 47f19dd5 2023-01-17 stsp <dl class="Bl-tag Bl-compact">
250 47f19dd5 2023-01-17 stsp <dt><span class="Pa">got.conf</span></dt>
251 47f19dd5 2023-01-17 stsp <dd>If present, <code class="Nm">got.conf</code> located in the root directory
252 47f19dd5 2023-01-17 stsp of a Git repository supersedes any relevant settings in Git's
253 47f19dd5 2023-01-17 stsp <span class="Pa">config</span> file.
254 47f19dd5 2023-01-17 stsp <p class="Pp"></p>
255 47f19dd5 2023-01-17 stsp </dd>
256 47f19dd5 2023-01-17 stsp <dt><span class="Pa">.got/got.conf</span></dt>
257 47f19dd5 2023-01-17 stsp <dd>If present, <code class="Nm">got.conf</code> located in the
258 47f19dd5 2023-01-17 stsp <span class="Pa">.got</span> meta-data directory of a
259 47f19dd5 2023-01-17 stsp <a class="Xr" aria-label="got, section 1">got(1)</a> work tree supersedes
260 47f19dd5 2023-01-17 stsp any relevant settings in the repository's <code class="Nm">got.conf</code>
261 47f19dd5 2023-01-17 stsp configuration file and Git's <span class="Pa">config</span> file.</dd>
262 47f19dd5 2023-01-17 stsp </dl>
263 47f19dd5 2023-01-17 stsp </section>
264 47f19dd5 2023-01-17 stsp <section class="Sh">
265 63657f42 2022-09-07 stsp <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
266 1a21a6dd 2021-09-12 stsp <p class="Pp">Configure author information:</p>
267 1a21a6dd 2021-09-12 stsp <div class="Bd Pp Bd-indent Li">
268 1a21a6dd 2021-09-12 stsp <pre>author &quot;Flan Hacker &lt;flan_hacker@openbsd.org&gt;&quot;</pre>
269 1a21a6dd 2021-09-12 stsp </div>
270 1a21a6dd 2021-09-12 stsp <p class="Pp">Remote repository specification for the Game of Trees
271 1a21a6dd 2021-09-12 stsp repository:</p>
272 1a21a6dd 2021-09-12 stsp <div class="Bd Pp Bd-indent Li">
273 1a21a6dd 2021-09-12 stsp <pre>remote &quot;origin&quot; {
274 dfc34448 2024-05-06 stsp server anonymous@got.gameoftrees.org
275 dfc34448 2024-05-06 stsp protocol ssh
276 1a21a6dd 2021-09-12 stsp repository got
277 1a21a6dd 2021-09-12 stsp branch { &quot;main&quot; }
278 1a21a6dd 2021-09-12 stsp }</pre>
279 1a21a6dd 2021-09-12 stsp </div>
280 1a21a6dd 2021-09-12 stsp <p class="Pp">Mirror the <span class="Ux">OpenBSD</span> src repository from
281 1a21a6dd 2021-09-12 stsp Github:</p>
282 1a21a6dd 2021-09-12 stsp <div class="Bd Pp Bd-indent Li">
283 1a21a6dd 2021-09-12 stsp <pre>remote &quot;origin&quot; {
284 1a21a6dd 2021-09-12 stsp repository &quot;openbsd/src&quot;
285 1a21a6dd 2021-09-12 stsp server git@github.com
286 1a21a6dd 2021-09-12 stsp protocol git+ssh
287 376d4d52 2022-07-04 stsp mirror_references yes
288 1a21a6dd 2021-09-12 stsp }</pre>
289 1a21a6dd 2021-09-12 stsp </div>
290 1a21a6dd 2021-09-12 stsp <p class="Pp">Fetch changes via the Git protocol and send changes via the SSH
291 1a21a6dd 2021-09-12 stsp protocol:</p>
292 1a21a6dd 2021-09-12 stsp <div class="Bd Pp Bd-indent Li">
293 1a21a6dd 2021-09-12 stsp <pre>remote &quot;origin&quot; {
294 1a21a6dd 2021-09-12 stsp repository my_repo
295 1a21a6dd 2021-09-12 stsp server git.example.com
296 1a21a6dd 2021-09-12 stsp protocol git
297 1a21a6dd 2021-09-12 stsp send {
298 1a21a6dd 2021-09-12 stsp server git@git.example.com
299 1a21a6dd 2021-09-12 stsp protocol ssh
300 1a21a6dd 2021-09-12 stsp }
301 1a21a6dd 2021-09-12 stsp }</pre>
302 1a21a6dd 2021-09-12 stsp </div>
303 1a21a6dd 2021-09-12 stsp </section>
304 1a21a6dd 2021-09-12 stsp <section class="Sh">
305 63657f42 2022-09-07 stsp <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
306 63657f42 2022-09-07 stsp ALSO</a></h2>
307 376d4d52 2022-07-04 stsp <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
308 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repository, section 5">git-repository(5)</a>,
309 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a></p>
310 1a21a6dd 2021-09-12 stsp </section>
311 1a21a6dd 2021-09-12 stsp <section class="Sh">
312 63657f42 2022-09-07 stsp <h2 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h2>
313 1a21a6dd 2021-09-12 stsp <p class="Pp"><code class="Nm">got.conf</code> offers no way to configure the
314 1a21a6dd 2021-09-12 stsp editor spawned by <code class="Cm">got commit</code>, <code class="Cm">got
315 1a21a6dd 2021-09-12 stsp histedit</code>, <code class="Cm">got import</code>, or <code class="Cm">got
316 1a21a6dd 2021-09-12 stsp tag</code>. This is deliberate and prevents potential arbitrary command
317 1a21a6dd 2021-09-12 stsp execution as another user when repositories or work trees are shared between
318 1a21a6dd 2021-09-12 stsp users. Users should set their <code class="Ev">VISUAL</code> or
319 1a21a6dd 2021-09-12 stsp <code class="Ev">EDITOR</code> environment variables instead.</p>
320 1a21a6dd 2021-09-12 stsp </section>
321 63657f42 2022-09-07 stsp </main>
322 63657f42 2022-09-07 stsp <div class="foot" role="doc-pagefooter" aria-label="Manual footer
323 56f3f26e 2024-06-03 stsp line"><span class="foot-left"></span><span class="foot-date">June 3,
324 2b1d45b9 2024-03-11 stsp 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
325 1a21a6dd 2021-09-12 stsp </body>
326 1a21a6dd 2021-09-12 stsp </html>