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 base name of the
76 .Ar repository path ,
77 or if a
78 .Ar path prefix
79 was specified use the base name of the
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 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
93 .Ar path-prefix
94 will be checked out.
95 .El
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.
99 If the
100 .Ar work tree path
101 is omitted, use the current working directory.
102 .Pp
103 The options for
104 .Cm got update
105 are as follows:
106 .Bl -tag -width Ds
107 .It Fl c Ar commit
108 Update the work tree to the specified
109 .Ar commit .
110 The expected argument is a SHA1 hash which corresponds to a commit object.
111 .El
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 unversioned item not tracked by
119 .Nm
120 .El
121 .Pp
122 If the
123 .Ar work tree path
124 is omitted, use the current working directory.
125 .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 ]
126 Display history of a repository.
127 If a
128 .Ar path
129 is specified, show only commits which modified this path.
130 .Pp
131 The options for
132 .Cm got log
133 are as follows:
134 .Bl -tag -width Ds
135 .It Fl c Ar commit
136 Start traversing history at the specified
137 .Ar commit .
138 The expected argument is the name of a branch or a SHA1 hash which corresponds
139 to a commit object.
140 .It Fl C Ar number
141 Set the number of context lines shown in diffs with
142 .Fl p .
143 By default, 3 lines of context are shown.
144 .It Fl f
145 Restrict history traversal to the first parent of each commit.
146 This shows the linear history of the current branch only.
147 Merge commits which affected the current branch will be shown but
148 individual commits which originated on other branches will be omitted.
149 .It Fl l Ar N
150 Limit history traversal to a given number of commits.
151 .It Fl p
152 Display the patch of modifications made in each commit.
153 .It Fl r Ar repository-path
154 Use the repository at the specified path.
155 If not specified, assume the repository is located at or above the current
156 working directory.
157 .El
158 .It Cm diff [ Fl C Ar number ] [ Ar repository-path ] Ar object1 Ar object2
159 Display the differences between two objects in the repository.
160 Each
161 .Ar object
162 argument is a SHA1 hash which corresponds to the object.
163 Both objects must be of the same type (blobs, trees, or commits).
164 If the
165 .Ar repository path
166 is omitted, use the current working directory.
167 .Pp
168 The options for
169 .Cm got diff
170 are as follows:
171 .Bl -tag -width Ds
172 .It Fl C Ar number
173 Set the number of context lines shown in the diff.
174 By default, 3 lines of context are shown.
175 .El
176 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
177 Display line-by-line history of a file at the specified path.
178 .Pp
179 The options for
180 .Cm got blame
181 are as follows:
182 .Bl -tag -width Ds
183 .It Fl c Ar commit
184 Start traversing history at the specified
185 .Ar commit .
186 The expected argument is the name of a branch or a SHA1 hash which corresponds
187 to a commit object.
188 .It Fl r Ar repository-path
189 Use the repository at the specified path.
190 If not specified, assume the repository is located at or above the current
191 working directory.
192 .El
193 .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
194 Display a listing of files and directories at the specified
195 directory path in the repository.
196 If no path is specified, the root directory is listed.
197 .Pp
198 The options for
199 .Cm got tree
200 are as follows:
201 .Bl -tag -width Ds
202 .It Fl c Ar commit
203 List files and directories as they appear in the specified
204 .Ar commit .
205 The expected argument is the name of a branch or a SHA1 hash which corresponds
206 to a commit object.
207 .It Fl r Ar repository-path
208 Use the repository at the specified path.
209 If not specified, assume the repository is located at or above the current
210 working directory.
211 .It Fl i
212 Show object IDs of files (blob objects) and directories (tree objects).
213 .It Fl R
214 Recurse into sub-directories.
215 .El
216 .Sh EXIT STATUS
217 .Ex -std got
218 .Sh EXAMPLES
219 Check out a work tree of
220 .Ox
221 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
222 .Pp
223 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
224 .Sh SEE ALSO
225 .Xr git-repository 5
226 .Xr got-worktree 5
227 .Sh AUTHORS
228 .An Stefan Sperling Aq Mt stsp@openbsd.org
229 .An Martin Pieuchot Aq Mt mpi@openbsd.org