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 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
35 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
36 87aa0e98 2018-08-18 stsp .It Cm log view
37 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
38 87aa0e98 2018-08-18 stsp This view is displayed initially if no
40 87aa0e98 2018-08-18 stsp is specified.
41 87aa0e98 2018-08-18 stsp .It Cm diff view
42 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
43 87aa0e98 2018-08-18 stsp .It Cm blame view
44 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
45 87aa0e98 2018-08-18 stsp .It Cm tree view
46 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
50 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
51 87aa0e98 2018-08-18 stsp The global key bindings are:
52 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
57 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
59 c0d30c23 2018-10-07 stsp Switch focus between views.
61 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
64 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
65 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
67 030916b5 2018-07-12 stsp Display usage information.
70 030916b5 2018-07-12 stsp The commands for
72 030916b5 2018-07-12 stsp are as follows:
73 030916b5 2018-07-12 stsp .Bl -tag -width blame
74 ecb28ae0 2018-07-16 stsp .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
75 030916b5 2018-07-12 stsp Display history of a repository.
78 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
80 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
82 030916b5 2018-07-12 stsp The key bindings for
84 030916b5 2018-07-12 stsp are as follows:
85 030916b5 2018-07-12 stsp .Bl -tag -width Ds
86 0996b108 2018-10-18 stsp .It Cm Down-arrow, j, Page-down
87 030916b5 2018-07-12 stsp Move the selection cursor down.
88 0996b108 2018-10-18 stsp .It Cm Up-arrow, k, Page-up
89 030916b5 2018-07-12 stsp Move the selection cursor up.
90 030916b5 2018-07-12 stsp .It Cm Enter
93 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
97 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
98 5036bf37 2018-09-24 stsp .It Cm Backspace
99 5036bf37 2018-09-24 stsp Show log entries for the parent directory of the currently selected path.
102 030916b5 2018-07-12 stsp The options for
103 030916b5 2018-07-12 stsp .Cm tog log
104 030916b5 2018-07-12 stsp are as follows:
105 030916b5 2018-07-12 stsp .Bl -tag -width Ds
106 030916b5 2018-07-12 stsp .It Fl c Ar commit
107 030916b5 2018-07-12 stsp Start traversing history at the specified
108 030916b5 2018-07-12 stsp .Ar commit .
109 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
110 030916b5 2018-07-12 stsp to a commit object.
111 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
112 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
113 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
114 ecb28ae0 2018-07-16 stsp working directory.
116 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
117 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
120 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
121 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
123 030916b5 2018-07-12 stsp .Ar repository path
124 030916b5 2018-07-12 stsp is omitted, use the current working directory.
126 030916b5 2018-07-12 stsp The key bindings for
127 030916b5 2018-07-12 stsp .Cm tog diff
128 030916b5 2018-07-12 stsp are as follows:
129 030916b5 2018-07-12 stsp .Bl -tag -width Ds
130 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
131 030916b5 2018-07-12 stsp Scroll down.
132 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
135 48ae06ee 2018-10-18 stsp Reduce the amount of diff context lines.
137 48ae06ee 2018-10-18 stsp Increase the amount of diff context lines.
139 69069811 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
140 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
142 030916b5 2018-07-12 stsp The key bindings for
143 030916b5 2018-07-12 stsp .Cm tog blame
144 030916b5 2018-07-12 stsp are as follows:
145 030916b5 2018-07-12 stsp .Bl -tag -width Ds
146 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
147 030916b5 2018-07-12 stsp Move the selection cursor down.
148 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
149 030916b5 2018-07-12 stsp Move the selection cursor up.
150 030916b5 2018-07-12 stsp .It Cm Enter
153 030916b5 2018-07-12 stsp view for the currently selected line's commit.
157 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
158 c0d30c23 2018-10-07 stsp selected line's commit.
162 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
163 c0d30c23 2018-10-07 stsp currently selected line's commit.
167 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
170 030916b5 2018-07-12 stsp The options for
171 030916b5 2018-07-12 stsp .Cm tog blame
172 030916b5 2018-07-12 stsp are as follows:
173 030916b5 2018-07-12 stsp .Bl -tag -width Ds
174 030916b5 2018-07-12 stsp .It Fl c Ar commit
175 030916b5 2018-07-12 stsp Start traversing history at the specified
176 030916b5 2018-07-12 stsp .Ar commit .
177 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
178 030916b5 2018-07-12 stsp to a commit object.
179 69069811 2018-08-02 stsp .It Fl r Ar repository-path
180 69069811 2018-08-02 stsp Use the repository at the specified path.
181 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
182 69069811 2018-08-02 stsp working directory.
184 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
185 030916b5 2018-07-12 stsp Display the repository tree.
187 030916b5 2018-07-12 stsp .Ar repository path
188 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
190 030916b5 2018-07-12 stsp The key bindings for
191 030916b5 2018-07-12 stsp .Cm tog tree
192 030916b5 2018-07-12 stsp are as follows:
193 030916b5 2018-07-12 stsp .Bl -tag -width Ds
194 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
195 030916b5 2018-07-12 stsp Move the selection cursor down.
196 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
197 030916b5 2018-07-12 stsp Move the selection cursor up.
198 030916b5 2018-07-12 stsp .It Cm Enter
199 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
201 030916b5 2018-07-12 stsp view for the currently selected file.
205 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
206 7837eeac 2018-09-24 stsp .It Cm Backspace
207 030916b5 2018-07-12 stsp Move back to the parent directory.
209 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
214 030916b5 2018-07-12 stsp The options for
215 030916b5 2018-07-12 stsp .Cm tog tree
216 030916b5 2018-07-12 stsp are as follows:
217 030916b5 2018-07-12 stsp .Bl -tag -width Ds
218 030916b5 2018-07-12 stsp .It Fl c Ar commit
219 030916b5 2018-07-12 stsp Start traversing history at the specified
220 030916b5 2018-07-12 stsp .Ar commit .
221 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
222 030916b5 2018-07-12 stsp to a commit object.
225 030916b5 2018-07-12 stsp .Sh EXIT STATUS
226 030916b5 2018-07-12 stsp .Ex -std tog
227 030916b5 2018-07-12 stsp .Sh SEE ALSO
228 5e5560e1 2018-08-01 stsp .Xr git-repository 5
229 030916b5 2018-07-12 stsp .Sh AUTHORS
230 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
