2 20662ea0 2021-04-10 stsp .\" Copyright (c) 2021 Stefan Sperling
4 20662ea0 2021-04-10 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 20662ea0 2021-04-10 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 20662ea0 2021-04-10 stsp .\" copyright notice and this permission notice appear in all copies.
8 20662ea0 2021-04-10 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 20662ea0 2021-04-10 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 20662ea0 2021-04-10 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 20662ea0 2021-04-10 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 20662ea0 2021-04-10 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 20662ea0 2021-04-10 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 20662ea0 2021-04-10 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 20662ea0 2021-04-10 stsp .Dd $Mdocdate$
17 20662ea0 2021-04-10 stsp .Dt GOTADMIN 1
20 20662ea0 2021-04-10 stsp .Nm gotadmin
21 20662ea0 2021-04-10 stsp .Nd Game of Trees repository administration
22 20662ea0 2021-04-10 stsp .Sh SYNOPSIS
26 20662ea0 2021-04-10 stsp .Op Ar arg ...
27 20662ea0 2021-04-10 stsp .Sh DESCRIPTION
29 20662ea0 2021-04-10 stsp is the repository maintenance tool for the
31 20662ea0 2021-04-10 stsp version control system.
34 20662ea0 2021-04-10 stsp stores the history of tracked files in a Git repository, as used
35 20662ea0 2021-04-10 stsp by the Git version control system.
37 20662ea0 2021-04-10 stsp provides commands for inspecting and manipulating the on-disk state of
38 20662ea0 2021-04-10 stsp Git repositories.
39 20662ea0 2021-04-10 stsp The repository format is described in
40 20662ea0 2021-04-10 stsp .Xr git-repository 5 .
43 20662ea0 2021-04-10 stsp provides global and command-specific options.
44 20662ea0 2021-04-10 stsp Global options must precede the command name, and are as follows:
45 20662ea0 2021-04-10 stsp .Bl -tag -width tenletters
47 20662ea0 2021-04-10 stsp Display usage information and exit immediately.
48 20662ea0 2021-04-10 stsp .It Fl V , -version
49 20662ea0 2021-04-10 stsp Display program version and exit immediately.
52 20662ea0 2021-04-10 stsp The commands for
54 20662ea0 2021-04-10 stsp are as follows:
55 20662ea0 2021-04-10 stsp .Bl -tag -width checkout
56 20662ea0 2021-04-10 stsp .It Cm info Oo Fl r Ar repository-path Oc
57 20662ea0 2021-04-10 stsp Display information about a repository.
58 20662ea0 2021-04-10 stsp This includes some configuration settings from
59 20662ea0 2021-04-10 stsp .Xr got.conf 5 ,
60 20662ea0 2021-04-10 stsp and the number of objects stored in the repository, in packed or
61 20662ea0 2021-04-10 stsp loose form, as well as the current on-disk size of these objects.
63 20662ea0 2021-04-10 stsp The options for
64 20662ea0 2021-04-10 stsp .Cm gotadmin info
65 20662ea0 2021-04-10 stsp are as follows:
66 20662ea0 2021-04-10 stsp .Bl -tag -width Ds
67 20662ea0 2021-04-10 stsp .It Fl r Ar repository-path
68 20662ea0 2021-04-10 stsp Use the repository at the specified path.
69 20662ea0 2021-04-10 stsp If not specified, assume the repository is located at or above the current
70 20662ea0 2021-04-10 stsp working directory.
72 05118f5a 2021-06-22 stsp .It Cm pack Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl x Ar reference Oc Op Ar reference ...
73 05118f5a 2021-06-22 stsp Generate a new pack file and a corresponding pack file index.
74 05118f5a 2021-06-22 stsp By default, add any loose objects which are reachable via any references
75 05118f5a 2021-06-22 stsp to the generated pack file.
77 05118f5a 2021-06-22 stsp If one or more
78 05118f5a 2021-06-22 stsp .Ar reference
79 05118f5a 2021-06-22 stsp arguments is specified, only add objects which are reachable via the specified
82 05118f5a 2021-06-22 stsp .Ar reference
83 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
84 05118f5a 2021-06-22 stsp in which case all references within this namespace will be used.
86 05118f5a 2021-06-22 stsp .Cm gotadmin pack
87 05118f5a 2021-06-22 stsp always ignores references in the
88 05118f5a 2021-06-22 stsp .Pa refs/got/
89 05118f5a 2021-06-22 stsp namespace, effectively treating such references as if they did not refer
90 05118f5a 2021-06-22 stsp to any objects.
92 05118f5a 2021-06-22 stsp The options for
93 05118f5a 2021-06-22 stsp .Cm gotadmin pack
94 05118f5a 2021-06-22 stsp are as follows:
95 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
97 05118f5a 2021-06-22 stsp Add objects to the generated pack file even if they are already packed
98 05118f5a 2021-06-22 stsp in a different pack file.
99 05118f5a 2021-06-22 stsp Unless this option is specified, only loose objects will be added.
100 05118f5a 2021-06-22 stsp .It Fl r Ar repository-path
101 05118f5a 2021-06-22 stsp Use the repository at the specified path.
102 05118f5a 2021-06-22 stsp If not specified, assume the repository is located at or above the current
103 05118f5a 2021-06-22 stsp working directory.
104 05118f5a 2021-06-22 stsp .It Fl x Ar reference
105 05118f5a 2021-06-22 stsp Exclude objects reachable via the specified
106 05118f5a 2021-06-22 stsp .Ar reference
107 05118f5a 2021-06-22 stsp from the pack file.
109 05118f5a 2021-06-22 stsp .Ar reference
110 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
111 05118f5a 2021-06-22 stsp in which case all references within this namespace will be excluded.
114 05118f5a 2021-06-22 stsp option may be specified multiple times to build a list of references to exclude.
116 05118f5a 2021-06-22 stsp Exclusion takes precedence over inclusion.
117 05118f5a 2021-06-22 stsp If a reference appears in both the included and excluded lists, it will
118 05118f5a 2021-06-22 stsp be excluded.
120 05118f5a 2021-06-22 stsp .It Cm indexpack Ar packfile-path
121 05118f5a 2021-06-22 stsp Create a pack index for the pack file at
122 05118f5a 2021-06-22 stsp .Ar packfile-path .
124 05118f5a 2021-06-22 stsp A pack index is required for using the corresponding pack file with
125 05118f5a 2021-06-22 stsp .Xr got 1 .
126 05118f5a 2021-06-22 stsp Usually, a pack index will be created by commands such as
127 05118f5a 2021-06-22 stsp .Cm gotadmin pack
129 05118f5a 2021-06-22 stsp .Cm got fetch
130 05118f5a 2021-06-22 stsp as part of regular operation.
132 05118f5a 2021-06-22 stsp .Cm gotadmin indexpack
133 05118f5a 2021-06-22 stsp command may be used to recover from a corrupt or missing index.
134 05118f5a 2021-06-22 stsp A given pack file will always yield the same bit-identical index.
136 05118f5a 2021-06-22 stsp The provided
137 05118f5a 2021-06-22 stsp .Ar packfile-path
138 05118f5a 2021-06-22 stsp must be located within the
139 05118f5a 2021-06-22 stsp .Pa objects/pack/
140 05118f5a 2021-06-22 stsp directory of the repository and should end in
141 05118f5a 2021-06-22 stsp .Pa .pack .
142 05118f5a 2021-06-22 stsp The filename of the corresponding pack index is equivalent, except
143 05118f5a 2021-06-22 stsp that it ends in
147 05118f5a 2021-06-22 stsp Short alias for
148 05118f5a 2021-06-22 stsp .Cm indexpack .
149 05118f5a 2021-06-22 stsp .It Cm listpack Oo Fl h Oc Oo Fl s Oc Ar packfile-path
150 05118f5a 2021-06-22 stsp List the contents of the pack file at
151 05118f5a 2021-06-22 stsp .Ar packfile-path .
153 05118f5a 2021-06-22 stsp Each object contained in the pack file will be displayed on a single line.
154 05118f5a 2021-06-22 stsp The information shown includes the object ID, object type, object offset,
155 05118f5a 2021-06-22 stsp and object size.
157 05118f5a 2021-06-22 stsp If a packed object is deltified against another object the delta base
158 05118f5a 2021-06-22 stsp will be shown as well.
159 05118f5a 2021-06-22 stsp For offset deltas, the delta base is identified via an offset into the
161 05118f5a 2021-06-22 stsp For reference deltas, the delta base is identified via an object ID.
163 05118f5a 2021-06-22 stsp The provided
164 05118f5a 2021-06-22 stsp .Ar packfile-path
165 05118f5a 2021-06-22 stsp must be located within the
166 05118f5a 2021-06-22 stsp .Pa objects/pack/
167 05118f5a 2021-06-22 stsp directory of the repository and should end in
168 05118f5a 2021-06-22 stsp .Pa .pack .
170 05118f5a 2021-06-22 stsp The options for
171 05118f5a 2021-06-22 stsp .Cm gotadmin listpack
172 05118f5a 2021-06-22 stsp are as follows:
173 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
175 05118f5a 2021-06-22 stsp Show object sizes in human-readable form.
177 05118f5a 2021-06-22 stsp Display statistics about the pack file after listing objects.
178 05118f5a 2021-06-22 stsp This includes the total number of objects stored in the pack file
179 05118f5a 2021-06-22 stsp and a break-down of the number of objects per object type.
182 05118f5a 2021-06-22 stsp Short alias for
183 05118f5a 2021-06-22 stsp .Cm listpack .
185 20662ea0 2021-04-10 stsp .Sh EXIT STATUS
186 20662ea0 2021-04-10 stsp .Ex -std gotadmin
187 20662ea0 2021-04-10 stsp .Sh SEE ALSO
188 20662ea0 2021-04-10 stsp .Xr got 1 ,
189 20662ea0 2021-04-10 stsp .Xr tog 1 ,
190 20662ea0 2021-04-10 stsp .Xr git-repository 5 ,
191 20662ea0 2021-04-10 stsp .Xr got.conf 5
192 20662ea0 2021-04-10 stsp .Sh AUTHORS
193 20662ea0 2021-04-10 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
194 05118f5a 2021-06-22 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
