2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018 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 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
86 .It Fl p Ar path-prefix
87 Restrict the work tree to a subset of the repository's tree hierarchy.
88 Only files beneath the specified
92 .It Cm update [ Fl c Ar commit ] [ work-tree-path ]
93 Update an existing work tree to another commit.
94 By default, the latest commit on the current branch is assumed.
97 is omitted, use the current working directory.
104 Update the work tree to the specified
106 The expected argument is the name of a branch or a SHA1 hash which corresponds
110 .\"Show current status of files.
111 .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 ]
112 Display history of a repository.
115 is specified, show only commits which modified this path.
122 Start traversing history at the specified
124 The expected argument is the name of a branch or a SHA1 hash which corresponds
127 Set the number of context lines shown in diffs with
129 By default, 3 lines of context are shown.
131 Restrict history traversal to the first parent of each commit.
132 This shows the linear history of the current branch only.
133 Merge commits which affected the current branch will be shown but
134 individual commits which originated on other branches will be omitted.
136 Limit history traversal to a given number of commits.
138 Display the patch of modifications made in each commit.
139 .It Fl r Ar repository-path
140 Use the repository at the specified path.
141 If not specified, assume the repository is located at or above the current
144 .It Cm diff [ Fl C Ar number ] [ Ar repository-path ] Ar object1 Ar object2
145 Display the differences between two objects in the repository.
148 argument is a SHA1 hash which corresponds to the object.
149 Both objects must be of the same type (blobs, trees, or commits).
152 is omitted, use the current working directory.
159 Set the number of context lines shown in the diff.
160 By default, 3 lines of context are shown.
162 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
163 Display line-by-line history of a file at the specified path.
170 Start traversing history at the specified
172 The expected argument is the name of a branch or a SHA1 hash which corresponds
174 .It Fl r Ar repository-path
175 Use the repository at the specified path.
176 If not specified, assume the repository is located at or above the current
179 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Ar path ]
180 Display a listing of files and directories at the specified
181 directory path in the repository.
182 If no path is specified, the root directory is listed.
189 List files and directories as they appear in the specified
191 The expected argument is the name of a branch or a SHA1 hash which corresponds
193 .It Fl r Ar repository-path
194 Use the repository at the specified path.
195 If not specified, assume the repository is located at or above the current
198 Show object IDs of files (blob objects) and directories (tree objects).
203 Check out a work tree of
205 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
207 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
212 .An Stefan Sperling Aq Mt stsp@openbsd.org
213 .An Martin Pieuchot Aq Mt mpi@openbsd.org