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