2 .\" Copyright (c) 2020 Stefan Sperling <stsp@openbsd.org>
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd Game of Trees configuration file
24 is the run-time configuration file for
28 may be present in the root directory of a Git repository for
29 repository-wide settings, or in the
31 meta-data directory of a work tree to override repository-wide
34 commands executed within this work tree.
36 The file format is line-based, with one configuration directive per line.
37 Any lines beginning with a
39 are treated as comments and ignored.
41 The available configuration directives are as follows:
43 .It Ic author Dq Real Name <email address>
44 Configure the author's name and email address for
48 when operating on this repository.
49 Author information specified here overrides the
55 may fail to parse commits without an email address in author data,
57 attempts to reject author information with a missing email address.
58 .It Ic signer_id Pa signer-id
62 This key will be used to sign all tag objects unless overridden by
63 .Cm got tag Fl s Ar signer-id .
65 For SSH-based signatures,
67 is the path to a file which may refer to either a private SSH key,
68 or a public SSH key with the private half available via
70 .It Ic allowed_signers Pa path
73 to the "allowed signers" file which contains a list of trusted
74 SSH signer identities.
75 The file will be passed to
77 during verification of SSH-based signatures with
79 The format of the "allowed signers" file is documented in the
80 ALLOWED SIGNERS section of
83 Verification of SSH-based signatures is impossible unless the
87 .It Ic revoked_signers Pa path
90 to the optional "revoked signers" file, which contains a list of revoked
91 SSH signer identities.
92 This file is passed to
94 during signature verification with
96 Revoked identities are no longer considered trustworthy and verification
97 of relevant signatures will fail.
98 .It Ic remote Ar name Brq ...
99 Define a remote repository.
102 can be used to refer to the remote repository on the command line of
107 Information about this repository is declared in a block of options
108 enclosed in curly brackets:
110 .It Ic server Ar hostname
111 Defines the hostname to use for contacting the remote repository's server.
112 .It Ic repository Ar path
113 Defines the path to the repository on the remote repository's server.
114 .It Ic protocol Ar scheme
115 Defines the protocol to use for communicating with the remote repository's
118 The following protocol schemes are supported:
119 .Bl -tag -width git+ssh
121 The Git protocol as implemented by the
124 Use of this protocol is discouraged since it supports neither authentication
127 The Git protocol wrapped in an authenticated and encrypted
130 With this protocol the hostname may contain an embedded username for
135 Short alias for git+ssh.
138 Defines the port to use for connecting to the remote repository's server.
141 can be specified by number or name.
142 The port name to number mappings are found in the file
147 If not specified, the default port of the specified
150 .It Ic branch Brq Ar branch ...
151 Specify one or more branches which
155 should fetch from and send to the remote repository by default.
156 The list of branches specified here can be overridden at the
160 command lines with the
163 .It Ic fetch_all_branches Ar yes | no
164 This option controls whether
166 will fetch all branches from the remote repository by default.
167 If enabled, this behaviour can be overridden at the
169 command line with the
173 configuration settings for this remote repository will be ignored.
174 .It Ic reference Brq Ar reference ...
175 Specify one or more arbitrary references which
177 should fetch by default, in addition to the branches and tags that will
179 The list of references specified here can be overridden at the
181 command line with the
185 will refuse to fetch references from the remote repository's
190 In any case, references in the
192 namespace will always be fetched and mapped directly to local references
193 in the same namespace.
194 .It Ic mirror_references Ar yes | no
195 This option controls the behaviour of
197 when updating references.
198 .Sy Enabling this option can lead to the loss of local commits.
199 Maintaining custom changes in a mirror repository is therefore discouraged.
201 If this option is not specified or set to
204 will map references of the remote repository into the local repository's
208 If this option is set to
212 namespace will be updated directly to match the corresponding branches in
213 the remote repository.
217 block may contain any of the following configuration settings
220 overriding corresponding settings in the containing
221 .Ic remote Ar name Brq ...
225 .Ic server Ar hostname
227 .Ic repository Ar path
229 .Ic protocol Ar scheme
233 .Ic branch Brq Ar branch ...
238 block may contain any of the following configuration settings
241 overriding corresponding settings in the containing
242 .Ic remote Ar name Brq ...
246 .Ic server Ar hostname
248 .Ic repository Ar path
250 .Ic protocol Ar scheme
254 .Ic branch Brq Ar branch ...
259 Configure author information:
260 .Bd -literal -offset indent
261 author "Flan Hacker <flan_hacker@openbsd.org>"
264 Remote repository specification for the Game of Trees repository:
265 .Bd -literal -offset indent
267 server git.gameoftrees.org
276 src repository from Github:
277 .Bd -literal -offset indent
279 repository "openbsd/src"
280 server git@github.com
282 mirror_references yes
286 Fetch changes via the Git protocol and send changes via the SSH protocol:
287 .Bd -literal -offset indent
290 server git.example.com
293 server git@git.example.com
299 .Bl -tag -width Ds -compact
303 located in the root directory of a Git repository supersedes any relevant
313 meta-data directory of a
315 work tree supersedes any relevant settings in the repository's
317 configuration file and Git's
323 .Xr git-repository 5 ,
327 offers no way to configure the editor spawned by
333 This is deliberate and prevents potential arbitrary command execution
334 as another user when repositories or work trees are shared between users.
335 Users should set their
339 environment variables instead.
