2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must preceed the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information.
62 .Bl -tag -width checkout
63 .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
64 Copy files from a repository into a new work tree.
67 is not specified, either use the last component of
71 was specified use the last component of
79 Check out files from the specified
81 If this option is not specified, a branch resolved via the repository's HEAD
82 reference will be used.
84 Check out files from the specified
86 If this option is not specified, the most recent commit on the selected
88 .It Fl p Ar path-prefix
89 Restrict the work tree to a subset of the repository's tree hierarchy.
90 Only files beneath the specified
94 .It Cm update [ Fl c Ar commit ] [ Ar path ]
95 Update an existing work tree to another commit on the current branch.
96 By default, the latest commit on the current branch is assumed.
97 Show the status of each affected file, using the following status codes:
98 .Bl -column YXZ description
99 .It U Ta file was updated and contained no local changes
100 .It G Ta file was updated and local changes were merged cleanly
101 .It C Ta file was updated and conflicts occurred during merge
102 .It D Ta file was deleted
103 .It A Ta new file was added
104 .It ~ Ta versioned file is obstructed by a non-regular file
105 .It ! Ta a missing versioned file was restored
110 is specified, restrict the update operation to files at or within this path.
111 The path is required to exist in the update operation's target commit.
112 Files in the work tree outside this path will remain unchanged and will
113 retain their previously recorded base commit.
116 commands may refuse to run while the work tree contains files from
117 multiple base commits.
118 The base commit of such a work tree can be made consistent by running
120 across the entire work tree.
127 Update the work tree to the specified
129 The expected argument is a SHA1 hash which corresponds to a commit object.
131 .It Cm status [ Ar path ]
132 Show the current modification status of files in a work tree,
133 using the following status codes:
134 .Bl -column YXZ description
135 .It M Ta modified file
136 .It A Ta file scheduled for addition in next commit
137 .It D Ta file scheduled for deletion in next commit
138 .It C Ta modified or added file which contains merge conflicts
139 .It ! Ta versioned file was expected on disk but is missing
140 .It ~ Ta versioned file is obstructed by a non-regular file
141 .It ? Ta unversioned item not tracked by
147 is specified, only show modifications within this path.
148 .It Cm log [ Fl c Ar commit ] [ Fl C Ar number ] [ Fl f ] [ Fl l Ar N ] [ Fl p ] [ Fl r Ar repository-path ] [ path ]
149 Display history of a repository.
152 is specified, show only commits which modified this path.
159 Start traversing history at the specified
161 The expected argument is the name of a branch or a SHA1 hash which corresponds
164 Set the number of context lines shown in diffs with
166 By default, 3 lines of context are shown.
168 Restrict history traversal to the first parent of each commit.
169 This shows the linear history of the current branch only.
170 Merge commits which affected the current branch will be shown but
171 individual commits which originated on other branches will be omitted.
173 Limit history traversal to a given number of commits.
175 Display the patch of modifications made in each commit.
176 .It Fl r Ar repository-path
177 Use the repository at the specified path.
178 If not specified, assume the repository is located at or above the current
180 If this directory is a
182 work tree, use the repository path associated with this work tree.
184 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
185 When invoked within a work tree with less than two arguments, display
186 uncommitted changes in the work tree.
189 is specified, only show changes within this path.
191 If two arguments are provided, treat each argument as a SHA1 hash which
192 corresponds to an object in the repository, and display differences
193 between these objects.
194 Both objects must be of the same type (blobs, trees, or commits).
201 Set the number of context lines shown in the diff.
202 By default, 3 lines of context are shown.
203 .It Fl r Ar repository-path
204 Use the repository at the specified path.
205 If not specified, assume the repository is located at or above the current
207 If this directory is a
209 work tree, use the repository path associated with this work tree.
211 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
212 Display line-by-line history of a file at the specified path.
219 Start traversing history at the specified
221 The expected argument is the name of a branch or a SHA1 hash which corresponds
223 .It Fl r Ar repository-path
224 Use the repository at the specified path.
225 If not specified, assume the repository is located at or above the current
227 If this directory is a
229 work tree, use the repository path associated with this work tree.
231 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
232 Display a listing of files and directories at the specified
233 directory path in the repository.
234 Entries shown in this listing may carry one of the following trailing
236 .Bl -column YXZ description
237 .It / Ta entry is a directory
238 .It * Ta entry is an executable file
243 is specified, list the repository path corresponding to the current
244 directory of the work tree, or the root directory of the repository
245 if there is no work tree.
252 List files and directories as they appear in the specified
254 The expected argument is the name of a branch or a SHA1 hash which corresponds
256 .It Fl r Ar repository-path
257 Use the repository at the specified path.
258 If not specified, assume the repository is located at or above the current
260 If this directory is a
262 work tree, use the repository path associated with this work tree.
264 Show object IDs of files (blob objects) and directories (tree objects).
266 Recurse into sub-directories in the repository.
268 .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
269 Manage references in a repository.
271 If no options are passed, expect two arguments and attempt to create,
272 or update, the reference with the given
274 and make it point at the given
276 The target may be a SHA1 hash which corresponds to an existing object ID
277 in the repository, or an existing reference which will be resolved to an
284 .It Fl r Ar repository-path
285 Use the repository at the specified path.
286 If not specified, assume the repository is located at or above the current
288 If this directory is a
290 work tree, use the repository path associated with this work tree.
292 List all existing references in the repository.
294 Delete the reference with the specified name from the repository.
296 .It Cm add Ar file-path ...
297 Schedule unversioned files in a work tree for addition to the
298 repository in the next commit.
299 .It Cm rm Ar file-path
300 Remove a versioned file from a work tree and schedule it for deletion
301 from the repository in the next commit.
308 Perform the operation even if the file contains uncommitted modifications.
310 .It Cm revert Ar file-path
311 Revert any uncommited changes in the file at the specified path.
312 File contents will be overwritten with those contained in the
313 work tree's base commit. There is no way to bring discarded
317 If the file was added with
319 it will become an unversioned file again.
320 If the file was deleted with
323 .It Cm commit [ Fl m Ar msg ] [ file-path ]
324 Create a new commit in the repository from local changes in a work tree
325 and use this commit as the new base commit for the work tree.
327 Show the status of each affected file, using the following status codes:
328 .Bl -column YXZ description
329 .It M Ta modified file
330 .It D Ta file was deleted
331 .It A Ta new file was added
334 Files without local changes will retain their previously recorded base
338 commands may refuse to run while the work tree contains files from
339 multiple base commits.
340 The base commit of such a work tree can be made consistent by running
342 across the entire work tree.
348 environment variable to be set.
355 Use the specified log message when creating the new commit.
360 opens a temporary file in an editor where a log message can be written.
364 .Bl -tag -width GOT_AUTHOR
366 The author's name and email address for
369 .An Stefan Sperling Aq Mt stsp@openbsd.org
370 .It Ev VISUAL, Ev EDITOR
371 The editor spawned by
377 Check out a work tree of
379 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
381 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
385 which is forked off the
389 .Dl $ got ref refs/heads/mybranch refs/heads/master
394 .An Stefan Sperling Aq Mt stsp@openbsd.org
395 .An Martin Pieuchot Aq Mt mpi@openbsd.org
