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 aee2a8bd 2019-08-05 stsp .Nd Git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
24 ee85c5e8 2020-02-29 stsp .Op Ar command
26 030916b5 2018-07-12 stsp .Op Ar arg ...
30 030916b5 2018-07-12 stsp .Sh DESCRIPTION
32 aee2a8bd 2019-08-05 stsp is an interactive read-only browser for Git repositories.
33 030916b5 2018-07-12 stsp This repository format is described in
34 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
38 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
39 9419758a 2019-03-27 stsp .It Log view
40 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
41 87aa0e98 2018-08-18 stsp This view is displayed initially if no
43 ee85c5e8 2020-02-29 stsp is specified, or if just a
45 87aa0e98 2018-08-18 stsp is specified.
46 9419758a 2019-03-27 stsp .It Diff view
47 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
48 9419758a 2019-03-27 stsp .It Blame view
49 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
50 9419758a 2019-03-27 stsp .It Tree view
51 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
52 38cb327b 2020-11-24 stsp .It Ref view
53 38cb327b 2020-11-24 stsp Displays references in the repository.
57 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
58 07b0611c 2022-06-23 thomas Some command-specific key bindings may be prefixed with an integer, which is
59 07b0611c 2022-06-23 thomas denoted by N in the descriptions below, and is used as a modifier to the
60 07b0611c 2022-06-23 thomas operation as indicated.
62 fa502711 2022-07-03 thomas will echo digits to the screen when count modifiers are entered, and complete
63 fa502711 2022-07-03 thomas the sequence upon input of the first non-numeric character.
64 fa502711 2022-07-03 thomas Count modifiers can be aborted by entering an unmapped key.
65 634cb454 2022-07-03 thomas Once a compound command is executed, the operation can be cancelled with
68 634cb454 2022-07-03 thomas .Cm Backspace .
70 87aa0e98 2018-08-18 stsp The global key bindings are:
71 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
76 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
78 c0d30c23 2018-10-07 stsp Switch focus between views.
80 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
82 b1c950bf 2022-07-12 thomas will automatically use vertical split-screen views if the size of the
83 b1c950bf 2022-07-12 thomas terminal window is sufficiently large.
85 569abcd7 2022-07-12 thomas Switch the current split-screen layout, and render all active views in
86 569abcd7 2022-07-12 thomas this new layout.
87 b1c950bf 2022-07-12 thomas The split-screen layout can be either vertical or horizontal.
88 569abcd7 2022-07-12 thomas If the terminal is not wide enough when switching to a vertical split,
89 569abcd7 2022-07-12 thomas views will render in fullscreen.
91 53d2bdd3 2022-07-10 thomas When in a split-screen view, decrease the size of the focussed split
92 53d2bdd3 2022-07-10 thomas N increments (default: 1).
94 53d2bdd3 2022-07-10 thomas When in a split-screen view, increase the size of the focussed split
95 53d2bdd3 2022-07-10 thomas N increments (default: 1).
98 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
99 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
101 030916b5 2018-07-12 stsp Display usage information.
102 1795b260 2021-04-02 kn .It Fl V , -version
103 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
106 030916b5 2018-07-12 stsp The commands for
108 030916b5 2018-07-12 stsp are as follows:
109 030916b5 2018-07-12 stsp .Bl -tag -width blame
110 b672a97a 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
111 030916b5 2018-07-12 stsp Display history of a repository.
114 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
115 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
117 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
118 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
119 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
121 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
123 030916b5 2018-07-12 stsp The key bindings for
124 030916b5 2018-07-12 stsp .Cm tog log
125 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
126 030916b5 2018-07-12 stsp .Bl -tag -width Ds
127 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, >, Full stop, Ctrl-n
128 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
129 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, <, Comma, Ctrl-p
130 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
131 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
132 07b0611c 2022-06-23 thomas Scroll log message field to the right N increments (default: 1).
134 d74d8993 2022-06-23 thomas Log message moves left on the screen.
135 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
136 07b0611c 2022-06-23 thomas Scroll log message field to the left N increments (default: 1).
138 d74d8993 2022-06-23 thomas Log message moves right on the screen.
140 05171be4 2022-06-23 thomas Scroll log message field to the rightmost position.
142 05171be4 2022-06-23 thomas Scroll log message field to the leftmost position.
143 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
144 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
145 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
146 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
147 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
148 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
149 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
150 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
151 27890b18 2021-08-30 stsp .It Cm Home, g
152 912a3f79 2021-08-30 j Move the cursor to the newest commit.
154 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
155 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
156 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
157 4b06140e 2022-03-22 thomas If needed, this operation can be cancelled with
160 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
161 4c2d69cb 2022-06-23 thomas .It Cm Enter
164 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
168 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
169 5036bf37 2018-09-24 stsp .It Cm Backspace
170 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
171 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
173 678cbce5 2019-07-28 stsp .Cm Backspace
174 26f0cb24 2021-08-30 j aborts the running operation.
176 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
177 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
178 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
179 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
180 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
181 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
183 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
185 634cb454 2022-07-03 thomas Searching continues until either a match is found or
188 678cbce5 2019-07-28 stsp .Cm Backspace
189 678cbce5 2019-07-28 stsp key is pressed.
191 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
192 07b0611c 2022-06-23 thomas (default: 1).
194 634cb454 2022-07-03 thomas Searching continues until either a match is found or
197 678cbce5 2019-07-28 stsp .Cm Backspace
198 678cbce5 2019-07-28 stsp key is pressed.
199 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
202 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
206 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
209 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
213 38cb327b 2020-11-24 stsp view listing all references in the repository.
214 38cb327b 2020-11-24 stsp This can then be used to open a new
216 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
218 f69c5a46 2022-07-19 thomas Toggle between showing the author and the committer name.
221 030916b5 2018-07-12 stsp The options for
222 030916b5 2018-07-12 stsp .Cm tog log
223 030916b5 2018-07-12 stsp are as follows:
224 030916b5 2018-07-12 stsp .Bl -tag -width Ds
226 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
227 1137e0ae 2020-01-27 stsp from other branches.
228 b672a97a 2020-01-27 stsp By default,
229 b672a97a 2020-01-27 stsp .Cm tog log
230 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
233 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
234 030916b5 2018-07-12 stsp .It Fl c Ar commit
235 030916b5 2018-07-12 stsp Start traversing history at the specified
236 030916b5 2018-07-12 stsp .Ar commit .
237 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
238 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
239 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
240 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
241 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
242 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
243 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
244 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
245 ecb28ae0 2018-07-16 stsp working directory.
246 212b39d1 2020-02-24 naddy If this directory is a
248 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
250 21920d7e 2020-12-07 stsp .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl w Oc Ar object1 Ar object2
251 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
252 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
253 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
254 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
255 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
256 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
258 030916b5 2018-07-12 stsp The key bindings for
259 030916b5 2018-07-12 stsp .Cm tog diff
260 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
261 030916b5 2018-07-12 stsp .Bl -tag -width Ds
263 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
265 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
266 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
267 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
268 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
269 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
270 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
272 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
273 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
274 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
276 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
278 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
280 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
281 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
282 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
283 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
284 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
285 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
286 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
287 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
288 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
289 00f6361c 2021-08-30 naddy .It Cm Home, g
290 912a3f79 2021-08-30 j Scroll to the top of the view.
292 912a3f79 2021-08-30 j Scroll to the bottom of the view.
294 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
296 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
297 15a087fe 2019-02-21 stsp .It Cm <, Comma
300 01ca22b1 2020-12-07 stsp view was opened via the
302 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
303 4fc71f3b 2022-07-12 thomas If the diff was opened via the
304 4fc71f3b 2022-07-12 thomas .Cm blame
305 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
306 4fc71f3b 2022-07-12 thomas (default: 1).
307 15a087fe 2019-02-21 stsp .It Cm >, Full stop
310 01ca22b1 2020-12-07 stsp view was opened via the
312 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
313 4fc71f3b 2022-07-12 thomas If the diff was opened via the
314 4fc71f3b 2022-07-12 thomas .Cm blame
315 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
317 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
318 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
319 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
320 66dc9065 2020-02-15 stsp .Xr re_format 7 .
322 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
324 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
325 07b0611c 2022-06-23 thomas (default: 1).
327 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
329 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
330 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
331 d40a767d 2022-07-03 thomas Patience (slow and tidy).
332 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
333 adf4c9e0 2022-07-03 thomas .Cm blame
337 09b5bff8 2020-02-23 naddy The options for
338 09b5bff8 2020-02-23 naddy .Cm tog diff
339 09b5bff8 2020-02-23 naddy are as follows:
340 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
342 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
343 3dbaef42 2020-11-24 stsp .It Fl C Ar number
344 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
345 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
346 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
347 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
348 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
349 09b5bff8 2020-02-23 naddy working directory.
350 212b39d1 2020-02-24 naddy If this directory is a
352 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
354 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
356 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
357 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
359 030916b5 2018-07-12 stsp The key bindings for
360 030916b5 2018-07-12 stsp .Cm tog blame
361 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
362 030916b5 2018-07-12 stsp .Bl -tag -width Ds
363 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
364 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
365 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
366 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
367 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
368 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
370 d74d8993 2022-06-23 thomas File output moves left on the screen.
371 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
372 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
374 d74d8993 2022-06-23 thomas File output moves right on the screen.
376 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
378 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
379 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
380 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
381 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
382 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
383 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
384 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
385 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
386 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
387 4deef56f 2021-09-02 naddy .It Cm Home, g
388 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
389 4deef56f 2021-09-02 naddy .It Cm End, G
390 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
391 030916b5 2018-07-12 stsp .It Cm Enter
394 030916b5 2018-07-12 stsp view for the currently selected line's commit.
398 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
399 c0d30c23 2018-10-07 stsp selected line's commit.
403 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
404 c0d30c23 2018-10-07 stsp currently selected line's commit.
408 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
410 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
411 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
412 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
413 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
415 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
417 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
418 07b0611c 2022-06-23 thomas (default: 1).
420 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
421 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
422 d40a767d 2022-07-03 thomas Patience (slow and tidy).
423 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
428 030916b5 2018-07-12 stsp The options for
429 030916b5 2018-07-12 stsp .Cm tog blame
430 030916b5 2018-07-12 stsp are as follows:
431 030916b5 2018-07-12 stsp .Bl -tag -width Ds
432 030916b5 2018-07-12 stsp .It Fl c Ar commit
433 030916b5 2018-07-12 stsp Start traversing history at the specified
434 030916b5 2018-07-12 stsp .Ar commit .
435 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
436 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
437 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
438 69069811 2018-08-02 stsp .It Fl r Ar repository-path
439 69069811 2018-08-02 stsp Use the repository at the specified path.
440 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
441 69069811 2018-08-02 stsp working directory.
442 212b39d1 2020-02-24 naddy If this directory is a
444 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
446 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
447 030916b5 2018-07-12 stsp Display the repository tree.
450 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
452 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
453 848d6979 2019-08-12 stsp .Bl -column YXZ description
454 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
455 848d6979 2019-08-12 stsp .It / Ta entry is a directory
456 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
457 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
460 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
462 030916b5 2018-07-12 stsp The key bindings for
463 030916b5 2018-07-12 stsp .Cm tog tree
464 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
465 030916b5 2018-07-12 stsp .Bl -tag -width Ds
466 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
467 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
468 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
469 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
470 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
471 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
472 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
473 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
474 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
475 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
476 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
477 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
478 e4526bf5 2021-09-03 naddy .It Cm Home, g
479 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
480 e4526bf5 2021-09-03 naddy .It Cm End, G
481 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
482 030916b5 2018-07-12 stsp .It Cm Enter
483 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
485 030916b5 2018-07-12 stsp view for the currently selected file.
489 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
493 152c1c93 2020-11-29 stsp view listing all references in the repository.
494 152c1c93 2020-11-29 stsp This can then be used to open a new
496 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
497 7837eeac 2018-09-24 stsp .It Cm Backspace
498 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
500 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
504 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
505 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
506 4eec20aa 2019-06-22 stsp against the tree entry's name.
507 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
508 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
510 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
511 07b0611c 2022-06-23 thomas (default: 1).
513 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
514 07b0611c 2022-06-23 thomas (default: 1).
517 030916b5 2018-07-12 stsp The options for
518 030916b5 2018-07-12 stsp .Cm tog tree
519 030916b5 2018-07-12 stsp are as follows:
520 030916b5 2018-07-12 stsp .Bl -tag -width Ds
521 030916b5 2018-07-12 stsp .It Fl c Ar commit
522 030916b5 2018-07-12 stsp Start traversing history at the specified
523 030916b5 2018-07-12 stsp .Ar commit .
524 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
525 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
526 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
527 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
528 38cb327b 2020-11-24 stsp Use the repository at the specified path.
529 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
530 38cb327b 2020-11-24 stsp working directory.
531 38cb327b 2020-11-24 stsp If this directory is a
533 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
535 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
536 38cb327b 2020-11-24 stsp Display references in the repository.
538 38cb327b 2020-11-24 stsp The key bindings for
539 38cb327b 2020-11-24 stsp .Cm tog ref
540 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
541 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
542 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
543 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
544 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
545 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
546 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
547 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
548 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
549 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
550 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
551 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
552 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
553 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
554 e4526bf5 2021-09-03 naddy .It Cm Home, g
555 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
556 e4526bf5 2021-09-03 naddy .It Cm End, G
557 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
558 38cb327b 2020-11-24 stsp .It Cm Enter
561 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
562 38cb327b 2020-11-24 stsp currently selected reference.
566 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
568 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
572 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
574 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
576 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
577 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
578 38cb327b 2020-11-24 stsp against absolute reference names.
579 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
580 38cb327b 2020-11-24 stsp .Xr re_format 7 .
582 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
583 07b0611c 2022-06-23 thomas (default: 1).
585 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
586 07b0611c 2022-06-23 thomas (default: 1).
587 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
588 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
593 38cb327b 2020-11-24 stsp The options for
594 38cb327b 2020-11-24 stsp .Cm tog ref
595 38cb327b 2020-11-24 stsp are as follows:
596 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
597 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
598 74283ab8 2020-02-07 stsp Use the repository at the specified path.
599 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
600 74283ab8 2020-02-07 stsp working directory.
601 74283ab8 2020-02-07 stsp If this directory is a
603 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
606 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
607 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
608 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
609 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
611 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
612 d40a767d 2022-07-03 thomas Patience (slow and tidy).
613 d40a767d 2022-07-03 thomas Valid values for
614 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
616 adf4c9e0 2022-07-03 thomas .Dq patience
618 adf4c9e0 2022-07-03 thomas .Dq myers .
619 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
620 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
621 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
622 0b948cdd 2022-07-04 thomas If set to
627 569abcd7 2022-07-12 thomas will use horizontal split by default.
628 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
631 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
632 569abcd7 2022-07-12 thomas at run-time.
633 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
635 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
636 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
637 6d17833f 2019-11-08 stsp variables documented below.
638 6d17833f 2019-11-08 stsp The colors available in color schemes are
639 6d17833f 2019-11-08 stsp .Dq black ,
641 6d17833f 2019-11-08 stsp .Dq green ,
642 6d17833f 2019-11-08 stsp .Dq yellow ,
644 93a300b2 2021-08-26 stsp .Dq magenta ,
647 1d7fe5cd 2019-11-08 stsp .Dq default
648 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
649 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
650 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
651 6d17833f 2019-11-08 stsp If not set, the default value
652 6d17833f 2019-11-08 stsp .Dq magenta
654 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
655 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
656 6d17833f 2019-11-08 stsp If not set, the default value
659 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
660 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
661 6d17833f 2019-11-08 stsp If not set, the default value
664 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
665 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
666 c0b01bdb 2019-11-08 stsp If not set, the default value
669 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
670 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
671 c0b01bdb 2019-11-08 stsp If not set, the default value
672 c0b01bdb 2019-11-08 stsp .Dq magenta
674 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
675 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
676 c0b01bdb 2019-11-08 stsp If not set, the default value
677 91b8c405 2020-01-25 stsp .Dq magenta
679 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
680 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
681 6d17833f 2019-11-08 stsp If not set, the default value
684 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
685 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
686 c0b01bdb 2019-11-08 stsp If not set, the default value
689 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
690 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
691 11b20872 2019-11-08 stsp If not set, the default value
694 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
695 11b20872 2019-11-08 stsp The color used to mark up author information.
696 11b20872 2019-11-08 stsp If not set, the default value
699 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
700 11b20872 2019-11-08 stsp The color used to mark up date information.
701 11b20872 2019-11-08 stsp If not set, the default value
704 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
705 38cb327b 2020-11-24 stsp The color used to mark up references in the
706 38cb327b 2020-11-24 stsp .Dq refs/heads/
708 38cb327b 2020-11-24 stsp If not set, the default value
711 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
712 38cb327b 2020-11-24 stsp The color used to mark up references in the
713 38cb327b 2020-11-24 stsp .Dq refs/tags/
715 38cb327b 2020-11-24 stsp If not set, the default value
716 38cb327b 2020-11-24 stsp .Dq magenta
718 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
719 38cb327b 2020-11-24 stsp The color used to mark up references in the
720 38cb327b 2020-11-24 stsp .Dq refs/remotes/
722 38cb327b 2020-11-24 stsp If not set, the default value
725 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
726 2183bbf6 2022-01-23 thomas The color used to mark up references in the
727 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
728 2183bbf6 2022-01-23 thomas namespace.
729 2183bbf6 2022-01-23 thomas If not set, the default value
733 030916b5 2018-07-12 stsp .Sh EXIT STATUS
734 030916b5 2018-07-12 stsp .Ex -std tog
735 030916b5 2018-07-12 stsp .Sh SEE ALSO
736 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
737 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
738 56b9a4ca 2019-06-21 stsp .Xr re_format 7
739 030916b5 2018-07-12 stsp .Sh AUTHORS
740 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
741 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
742 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
743 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
744 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
745 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
746 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
747 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
