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