2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 3f0da4df 2018-04-01 stsp .\" Copyright (c) 2018 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 285dc8a4 2018-03-13 stsp .Xr got-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 5c860e29 2018-03-12 stsp The commands are as follows:
68 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
69 5d7c1dab 2018-04-01 stsp .It Cm checkout [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
70 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
71 67d6b2d2 2018-03-13 stsp The work tree may be restricted to a subset of the repository's tree
72 67d6b2d2 2018-03-13 stsp hierarchy by specifying the
73 5d7c1dab 2018-04-01 stsp .Fl p Ar path-prefix
75 5d7c1dab 2018-04-01 stsp In this case, only files beneath the specified prefix will
76 67d6b2d2 2018-03-13 stsp be checked out.
78 5d7c1dab 2018-04-01 stsp .Ar work tree path
79 5d7c1dab 2018-04-01 stsp is not specified, either use the base name of the
80 5d7c1dab 2018-04-01 stsp .Ar repository path ,
82 5d7c1dab 2018-04-01 stsp .Ar path prefix
83 5d7c1dab 2018-04-01 stsp was specified use the base name of the
84 5d7c1dab 2018-04-01 stsp .Ar path prefix .
85 0bb8a95e 2018-03-12 stsp .\".It Cm status
86 0bb8a95e 2018-03-12 stsp .\"Show current status of files.
87 64a96a6d 2018-04-01 stsp .It Cm log [ Fl p ] [ Fl c Ar commit ] [ Fl l Ar N ] [ Ar repository-path ]
88 5c860e29 2018-03-12 stsp Display history of the repository.
91 64a96a6d 2018-04-01 stsp option is given, display the patch of modifications made in each commit.
94 d142fc45 2018-04-01 stsp is specified with the
96 d142fc45 2018-04-01 stsp option, start traversing history at this commit.
99 21294684 2018-04-01 stsp argument is a SHA1 hash which corresponds to the commit object.
102 64a96a6d 2018-04-01 stsp option limits the output to a number of
106 d142fc45 2018-04-01 stsp .Ar repository path
107 d142fc45 2018-04-01 stsp is omitted, use the current working directory.
108 3f8b7d6a 2018-04-01 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
109 3f8b7d6a 2018-04-01 stsp Display the differences between two objects in the repository.
112 21294684 2018-04-01 stsp argument is a SHA1 hash which corresponds to the object.
113 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
115 3f8b7d6a 2018-04-01 stsp .Ar repository path
116 3f8b7d6a 2018-04-01 stsp is omitted, use the current working directory.
118 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
119 5c860e29 2018-03-12 stsp .Ex -std got
120 97925469 2018-03-17 stsp .Sh EXAMPLES
121 97925469 2018-03-17 stsp Check out a work tree of
123 97925469 2018-03-17 stsp kernel sources from a Git repository at /var/repo/openbsd-src to ~/sys:
125 97925469 2018-03-17 stsp .Dl $ got checkout -p sys /var/repo/openbsd-src ~/sys
126 5c860e29 2018-03-12 stsp .Sh SEE ALSO
127 285dc8a4 2018-03-13 stsp .Xr got-repository 5
128 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
129 1a208aaf 2018-04-01 stsp .Sh AUTHORS
130 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
131 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
