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.
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 the name of a branch or a SHA1 hash which corresponds
114 .\"Show current status of files.
115 .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 ]
116 Display history of a repository.
119 is specified, show only commits which modified this path.
126 Start traversing history at the specified
128 The expected argument is the name of a branch or a SHA1 hash which corresponds
131 Set the number of context lines shown in diffs with
133 By default, 3 lines of context are shown.
135 Restrict history traversal to the first parent of each commit.
136 This shows the linear history of the current branch only.
137 Merge commits which affected the current branch will be shown but
138 individual commits which originated on other branches will be omitted.
140 Limit history traversal to a given number of commits.
142 Display the patch of modifications made in each commit.
143 .It Fl r Ar repository-path
144 Use the repository at the specified path.
145 If not specified, assume the repository is located at or above the current
148 .It Cm diff [ Fl C Ar number ] [ Ar repository-path ] Ar object1 Ar object2
149 Display the differences between two objects in the repository.
152 argument is a SHA1 hash which corresponds to the object.
153 Both objects must be of the same type (blobs, trees, or commits).
156 is omitted, use the current working directory.
163 Set the number of context lines shown in the diff.
164 By default, 3 lines of context are shown.
166 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
167 Display line-by-line history of a file at the specified path.
174 Start traversing history at the specified
176 The expected argument is the name of a branch or a SHA1 hash which corresponds
178 .It Fl r Ar repository-path
179 Use the repository at the specified path.
180 If not specified, assume the repository is located at or above the current
183 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
184 Display a listing of files and directories at the specified
185 directory path in the repository.
186 If no path is specified, the root directory is listed.
193 List files and directories as they appear in the specified
195 The expected argument is the name of a branch or a SHA1 hash which corresponds
197 .It Fl r Ar repository-path
198 Use the repository at the specified path.
199 If not specified, assume the repository is located at or above the current
202 Show object IDs of files (blob objects) and directories (tree objects).
204 Recurse into sub-directories.
209 Check out a work tree of
211 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
213 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
218 .An Stefan Sperling Aq Mt stsp@openbsd.org
219 .An Martin Pieuchot Aq Mt mpi@openbsd.org