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.
22 .Nd version control system
30 is a version control system which prioritizes ease of use and simplicity
34 stores the history of tracked files in a repository which uses
35 the same on-disk format as
37 repositories used by the Git version control system.
38 This repository format is described in
39 .Xr git-repository 5 .
44 version control system because every copy of a repository is writeable.
45 Modifications made to files can be synchronized between repositories
50 must be checked out from the repository for modification.
51 Checked out files are stored in a
53 which can be placed at an arbitrary directory in the filesystem hierarchy.
54 The on-disk format of a
56 work tree is described in
60 provides global and command-specific options.
61 Global options must preceed the command name, and are as follows:
62 .Bl -tag -width tenletters
64 Display usage information.
70 .Bl -tag -width checkout
71 .It Cm checkout [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
72 Copy files from a repository into a new work tree.
75 is not specified, either use the base name of the
79 was specified use the base name of the
87 Check out files from the specified
89 By default, the HEAD commit is used.
90 .It Fl p Ar path-prefix
91 Restrict the work tree to a subset of the repository's tree hierarchy.
92 Only files beneath the specified
96 .It Cm update [ Fl c Ar commit ] [ work-tree-path ]
97 Update an existing work tree to another commit on the current branch.
98 By default, the latest commit on the current branch is assumed.
101 is omitted, use the current working directory.
108 Update the work tree to the specified
110 The expected argument is a SHA1 hash which corresponds to a commit object.
112 .It Cm status [ Ar worktree-path ]
113 Show the current modification status of files in a worktree,
114 using the following status codes:
115 .Bl -column YXZ description
116 .It M Ta modified file
117 .It ! Ta versioned file was expected on disk but is missing
118 .It ~ Ta versioned file is obstructed by a non-regular file
119 .It ? Ta unversioned item not tracked by
125 is omitted, use the current working directory.
126 .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 ]
127 Display history of a repository.
130 is specified, show only commits which modified this path.
137 Start traversing history at the specified
139 The expected argument is the name of a branch or a SHA1 hash which corresponds
142 Set the number of context lines shown in diffs with
144 By default, 3 lines of context are shown.
146 Restrict history traversal to the first parent of each commit.
147 This shows the linear history of the current branch only.
148 Merge commits which affected the current branch will be shown but
149 individual commits which originated on other branches will be omitted.
151 Limit history traversal to a given number of commits.
153 Display the patch of modifications made in each commit.
154 .It Fl r Ar repository-path
155 Use the repository at the specified path.
156 If not specified, assume the repository is located at or above the current
159 .It Cm diff [ Fl C Ar number ] [ Ar repository-path ] Ar object1 Ar object2
160 Display the differences between two objects in the repository.
163 argument is a SHA1 hash which corresponds to the object.
164 Both objects must be of the same type (blobs, trees, or commits).
167 is omitted, use the current working directory.
174 Set the number of context lines shown in the diff.
175 By default, 3 lines of context are shown.
177 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
178 Display line-by-line history of a file at the specified path.
185 Start traversing history at the specified
187 The expected argument is the name of a branch or a SHA1 hash which corresponds
189 .It Fl r Ar repository-path
190 Use the repository at the specified path.
191 If not specified, assume the repository is located at or above the current
194 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
195 Display a listing of files and directories at the specified
196 directory path in the repository.
199 is specified, list the repository path corresponding to the current
200 directory of the work tree, or the root directory of the repository
201 if there is no work tree.
208 List files and directories as they appear in the specified
210 The expected argument is the name of a branch or a SHA1 hash which corresponds
212 .It Fl r Ar repository-path
213 Use the repository at the specified path.
214 If not specified, assume the repository is located at or above the current
216 If this directory is a
218 work tree, use the repository path associated with this work tree.
220 Show object IDs of files (blob objects) and directories (tree objects).
222 Recurse into sub-directories in the repository.
227 Check out a work tree of
229 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
231 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
236 .An Stefan Sperling Aq Mt stsp@openbsd.org
237 .An Martin Pieuchot Aq Mt mpi@openbsd.org