2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
4 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
21 285dc8a4 2018-03-13 stsp .Nd distributed version control system
22 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
26 5c860e29 2018-03-12 stsp .Op Ar arg ...
27 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
29 285dc8a4 2018-03-13 stsp is a distributed version control system which prioritizes ease of use
30 285dc8a4 2018-03-13 stsp and simplicity over flexibility.
33 285dc8a4 2018-03-13 stsp stores the history of files tracked in version control in a repository
34 55ef7a6f 2018-03-13 stsp which happens to use the same on-disk format as so-called
36 285dc8a4 2018-03-13 stsp repositories created by the popular Git version control system.
37 285dc8a4 2018-03-13 stsp This repository format is described in
38 285dc8a4 2018-03-13 stsp .Xr got-repository 5 .
42 4129c201 2018-03-13 stsp .Dq distributed
43 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
44 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
45 4129c201 2018-03-13 stsp automatically at any time.
47 285dc8a4 2018-03-13 stsp Files managed by
49 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
50 285dc8a4 2018-03-13 stsp Checked out files are stored in a
51 285dc8a4 2018-03-13 stsp .Em work tree
52 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
53 285dc8a4 2018-03-13 stsp The format of a
55 285dc8a4 2018-03-13 stsp work tree is described in
56 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
59 285dc8a4 2018-03-13 stsp provides global and command-specific options.
60 285dc8a4 2018-03-13 stsp Global options must preceed the command name, and are as follows:
61 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
63 1b6b95a8 2018-03-12 stsp Display usage information.
66 5c860e29 2018-03-12 stsp The commands are as follows:
67 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
68 0bb8a95e 2018-03-12 stsp .It Cm checkout
69 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
70 67d6b2d2 2018-03-13 stsp The work tree may be restricted to a subset of the repository's tree
71 67d6b2d2 2018-03-13 stsp hierarchy by specifying the
72 67d6b2d2 2018-03-13 stsp .Fl p Ar prefix
74 67d6b2d2 2018-03-13 stsp In this case, only files beneath the specified directory prefix will
75 67d6b2d2 2018-03-13 stsp be checked out.
76 0bb8a95e 2018-03-12 stsp .\".It Cm status
77 0bb8a95e 2018-03-12 stsp .\"Show current status of files.
79 5c860e29 2018-03-12 stsp Display history of the repository.
81 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
82 5c860e29 2018-03-12 stsp .Ex -std got
83 5c860e29 2018-03-12 stsp .Sh SEE ALSO
84 285dc8a4 2018-03-13 stsp .Xr got-repository 5
85 285dc8a4 2018-03-13 stsp .Xr got-worktree 5