2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
4 030916b5 2018-07-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 030916b5 2018-07-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 030916b5 2018-07-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 030916b5 2018-07-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 030916b5 2018-07-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 030916b5 2018-07-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 030916b5 2018-07-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 030916b5 2018-07-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 030916b5 2018-07-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 030916b5 2018-07-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
21 030916b5 2018-07-12 stsp .Nd git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
26 030916b5 2018-07-12 stsp .Op Ar arg ...
27 030916b5 2018-07-12 stsp .Sh DESCRIPTION
29 030916b5 2018-07-12 stsp is an interactive read-only browser for git repositories.
30 030916b5 2018-07-12 stsp This repository format is described in
31 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
34 030916b5 2018-07-12 stsp provides global and command-specific options.
35 030916b5 2018-07-12 stsp Global options must preceed the command name, and are as follows:
36 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
38 030916b5 2018-07-12 stsp Display usage information.
41 030916b5 2018-07-12 stsp The commands for
43 030916b5 2018-07-12 stsp are as follows:
44 030916b5 2018-07-12 stsp .Bl -tag -width blame
45 ecb28ae0 2018-07-16 stsp .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
46 030916b5 2018-07-12 stsp Display history of a repository.
49 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
51 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
53 030916b5 2018-07-12 stsp The key bindings for
55 030916b5 2018-07-12 stsp are as follows:
56 030916b5 2018-07-12 stsp .Bl -tag -width Ds
57 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
58 030916b5 2018-07-12 stsp Move the selection cursor down.
59 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
60 030916b5 2018-07-12 stsp Move the selection cursor up.
61 030916b5 2018-07-12 stsp .It Cm Enter
62 030916b5 2018-07-12 stsp Switch to the
64 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
66 030916b5 2018-07-12 stsp Switch to the
68 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
75 030916b5 2018-07-12 stsp The options for
77 030916b5 2018-07-12 stsp are as follows:
78 030916b5 2018-07-12 stsp .Bl -tag -width Ds
79 030916b5 2018-07-12 stsp .It Fl c Ar commit
80 030916b5 2018-07-12 stsp Start traversing history at the specified
81 030916b5 2018-07-12 stsp .Ar commit .
82 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
83 030916b5 2018-07-12 stsp to a commit object.
84 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
85 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
86 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
87 ecb28ae0 2018-07-16 stsp working directory.
89 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
90 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
93 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
94 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
96 030916b5 2018-07-12 stsp .Ar repository path
97 030916b5 2018-07-12 stsp is omitted, use the current working directory.
99 030916b5 2018-07-12 stsp The key bindings for
100 030916b5 2018-07-12 stsp .Cm tog diff
101 030916b5 2018-07-12 stsp are as follows:
102 030916b5 2018-07-12 stsp .Bl -tag -width Ds
103 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
104 030916b5 2018-07-12 stsp Scroll down.
105 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
112 030916b5 2018-07-12 stsp .It Cm blame [ Fl c Ar commit ] [ Ar repository-path ] Ar path
113 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
115 030916b5 2018-07-12 stsp .Ar repository path
116 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
118 030916b5 2018-07-12 stsp The key bindings for
119 030916b5 2018-07-12 stsp .Cm tog blame
120 030916b5 2018-07-12 stsp are as follows:
121 030916b5 2018-07-12 stsp .Bl -tag -width Ds
122 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
123 030916b5 2018-07-12 stsp Move the selection cursor down.
124 38f94530 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
125 030916b5 2018-07-12 stsp Move the selection cursor up.
126 030916b5 2018-07-12 stsp .It Cm Enter
127 030916b5 2018-07-12 stsp Switch to the
129 030916b5 2018-07-12 stsp view for the currently selected line's commit.
133 030916b5 2018-07-12 stsp view for the version of the file in the currently selected line's commit.
137 7a2921f9 2018-07-12 stsp view for the version of the file in the currently selected line's commit's
138 7a2921f9 2018-07-12 stsp parent commit.
142 030916b5 2018-07-12 stsp view back to the previously blamed commit.
149 030916b5 2018-07-12 stsp The options for
150 030916b5 2018-07-12 stsp .Cm tog blame
151 030916b5 2018-07-12 stsp are as follows:
152 030916b5 2018-07-12 stsp .Bl -tag -width Ds
153 030916b5 2018-07-12 stsp .It Fl c Ar commit
154 030916b5 2018-07-12 stsp Start traversing history at the specified
155 030916b5 2018-07-12 stsp .Ar commit .
156 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
157 030916b5 2018-07-12 stsp to a commit object.
159 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
160 030916b5 2018-07-12 stsp Display the repository tree.
162 030916b5 2018-07-12 stsp .Ar repository path
163 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
165 030916b5 2018-07-12 stsp The key bindings for
166 030916b5 2018-07-12 stsp .Cm tog tree
167 030916b5 2018-07-12 stsp are as follows:
168 030916b5 2018-07-12 stsp .Bl -tag -width Ds
169 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
170 030916b5 2018-07-12 stsp Move the selection cursor down.
171 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
172 030916b5 2018-07-12 stsp Move the selection cursor up.
173 030916b5 2018-07-12 stsp .It Cm Enter
174 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
176 030916b5 2018-07-12 stsp view for the currently selected file.
178 69efd4c4 2018-07-18 stsp Switch to the
180 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
181 030916b5 2018-07-12 stsp .It Cm Backspace
182 030916b5 2018-07-12 stsp Move back to the parent directory.
184 030916b5 2018-07-12 stsp Show the object IDs for all objects displayed in the
189 030916b5 2018-07-12 stsp The options for
190 030916b5 2018-07-12 stsp .Cm tog tree
191 030916b5 2018-07-12 stsp are as follows:
192 030916b5 2018-07-12 stsp .Bl -tag -width Ds
193 030916b5 2018-07-12 stsp .It Fl c Ar commit
194 030916b5 2018-07-12 stsp Start traversing history at the specified
195 030916b5 2018-07-12 stsp .Ar commit .
196 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
197 030916b5 2018-07-12 stsp to a commit object.
200 030916b5 2018-07-12 stsp .Sh EXIT STATUS
201 030916b5 2018-07-12 stsp .Ex -std tog
202 030916b5 2018-07-12 stsp .Sh SEE ALSO
203 5e5560e1 2018-08-01 stsp .Xr git-repository 5
204 030916b5 2018-07-12 stsp .Sh AUTHORS
205 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org