2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5d56da81 2019-01-13 stsp .\" Copyright (c) 2018, 2019 Stefan Sperling
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
22 97925469 2018-03-17 stsp .Nd version control system
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
30 97925469 2018-03-17 stsp is a version control system which prioritizes ease of use and simplicity
31 97925469 2018-03-17 stsp over flexibility.
34 70f9e387 2018-04-01 stsp stores the history of tracked files in a repository which uses
35 97925469 2018-03-17 stsp the same on-disk format as
37 70f9e387 2018-04-01 stsp repositories used by the Git version control system.
38 285dc8a4 2018-03-13 stsp This repository format is described in
39 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
43 97925469 2018-03-17 stsp .Em distributed
44 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
45 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
46 97925469 2018-03-17 stsp at any time.
48 285dc8a4 2018-03-13 stsp Files managed by
50 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
51 285dc8a4 2018-03-13 stsp Checked out files are stored in a
52 285dc8a4 2018-03-13 stsp .Em work tree
53 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
54 97925469 2018-03-17 stsp The on-disk format of a
56 285dc8a4 2018-03-13 stsp work tree is described in
57 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
60 285dc8a4 2018-03-13 stsp provides global and command-specific options.
61 285dc8a4 2018-03-13 stsp Global options must preceed the command name, and are as follows:
62 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
64 1b6b95a8 2018-03-12 stsp Display usage information.
67 38e11793 2018-06-13 stsp The commands for
69 38e11793 2018-06-13 stsp are as follows:
70 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
71 8069f636 2019-01-12 stsp .It Cm checkout [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
72 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
74 5d7c1dab 2018-04-01 stsp .Ar work tree path
75 c844a238 2019-02-06 stsp is not specified, either use the last component of
76 5d7c1dab 2018-04-01 stsp .Ar repository path ,
78 5d7c1dab 2018-04-01 stsp .Ar path prefix
79 c844a238 2019-02-06 stsp was specified use the last component of
80 5d7c1dab 2018-04-01 stsp .Ar path prefix .
82 38e11793 2018-06-13 stsp The options for
83 38e11793 2018-06-13 stsp .Cm got checkout
84 38e11793 2018-06-13 stsp are as follows:
85 38e11793 2018-06-13 stsp .Bl -tag -width Ds
86 8069f636 2019-01-12 stsp .It Fl c Ar commit
87 8069f636 2019-01-12 stsp Check out files from the specified
88 8069f636 2019-01-12 stsp .Ar commit .
89 c844a238 2019-02-06 stsp If this option is not specified, a commit resolved via the repository's HEAD
90 c844a238 2019-02-06 stsp reference will be used.
91 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
92 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
93 38e11793 2018-06-13 stsp Only files beneath the specified
94 38e11793 2018-06-13 stsp .Ar path-prefix
95 38e11793 2018-06-13 stsp will be checked out.
97 507dc3bb 2018-12-29 stsp .It Cm update [ Fl c Ar commit ] [ work-tree-path ]
98 0032ca71 2019-01-23 stsp Update an existing work tree to another commit on the current branch.
99 507dc3bb 2018-12-29 stsp By default, the latest commit on the current branch is assumed.
100 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
101 7f838b36 2019-02-08 stsp .Bl -column YXZ description
102 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
103 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
104 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
105 7f838b36 2019-02-08 stsp .It D Ta file was deleted
106 7f838b36 2019-02-08 stsp .It A Ta new file was added
107 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
111 507dc3bb 2018-12-29 stsp .Ar work tree path
112 507dc3bb 2018-12-29 stsp is omitted, use the current working directory.
115 507dc3bb 2018-12-29 stsp The options for
116 507dc3bb 2018-12-29 stsp .Cm got update
117 507dc3bb 2018-12-29 stsp are as follows:
118 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
119 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
120 507dc3bb 2018-12-29 stsp Update the work tree to the specified
121 507dc3bb 2018-12-29 stsp .Ar commit .
122 0032ca71 2019-01-23 stsp The expected argument is a SHA1 hash which corresponds to a commit object.
124 6bad629b 2019-02-04 stsp .It Cm status [ Ar worktree-path ]
125 6bad629b 2019-02-04 stsp Show the current modification status of files in a worktree,
126 6bad629b 2019-02-04 stsp using the following status codes:
127 6bad629b 2019-02-04 stsp .Bl -column YXZ description
128 6bad629b 2019-02-04 stsp .It M Ta modified file
129 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
130 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
131 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
136 6bad629b 2019-02-04 stsp .Ar work tree path
137 6bad629b 2019-02-04 stsp is omitted, use the current working directory.
138 ae9f01af 2018-10-18 stsp .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 ]
139 38e11793 2018-06-13 stsp Display history of a repository.
142 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
144 38e11793 2018-06-13 stsp The options for
145 38e11793 2018-06-13 stsp .Cm got log
146 38e11793 2018-06-13 stsp are as follows:
147 38e11793 2018-06-13 stsp .Bl -tag -width Ds
148 38e11793 2018-06-13 stsp .It Fl c Ar commit
149 38e11793 2018-06-13 stsp Start traversing history at the specified
150 38e11793 2018-06-13 stsp .Ar commit .
151 d1f2edc9 2018-06-13 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
152 1cfab718 2018-06-13 stsp to a commit object.
153 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
154 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
156 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
158 38e11793 2018-06-13 stsp Restrict history traversal to the first parent of each commit.
159 38e11793 2018-06-13 stsp This shows the linear history of the current branch only.
160 38e11793 2018-06-13 stsp Merge commits which affected the current branch will be shown but
161 38e11793 2018-06-13 stsp individual commits which originated on other branches will be omitted.
162 6238ee32 2018-06-13 stsp .It Fl l Ar N
163 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
165 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
166 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
167 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
168 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
169 04ca23f4 2018-07-16 stsp working directory.
170 e9cf2e30 2019-02-05 stsp If this directory is a
172 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
174 b72f483a 2019-02-05 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 ]
175 b72f483a 2019-02-05 stsp Display differences between blobs in the repository and files in the
176 b72f483a 2019-02-05 stsp work tree, or between two specified objects in a repository.
177 b72f483a 2019-02-05 stsp If specified, each
179 21294684 2018-04-01 stsp argument is a SHA1 hash which corresponds to the object.
180 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
182 c0cc5c62 2018-10-18 stsp The options for
183 c0cc5c62 2018-10-18 stsp .Cm got diff
184 c0cc5c62 2018-10-18 stsp are as follows:
185 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
186 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
187 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
188 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
189 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
190 b72f483a 2019-02-05 stsp Use the repository at the specified path.
191 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
192 b72f483a 2019-02-05 stsp working directory.
193 b72f483a 2019-02-05 stsp If this directory is a
195 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
197 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
198 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
200 1ff8e573 2018-08-02 stsp The options for
201 1ff8e573 2018-08-02 stsp .Cm got blame
202 1ff8e573 2018-08-02 stsp are as follows:
203 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
204 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
205 1ff8e573 2018-08-02 stsp Start traversing history at the specified
206 1ff8e573 2018-08-02 stsp .Ar commit .
207 1ff8e573 2018-08-02 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
208 1ff8e573 2018-08-02 stsp to a commit object.
209 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
210 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
211 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
212 1ff8e573 2018-08-02 stsp working directory.
213 0c06baac 2019-02-05 stsp If this directory is a
215 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
217 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
218 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
219 5de5890b 2018-10-18 stsp directory path in the repository.
222 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
223 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
224 0c849583 2019-02-05 stsp if there is no work tree.
226 5de5890b 2018-10-18 stsp The options for
227 5de5890b 2018-10-18 stsp .Cm got tree
228 5de5890b 2018-10-18 stsp are as follows:
229 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
230 5de5890b 2018-10-18 stsp .It Fl c Ar commit
231 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
232 5de5890b 2018-10-18 stsp .Ar commit .
233 5de5890b 2018-10-18 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
234 5de5890b 2018-10-18 stsp to a commit object.
235 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
236 5de5890b 2018-10-18 stsp Use the repository at the specified path.
237 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
238 5de5890b 2018-10-18 stsp working directory.
239 0c849583 2019-02-05 stsp If this directory is a
241 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
243 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
245 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
247 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
248 5c860e29 2018-03-12 stsp .Ex -std got
249 97925469 2018-03-17 stsp .Sh EXAMPLES
250 97925469 2018-03-17 stsp Check out a work tree of
252 97925469 2018-03-17 stsp kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
254 97925469 2018-03-17 stsp .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
255 5c860e29 2018-03-12 stsp .Sh SEE ALSO
256 5e5560e1 2018-08-01 stsp .Xr git-repository 5
257 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
258 1a208aaf 2018-04-01 stsp .Sh AUTHORS
259 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
260 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
