1 .\"
2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019 Stefan Sperling
4 .\"
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.
8 .\"
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.
16 .\"
17 .Dd $Mdocdate$
18 .Dt GOT 1
19 .Os
20 .Sh NAME
21 .Nm got
22 .Nd version control system
23 .Sh SYNOPSIS
24 .Nm
25 .Ar command
26 .Op Fl h
27 .Op Ar arg ...
28 .Sh DESCRIPTION
29 .Nm
30 is a version control system which prioritizes ease of use and simplicity
31 over flexibility.
32 .Pp
33 .Nm
34 stores the history of tracked files in a repository which uses
35 the same on-disk format as
36 .Dq bare
37 repositories used by the Git version control system.
38 This repository format is described in
39 .Xr git-repository 5 .
40 .Pp
41 .Nm
42 is a
43 .Em distributed
44 version control system because every copy of a repository is writeable.
45 Modifications made to files can be synchronized between repositories
46 at any time.
47 .Pp
48 Files managed by
49 .Nm
50 must be checked out from the repository for modification.
51 Checked out files are stored in a
52 .Em work tree
53 which can be placed at an arbitrary directory in the filesystem hierarchy.
54 The on-disk format of a
55 .Nm
56 work tree is described in
57 .Xr got-worktree 5 .
58 .Pp
59 .Nm
60 provides global and command-specific options.
61 Global options must preceed the command name, and are as follows:
62 .Bl -tag -width tenletters
63 .It Fl h
64 Display usage information.
65 .El
66 .Pp
67 The commands for
68 .Nm
69 are as follows:
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.
73 If the
74 .Ar work tree path
75 is not specified, either use the last component of
76 .Ar repository path ,
77 or if a
78 .Ar path prefix
79 was specified use the last component of
80 .Ar path prefix .
81 .Pp
82 The options for
83 .Cm got checkout
84 are as follows:
85 .Bl -tag -width Ds
86 .It Fl c Ar commit
87 Check out files from the specified
88 .Ar commit .
89 If this option is not specified, a commit resolved via the repository's HEAD
90 reference will be used.
91 .It Fl p Ar path-prefix
92 Restrict the work tree to a subset of the repository's tree hierarchy.
93 Only files beneath the specified
94 .Ar path-prefix
95 will be checked out.
96 .El
97 .It Cm update [ Fl c Ar commit ] [ work-tree-path ]
98 Update an existing work tree to another commit on the current branch.
99 By default, the latest commit on the current branch is assumed.
100 If the
101 .Ar work tree path
102 is omitted, use the current working directory.
103 .Pp
104 The options for
105 .Cm got update
106 are as follows:
107 .Bl -tag -width Ds
108 .It Fl c Ar commit
109 Update the work tree to the specified
110 .Ar commit .
111 The expected argument is a SHA1 hash which corresponds to a commit object.
112 .El
113 .It Cm status [ Ar worktree-path ]
114 Show the current modification status of files in a worktree,
115 using the following status codes:
116 .Bl -column YXZ description
117 .It M Ta modified file
118 .It ! Ta versioned file was expected on disk but is missing
119 .It ~ Ta versioned file is obstructed by a non-regular file
120 .It ? Ta unversioned item not tracked by
121 .Nm
122 .El
123 .Pp
124 If the
125 .Ar work tree path
126 is omitted, use the current working directory.
127 .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 ]
128 Display history of a repository.
129 If a
130 .Ar path
131 is specified, show only commits which modified this path.
132 .Pp
133 The options for
134 .Cm got log
135 are as follows:
136 .Bl -tag -width Ds
137 .It Fl c Ar commit
138 Start traversing history at the specified
139 .Ar commit .
140 The expected argument is the name of a branch or a SHA1 hash which corresponds
141 to a commit object.
142 .It Fl C Ar number
143 Set the number of context lines shown in diffs with
144 .Fl p .
145 By default, 3 lines of context are shown.
146 .It Fl f
147 Restrict history traversal to the first parent of each commit.
148 This shows the linear history of the current branch only.
149 Merge commits which affected the current branch will be shown but
150 individual commits which originated on other branches will be omitted.
151 .It Fl l Ar N
152 Limit history traversal to a given number of commits.
153 .It Fl p
154 Display the patch of modifications made in each commit.
155 .It Fl r Ar repository-path
156 Use the repository at the specified path.
157 If not specified, assume the repository is located at or above the current
158 working directory.
159 If this directory is a
160 .Nm
161 work tree, use the repository path associated with this work tree.
162 .El
163 .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 ]
164 Display differences between blobs in the repository and files in the
165 work tree, or between two specified objects in a repository.
166 If specified, each
167 .Ar object
168 argument is a SHA1 hash which corresponds to the object.
169 Both objects must be of the same type (blobs, trees, or commits).
170 .Pp
171 The options for
172 .Cm got diff
173 are as follows:
174 .Bl -tag -width Ds
175 .It Fl C Ar number
176 Set the number of context lines shown in the diff.
177 By default, 3 lines of context are shown.
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
181 working directory.
182 If this directory is a
183 .Nm
184 work tree, use the repository path associated with this work tree.
185 .El
186 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
187 Display line-by-line history of a file at the specified path.
188 .Pp
189 The options for
190 .Cm got blame
191 are as follows:
192 .Bl -tag -width Ds
193 .It Fl c Ar commit
194 Start traversing history at the specified
195 .Ar commit .
196 The expected argument is the name of a branch or a SHA1 hash which corresponds
197 to a commit object.
198 .It Fl r Ar repository-path
199 Use the repository at the specified path.
200 If not specified, assume the repository is located at or above the current
201 working directory.
202 If this directory is a
203 .Nm
204 work tree, use the repository path associated with this work tree.
205 .El
206 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
207 Display a listing of files and directories at the specified
208 directory path in the repository.
209 If no
210 .Ar path
211 is specified, list the repository path corresponding to the current
212 directory of the work tree, or the root directory of the repository
213 if there is no work tree.
214 .Pp
215 The options for
216 .Cm got tree
217 are as follows:
218 .Bl -tag -width Ds
219 .It Fl c Ar commit
220 List files and directories as they appear in the specified
221 .Ar commit .
222 The expected argument is the name of a branch or a SHA1 hash which corresponds
223 to a commit object.
224 .It Fl r Ar repository-path
225 Use the repository at the specified path.
226 If not specified, assume the repository is located at or above the current
227 working directory.
228 If this directory is a
229 .Nm
230 work tree, use the repository path associated with this work tree.
231 .It Fl i
232 Show object IDs of files (blob objects) and directories (tree objects).
233 .It Fl R
234 Recurse into sub-directories in the repository.
235 .El
236 .Sh EXIT STATUS
237 .Ex -std got
238 .Sh EXAMPLES
239 Check out a work tree of
240 .Ox
241 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
242 .Pp
243 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
244 .Sh SEE ALSO
245 .Xr git-repository 5
246 .Xr got-worktree 5
247 .Sh AUTHORS
248 .An Stefan Sperling Aq Mt stsp@openbsd.org
249 .An Martin Pieuchot Aq Mt mpi@openbsd.org