2 257add31 2020-09-09 stsp .\" Copyright (c) 2020 Stefan Sperling <stsp@openbsd.org>
4 257add31 2020-09-09 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 257add31 2020-09-09 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 257add31 2020-09-09 stsp .\" copyright notice and this permission notice appear in all copies.
8 257add31 2020-09-09 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 257add31 2020-09-09 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 257add31 2020-09-09 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 257add31 2020-09-09 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 257add31 2020-09-09 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 257add31 2020-09-09 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 257add31 2020-09-09 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 257add31 2020-09-09 stsp .Dd $Mdocdate$
17 257add31 2020-09-09 stsp .Dt GOT.CONF 5
20 257add31 2020-09-09 stsp .Nm got.conf
21 257add31 2020-09-09 stsp .Nd Game of Trees configuration file
22 257add31 2020-09-09 stsp .Sh DESCRIPTION
24 257add31 2020-09-09 stsp is the run-time configuration file for
27 257add31 2020-09-09 stsp The file format is line-based, with one configuration directive per line.
28 257add31 2020-09-09 stsp Any lines beginning with a
30 257add31 2020-09-09 stsp are treated as comments and ignored.
32 257add31 2020-09-09 stsp The available configuration directives are as follows:
33 257add31 2020-09-09 stsp .Bl -tag -width Ds
34 257add31 2020-09-09 stsp .It Ic author Dq Real Name <email address>
35 257add31 2020-09-09 stsp Configure the author's name and email address for
36 257add31 2020-09-09 stsp .Cm got commit
38 257add31 2020-09-09 stsp .Cm got import
39 257add31 2020-09-09 stsp when operating on this repository.
40 257add31 2020-09-09 stsp Author information specified here overrides the
41 257add31 2020-09-09 stsp .Ev GOT_AUTHOR
42 257add31 2020-09-09 stsp environment variable.
46 257add31 2020-09-09 stsp may fail to parse commits without an email address in author data,
48 257add31 2020-09-09 stsp attempts to reject author information with a missing email address.
49 257add31 2020-09-09 stsp .It Ic remote Ar name Brq ...
50 257add31 2020-09-09 stsp Define a remote repository.
51 257add31 2020-09-09 stsp The specified
53 257add31 2020-09-09 stsp can be used to refer to the remote repository on the command line of
54 257add31 2020-09-09 stsp .Cm got fetch .
56 257add31 2020-09-09 stsp Information about this repository is declared in a block of options
57 257add31 2020-09-09 stsp enclosed in curly brackets:
58 257add31 2020-09-09 stsp .Bl -tag -width Ds
59 257add31 2020-09-09 stsp .It Ic server Ar hostname
60 257add31 2020-09-09 stsp Defines the hostname to use for contacting the remote repository's server.
61 257add31 2020-09-09 stsp .It Ic repository Ar path
62 257add31 2020-09-09 stsp Defines the path to the repository on the remote repository's server.
63 257add31 2020-09-09 stsp .It Ic protocol Ar scheme
64 257add31 2020-09-09 stsp Defines the protocol to use for communicating with the remote repository's
67 257add31 2020-09-09 stsp The following protocol schemes are supported:
68 257add31 2020-09-09 stsp .Bl -tag -width git+ssh
70 257add31 2020-09-09 stsp The Git protocol as implemented by the
71 257add31 2020-09-09 stsp .Xr git-daemon 1
73 257add31 2020-09-09 stsp Use of this protocol is discouraged since it supports neither authentication
74 257add31 2020-09-09 stsp nor encryption.
76 257add31 2020-09-09 stsp The Git protocol wrapped in an authenticated and encrypted
79 257add31 2020-09-09 stsp With this protocol the hostname may contain an embedded username for
82 257add31 2020-09-09 stsp .Mt user@hostname
84 257add31 2020-09-09 stsp Short alias for git+ssh.
86 257add31 2020-09-09 stsp .It Ic port Ar port
87 257add31 2020-09-09 stsp Defines the port to use for connecting to the remote repository's server.
90 257add31 2020-09-09 stsp can be specified by number or name.
91 257add31 2020-09-09 stsp The port name to number mappings are found in the file
92 257add31 2020-09-09 stsp .Pa /etc/services ;
94 257add31 2020-09-09 stsp .Xr services 5
95 257add31 2020-09-09 stsp for details.
96 257add31 2020-09-09 stsp If not specified, the default port of the specified
97 257add31 2020-09-09 stsp .Cm protocol
98 257add31 2020-09-09 stsp will be used.
99 257add31 2020-09-09 stsp .It Ic mirror-references Ar yes | no
100 257add31 2020-09-09 stsp This option controls the behaviour of
101 257add31 2020-09-09 stsp .Cm got fetch
102 257add31 2020-09-09 stsp when updating references.
103 257add31 2020-09-09 stsp .Sy Enabling this option can lead to the loss of local commits.
104 257add31 2020-09-09 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
106 257add31 2020-09-09 stsp If this option is not specified or set to
108 257add31 2020-09-09 stsp .Cm got fetch
109 257add31 2020-09-09 stsp will map references of the remote repository into the local repository's
110 257add31 2020-09-09 stsp .Dq refs/remotes/
113 257add31 2020-09-09 stsp If this option is set to
115 257add31 2020-09-09 stsp all branches in the
116 257add31 2020-09-09 stsp .Dq refs/heads/
117 257add31 2020-09-09 stsp namespace will be updated directly to match the corresponding branches in
118 257add31 2020-09-09 stsp the remote repository.
120 257add31 2020-09-09 stsp .Sh EXAMPLES
121 257add31 2020-09-09 stsp Configure author information:
122 257add31 2020-09-09 stsp .Bd -literal -offset indent
123 257add31 2020-09-09 stsp author "Flan Hacker <flan_hacker@openbsd.org>"
126 257add31 2020-09-09 stsp Remote repository specification for the Game of Trees repository:
127 257add31 2020-09-09 stsp .Bd -literal -offset indent
128 257add31 2020-09-09 stsp remote "origin" {
129 257add31 2020-09-09 stsp server git.gameoftrees.org
130 257add31 2020-09-09 stsp protocol git
131 257add31 2020-09-09 stsp repository got
135 257add31 2020-09-09 stsp Mirror the OpenBSD src repository from Github:
136 257add31 2020-09-09 stsp .Bd -literal -offset indent
137 257add31 2020-09-09 stsp remote "origin" {
138 257add31 2020-09-09 stsp repository "openbsd/src"
139 257add31 2020-09-09 stsp server git@github.com
140 257add31 2020-09-09 stsp protocol git+ssh
141 257add31 2020-09-09 stsp mirror-references yes
145 257add31 2020-09-09 stsp .Bl -tag -width Ds -compact
146 257add31 2020-09-09 stsp .It Pa got.conf
147 257add31 2020-09-09 stsp If present, the
149 257add31 2020-09-09 stsp configuration file is located in the root directory of a Git repository
150 257add31 2020-09-09 stsp and supersedes any relevant settings in Git's
154 257add31 2020-09-09 stsp .Sh SEE ALSO
155 257add31 2020-09-09 stsp .Xr got 1 ,
156 257add31 2020-09-09 stsp .Xr git-repository 5
