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.
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 the name of a branch or a SHA1 hash which corresponds
111 to a commit object.
112 .El
113 .\".It Cm status
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.
117 If a
118 .Ar path
119 is specified, show only commits which modified this path.
120 .Pp
121 The options for
122 .Cm got log
123 are as follows:
124 .Bl -tag -width Ds
125 .It Fl c Ar commit
126 Start traversing history at the specified
127 .Ar commit .
128 The expected argument is the name of a branch or a SHA1 hash which corresponds
129 to a commit object.
130 .It Fl C Ar number
131 Set the number of context lines shown in diffs with
132 .Fl p .
133 By default, 3 lines of context are shown.
134 .It Fl f
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.
139 .It Fl l Ar N
140 Limit history traversal to a given number of commits.
141 .It Fl p
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
146 working directory.
147 .El
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.
150 Each
151 .Ar object
152 argument is a SHA1 hash which corresponds to the object.
153 Both objects must be of the same type (blobs, trees, or commits).
154 If the
155 .Ar repository path
156 is omitted, use the current working directory.
157 .Pp
158 The options for
159 .Cm got diff
160 are as follows:
161 .Bl -tag -width Ds
162 .It Fl C Ar number
163 Set the number of context lines shown in the diff.
164 By default, 3 lines of context are shown.
165 .El
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.
168 .Pp
169 The options for
170 .Cm got blame
171 are as follows:
172 .Bl -tag -width Ds
173 .It Fl c Ar commit
174 Start traversing history at the specified
175 .Ar commit .
176 The expected argument is the name of a branch or a SHA1 hash which corresponds
177 to a commit object.
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 .El
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.
187 .Pp
188 The options for
189 .Cm got tree
190 are as follows:
191 .Bl -tag -width Ds
192 .It Fl c Ar commit
193 List files and directories as they appear in the specified
194 .Ar commit .
195 The expected argument is the name of a branch or a SHA1 hash which corresponds
196 to a commit object.
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
200 working directory.
201 .It Fl i
202 Show object IDs of files (blob objects) and directories (tree objects).
203 .It Fl R
204 Recurse into sub-directories.
205 .El
206 .Sh EXIT STATUS
207 .Ex -std got
208 .Sh EXAMPLES
209 Check out a work tree of
210 .Ox
211 kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
212 .Pp
213 .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
214 .Sh SEE ALSO
215 .Xr git-repository 5
216 .Xr got-worktree 5
217 .Sh AUTHORS
218 .An Stefan Sperling Aq Mt stsp@openbsd.org
219 .An Martin Pieuchot Aq Mt mpi@openbsd.org