1 .\"
2 .\" Copyright (c) 2020 Stefan Sperling <stsp@openbsd.org>
3 .\"
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.
7 .\"
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.
15 .\"
16 .Dd $Mdocdate$
17 .Dt GOT.CONF 5
18 .Os
19 .Sh NAME
20 .Nm got.conf
21 .Nd Game of Trees configuration file
22 .Sh DESCRIPTION
23 .Nm
24 is the run-time configuration file for
25 .Xr got 1 .
26 .Pp
27 .Nm
28 may be present in the root directory of a Git repository for
29 repository-wide settings, or in the
30 .Pa .got
31 meta-data directory of a work tree to override repository-wide
32 settings for
33 .Xr got 1
34 commands executed within this work tree.
35 .Pp
36 The file format is line-based, with one configuration directive per line.
37 Any lines beginning with a
38 .Sq #
39 are treated as comments and ignored.
40 .Pp
41 The available configuration directives are as follows:
42 .Bl -tag -width Ds
43 .It Ic author Dq Real Name <email address>
44 Configure the author's name and email address for
45 .Cm got commit
46 and
47 .Cm got import
48 when operating on this repository.
49 Author information specified here overrides the
50 .Ev GOT_AUTHOR
51 environment variable.
52 .Pp
53 Because
54 .Xr git 1
55 may fail to parse commits without an email address in author data,
56 .Xr got 1
57 attempts to reject author information with a missing email address.
58 .It Ic remote Ar name Brq ...
59 Define a remote repository.
60 The specified
61 .Ar name
62 can be used to refer to the remote repository on the command line of
63 .Cm got fetch .
64 .Pp
65 Information about this repository is declared in a block of options
66 enclosed in curly brackets:
67 .Bl -tag -width Ds
68 .It Ic server Ar hostname
69 Defines the hostname to use for contacting the remote repository's server.
70 .It Ic repository Ar path
71 Defines the path to the repository on the remote repository's server.
72 .It Ic protocol Ar scheme
73 Defines the protocol to use for communicating with the remote repository's
74 server.
75 .Pp
76 The following protocol schemes are supported:
77 .Bl -tag -width git+ssh
78 .It git
79 The Git protocol as implemented by the
80 .Xr git-daemon 1
81 server.
82 Use of this protocol is discouraged since it supports neither authentication
83 nor encryption.
84 .It git+ssh
85 The Git protocol wrapped in an authenticated and encrypted
86 .Xr ssh 1
87 tunnel.
88 With this protocol the hostname may contain an embedded username for
89 .Xr ssh 1
90 to use:
91 .Mt user@hostname
92 .It ssh
93 Short alias for git+ssh.
94 .El
95 .It Ic port Ar port
96 Defines the port to use for connecting to the remote repository's server.
97 The
98 .Ar port
99 can be specified by number or name.
100 The port name to number mappings are found in the file
101 .Pa /etc/services ;
102 see
103 .Xr services 5
104 for details.
105 If not specified, the default port of the specified
106 .Cm protocol
107 will be used.
108 .It Ic branch Brq Ar branch ...
109 Specify one or more branches which
110 .Cm got fetch
111 should fetch from the remote repository by default.
112 The list of branches specified here can be overridden at the
113 .Cm got fetch
114 command line with the
115 .Fl b
116 option.
117 .It Ic mirror-references Ar yes | no
118 This option controls the behaviour of
119 .Cm got fetch
120 when updating references.
121 .Sy Enabling this option can lead to the loss of local commits.
122 Maintaining custom changes in a mirror repository is therefore discouraged.
123 .Pp
124 If this option is not specified or set to
125 .Ar no ,
126 .Cm got fetch
127 will map references of the remote repository into the local repository's
128 .Dq refs/remotes/
129 namespace.
130 .Pp
131 If this option is set to
132 .Ar yes ,
133 all branches in the
134 .Dq refs/heads/
135 namespace will be updated directly to match the corresponding branches in
136 the remote repository.
137 .El
138 .Sh EXAMPLES
139 Configure author information:
140 .Bd -literal -offset indent
141 author "Flan Hacker <flan_hacker@openbsd.org>"
142 .Ed
143 .Pp
144 Remote repository specification for the Game of Trees repository:
145 .Bd -literal -offset indent
146 remote "origin" {
147 	server git.gameoftrees.org
148 	protocol git
149 	repository got
150 	branch { "main" }
151 }
152 .Ed
153 .Pp
154 Mirror the OpenBSD src repository from Github:
155 .Bd -literal -offset indent
156 remote "origin" {
157 	repository "openbsd/src"
158 	server git@github.com
159 	protocol git+ssh
160 	mirror-references yes
161 }
162 .Ed
163 .Sh FILES
164 .Bl -tag -width Ds -compact
165 .It Pa got.conf
166 If present,
167 .Nm
168 located in the root directory of a Git repository supersedes any relevant
169 settings in Git's
170 .Pa config
171 file.
172 .Pp
173 .It Pa .got/got.conf
174 If present,
175 .Nm
176 located in the
177 .Pa .got
178 meta-data directory of a
179 .Xr got 1
180 work tree supersedes any relevant settings in the repository's
181 .Nm
182 configuration file and Git's
183 .Pa config
184 file.
185 .El
186 .Sh SEE ALSO
187 .Xr got 1 ,
188 .Xr git-repository 5 ,
189 .Xr got-worktree 5
190 .Sh CAVEATS
191 .Nm
192 offers no way to configure the editor spawned by
193 .Cm got commit ,
194 .Cm got histedit ,
195 .Cm got import ,
196 or
197 .Cm got tag .
198 This is deliberate and prevents potential arbitrary command execution
199 as another user when repositories or work trees are shared between users.
200 Users should set their
201 .Ev VISUAL
202 or
203 .Ev EDITOR
204 environment variables instead.
205