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 640cd7ff 2022-06-22 mark Some command-specific key bindings may be prefixed with an integer, which is
59 640cd7ff 2022-06-22 mark denoted by N in the descriptions below, and is used as a modifier to the
60 640cd7ff 2022-06-22 mark operation as indicated.
62 f0032ce6 2022-07-02 mark will echo digits to the screen when count modifiers are entered, and complete
63 f0032ce6 2022-07-02 mark the sequence upon input of the first non-numeric character.
64 f0032ce6 2022-07-02 mark Count modifiers can be aborted by entering an unmapped key.
65 a6d37fac 2022-07-03 mark Once a compound command is executed, the operation can be cancelled with
68 a6d37fac 2022-07-03 mark .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 67d6e2c2 2022-07-12 stsp will automatically use vertical split-screen views if the size of the
83 67d6e2c2 2022-07-12 stsp terminal window is sufficiently large.
85 2572d286 2022-07-12 stsp Switch the current split-screen layout, and render all active views in
86 2572d286 2022-07-12 stsp this new layout.
87 67d6e2c2 2022-07-12 stsp The split-screen layout can be either vertical or horizontal.
88 2572d286 2022-07-12 stsp If the terminal is not wide enough when switching to a vertical split,
89 2572d286 2022-07-12 stsp views will render in fullscreen.
91 3c1dfe12 2022-07-08 mark When in a split-screen view, decrease the size of the focussed split
92 3c1dfe12 2022-07-08 mark N increments (default: 1).
94 3c1dfe12 2022-07-08 mark When in a split-screen view, increase the size of the focussed split
95 3c1dfe12 2022-07-08 mark 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 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
126 030916b5 2018-07-12 stsp .Bl -tag -width Ds
127 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
128 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
129 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
130 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
131 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
132 640cd7ff 2022-06-22 mark Scroll log message field to the right N increments (default: 1).
134 f7443f66 2022-06-16 mark Log message moves left on the screen.
135 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
136 640cd7ff 2022-06-22 mark Scroll log message field to the left N increments (default: 1).
138 f7443f66 2022-06-16 mark Log message moves right on the screen.
140 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
142 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
143 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
144 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
145 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
146 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
147 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
148 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
149 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
150 640cd7ff 2022-06-22 mark 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 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
160 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
161 48bb96f0 2022-06-20 naddy .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 640cd7ff 2022-06-22 mark Find the Nth next commit which matches the current search pattern (default: 1).
185 a6d37fac 2022-07-03 mark 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 640cd7ff 2022-06-22 mark Find the Nth previous commit which matches the current search pattern
192 640cd7ff 2022-06-22 mark (default: 1).
194 a6d37fac 2022-07-03 mark 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.
219 030916b5 2018-07-12 stsp The options for
220 030916b5 2018-07-12 stsp .Cm tog log
221 030916b5 2018-07-12 stsp are as follows:
222 030916b5 2018-07-12 stsp .Bl -tag -width Ds
224 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
225 1137e0ae 2020-01-27 stsp from other branches.
226 b672a97a 2020-01-27 stsp By default,
227 b672a97a 2020-01-27 stsp .Cm tog log
228 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
231 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
232 030916b5 2018-07-12 stsp .It Fl c Ar commit
233 030916b5 2018-07-12 stsp Start traversing history at the specified
234 030916b5 2018-07-12 stsp .Ar commit .
235 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
236 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
237 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
238 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
239 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
240 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
241 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
242 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
243 ecb28ae0 2018-07-16 stsp working directory.
244 212b39d1 2020-02-24 naddy If this directory is a
246 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
248 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
249 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
250 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
251 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
252 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
253 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
254 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
256 030916b5 2018-07-12 stsp The key bindings for
257 030916b5 2018-07-12 stsp .Cm tog diff
258 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
259 030916b5 2018-07-12 stsp .Bl -tag -width Ds
261 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
263 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
264 640cd7ff 2022-06-22 mark Scroll down N lines (default: 1).
265 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
266 640cd7ff 2022-06-22 mark Scroll up N lines (default: 1).
267 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
268 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
270 f7443f66 2022-06-16 mark Diff output moves left on the screen.
271 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
272 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
274 f7443f66 2022-06-16 mark Diff output moves right on the screen.
276 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
278 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
279 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
280 640cd7ff 2022-06-22 mark Scroll down N pages (default: 1).
281 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
282 640cd7ff 2022-06-22 mark Scroll up N pages (default: 1).
283 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
284 640cd7ff 2022-06-22 mark Scroll down N half pages (default: 1).
285 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
286 640cd7ff 2022-06-22 mark Scroll up N half pages (default: 1).
287 00f6361c 2021-08-30 naddy .It Cm Home, g
288 912a3f79 2021-08-30 j Scroll to the top of the view.
290 912a3f79 2021-08-30 j Scroll to the bottom of the view.
292 640cd7ff 2022-06-22 mark Reduce diff context by N lines (default: 1).
294 640cd7ff 2022-06-22 mark Increase diff context by N lines (default: 1).
295 15a087fe 2019-02-21 stsp .It Cm <, Comma
298 01ca22b1 2020-12-07 stsp view was opened via the
300 c0f61fa4 2022-07-11 mark view, move to the Nth previous (younger) commit.
301 c0f61fa4 2022-07-11 mark If the diff was opened via the
303 c0f61fa4 2022-07-11 mark view, move to the Nth previous line and load the corresponding commit
304 c0f61fa4 2022-07-11 mark (default: 1).
305 15a087fe 2019-02-21 stsp .It Cm >, Full stop
308 01ca22b1 2020-12-07 stsp view was opened via the
310 c0f61fa4 2022-07-11 mark view, move to the Nth next (older) commit.
311 c0f61fa4 2022-07-11 mark If the diff was opened via the
313 c0f61fa4 2022-07-11 mark view, move to the Nth next line and load the corresponding commit (default: 1).
315 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
316 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
317 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
318 66dc9065 2020-02-15 stsp .Xr re_format 7 .
320 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
322 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
323 640cd7ff 2022-06-22 mark (default: 1).
325 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
327 917d79a7 2022-07-01 stsp Change the diff algorithm.
328 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
329 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
330 917d79a7 2022-07-01 stsp This is a global setting which also affects the
335 09b5bff8 2020-02-23 naddy The options for
336 09b5bff8 2020-02-23 naddy .Cm tog diff
337 09b5bff8 2020-02-23 naddy are as follows:
338 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
340 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
341 3dbaef42 2020-11-24 stsp .It Fl C Ar number
342 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
343 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
344 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
345 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
346 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
347 09b5bff8 2020-02-23 naddy working directory.
348 212b39d1 2020-02-24 naddy If this directory is a
350 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
352 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
354 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
355 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
357 030916b5 2018-07-12 stsp The key bindings for
358 030916b5 2018-07-12 stsp .Cm tog blame
359 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
360 030916b5 2018-07-12 stsp .Bl -tag -width Ds
361 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
362 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
363 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
364 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
365 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
366 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
368 f7443f66 2022-06-16 mark File output moves left on the screen.
369 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
370 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
372 f7443f66 2022-06-16 mark File output moves right on the screen.
374 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
376 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
377 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
378 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
379 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
380 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
381 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
382 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
383 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
384 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
385 4deef56f 2021-09-02 naddy .It Cm Home, g
386 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
387 4deef56f 2021-09-02 naddy .It Cm End, G
388 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
389 030916b5 2018-07-12 stsp .It Cm Enter
392 030916b5 2018-07-12 stsp view for the currently selected line's commit.
396 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
397 c0d30c23 2018-10-07 stsp selected line's commit.
401 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
402 c0d30c23 2018-10-07 stsp currently selected line's commit.
406 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
408 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
409 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
410 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
411 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
413 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
415 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
416 640cd7ff 2022-06-22 mark (default: 1).
418 917d79a7 2022-07-01 stsp Change the diff algorithm.
419 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
420 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
421 917d79a7 2022-07-01 stsp This is a global setting which also affects the
426 030916b5 2018-07-12 stsp The options for
427 030916b5 2018-07-12 stsp .Cm tog blame
428 030916b5 2018-07-12 stsp are as follows:
429 030916b5 2018-07-12 stsp .Bl -tag -width Ds
430 030916b5 2018-07-12 stsp .It Fl c Ar commit
431 030916b5 2018-07-12 stsp Start traversing history at the specified
432 030916b5 2018-07-12 stsp .Ar commit .
433 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
434 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
435 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
436 69069811 2018-08-02 stsp .It Fl r Ar repository-path
437 69069811 2018-08-02 stsp Use the repository at the specified path.
438 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
439 69069811 2018-08-02 stsp working directory.
440 212b39d1 2020-02-24 naddy If this directory is a
442 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
444 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
445 030916b5 2018-07-12 stsp Display the repository tree.
448 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
450 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
451 848d6979 2019-08-12 stsp .Bl -column YXZ description
452 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
453 848d6979 2019-08-12 stsp .It / Ta entry is a directory
454 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
455 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
458 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
460 030916b5 2018-07-12 stsp The key bindings for
461 030916b5 2018-07-12 stsp .Cm tog tree
462 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
463 030916b5 2018-07-12 stsp .Bl -tag -width Ds
464 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
465 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
466 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
467 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
468 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
469 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
470 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
471 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
472 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
473 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
474 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
475 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
476 e4526bf5 2021-09-03 naddy .It Cm Home, g
477 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
478 e4526bf5 2021-09-03 naddy .It Cm End, G
479 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
480 030916b5 2018-07-12 stsp .It Cm Enter
481 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
483 030916b5 2018-07-12 stsp view for the currently selected file.
487 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
491 152c1c93 2020-11-29 stsp view listing all references in the repository.
492 152c1c93 2020-11-29 stsp This can then be used to open a new
494 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
495 7837eeac 2018-09-24 stsp .It Cm Backspace
496 640cd7ff 2022-06-22 mark Move back to the Nth parent directory (default: 1).
498 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
502 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
503 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
504 4eec20aa 2019-06-22 stsp against the tree entry's name.
505 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
506 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
508 640cd7ff 2022-06-22 mark Find the Nth next tree entry which matches the current search pattern
509 640cd7ff 2022-06-22 mark (default: 1).
511 640cd7ff 2022-06-22 mark Find the Nth previous tree entry which matches the current search pattern
512 640cd7ff 2022-06-22 mark (default: 1).
515 030916b5 2018-07-12 stsp The options for
516 030916b5 2018-07-12 stsp .Cm tog tree
517 030916b5 2018-07-12 stsp are as follows:
518 030916b5 2018-07-12 stsp .Bl -tag -width Ds
519 030916b5 2018-07-12 stsp .It Fl c Ar commit
520 030916b5 2018-07-12 stsp Start traversing history at the specified
521 030916b5 2018-07-12 stsp .Ar commit .
522 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
523 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
524 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
525 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
526 38cb327b 2020-11-24 stsp Use the repository at the specified path.
527 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
528 38cb327b 2020-11-24 stsp working directory.
529 38cb327b 2020-11-24 stsp If this directory is a
531 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
533 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
534 38cb327b 2020-11-24 stsp Display references in the repository.
536 38cb327b 2020-11-24 stsp The key bindings for
537 38cb327b 2020-11-24 stsp .Cm tog ref
538 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
539 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
540 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
541 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
542 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
543 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
544 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
545 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
546 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
547 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
548 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
549 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
550 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
551 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
552 e4526bf5 2021-09-03 naddy .It Cm Home, g
553 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
554 e4526bf5 2021-09-03 naddy .It Cm End, G
555 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
556 38cb327b 2020-11-24 stsp .It Cm Enter
559 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
560 38cb327b 2020-11-24 stsp currently selected reference.
564 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
566 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
570 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
572 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
574 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
575 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
576 38cb327b 2020-11-24 stsp against absolute reference names.
577 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
578 38cb327b 2020-11-24 stsp .Xr re_format 7 .
580 640cd7ff 2022-06-22 mark Find the Nth next reference which matches the current search pattern
581 640cd7ff 2022-06-22 mark (default: 1).
583 640cd7ff 2022-06-22 mark Find the Nth previous reference which matches the current search pattern
584 640cd7ff 2022-06-22 mark (default: 1).
585 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
586 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
591 38cb327b 2020-11-24 stsp The options for
592 38cb327b 2020-11-24 stsp .Cm tog ref
593 38cb327b 2020-11-24 stsp are as follows:
594 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
595 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
596 74283ab8 2020-02-07 stsp Use the repository at the specified path.
597 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
598 74283ab8 2020-02-07 stsp working directory.
599 74283ab8 2020-02-07 stsp If this directory is a
601 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
604 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
605 d2366e29 2022-07-07 mark .Bl -tag -width TOG_VIEW_SPLIT_MODE
606 917d79a7 2022-07-01 stsp .It Ev TOG_DIFF_ALGORITHM
607 917d79a7 2022-07-01 stsp Determines the default diff algorithm used by
609 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
610 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
611 41e8d27d 2022-07-03 stsp Valid values for
612 41e8d27d 2022-07-03 stsp .Ev TOG_DIFF_ALGORITHM
614 917d79a7 2022-07-01 stsp .Dq patience
616 917d79a7 2022-07-01 stsp .Dq myers .
617 917d79a7 2022-07-01 stsp If unset, the Myers diff algorithm will be used by default.
618 619b3b49 2022-07-04 stsp .It Ev TOG_VIEW_SPLIT_MODE
619 2572d286 2022-07-12 stsp Determines the default layout of split-screen views.
625 2572d286 2022-07-12 stsp will use horizontal split by default.
626 2572d286 2022-07-12 stsp Otherwise, vertical split will be used.
629 2572d286 2022-07-12 stsp key can be used to switch between vertical and horizontal split layout
630 2572d286 2022-07-12 stsp at run-time.
631 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
633 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
634 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
635 6d17833f 2019-11-08 stsp variables documented below.
636 6d17833f 2019-11-08 stsp The colors available in color schemes are
637 6d17833f 2019-11-08 stsp .Dq black ,
639 6d17833f 2019-11-08 stsp .Dq green ,
640 6d17833f 2019-11-08 stsp .Dq yellow ,
642 93a300b2 2021-08-26 stsp .Dq magenta ,
645 1d7fe5cd 2019-11-08 stsp .Dq default
646 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
647 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
648 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
649 6d17833f 2019-11-08 stsp If not set, the default value
650 6d17833f 2019-11-08 stsp .Dq magenta
652 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
653 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
654 6d17833f 2019-11-08 stsp If not set, the default value
657 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
658 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
659 6d17833f 2019-11-08 stsp If not set, the default value
662 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
663 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
664 c0b01bdb 2019-11-08 stsp If not set, the default value
667 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
668 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
669 c0b01bdb 2019-11-08 stsp If not set, the default value
670 c0b01bdb 2019-11-08 stsp .Dq magenta
672 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
673 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
674 c0b01bdb 2019-11-08 stsp If not set, the default value
675 91b8c405 2020-01-25 stsp .Dq magenta
677 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
678 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
679 6d17833f 2019-11-08 stsp If not set, the default value
682 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
683 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
684 c0b01bdb 2019-11-08 stsp If not set, the default value
687 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
688 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
689 11b20872 2019-11-08 stsp If not set, the default value
692 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
693 11b20872 2019-11-08 stsp The color used to mark up author information.
694 11b20872 2019-11-08 stsp If not set, the default value
697 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
698 11b20872 2019-11-08 stsp The color used to mark up date information.
699 11b20872 2019-11-08 stsp If not set, the default value
702 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
703 38cb327b 2020-11-24 stsp The color used to mark up references in the
704 38cb327b 2020-11-24 stsp .Dq refs/heads/
706 38cb327b 2020-11-24 stsp If not set, the default value
709 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
710 38cb327b 2020-11-24 stsp The color used to mark up references in the
711 38cb327b 2020-11-24 stsp .Dq refs/tags/
713 38cb327b 2020-11-24 stsp If not set, the default value
714 38cb327b 2020-11-24 stsp .Dq magenta
716 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
717 38cb327b 2020-11-24 stsp The color used to mark up references in the
718 38cb327b 2020-11-24 stsp .Dq refs/remotes/
720 38cb327b 2020-11-24 stsp If not set, the default value
723 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
724 cc488aa7 2022-01-23 stsp The color used to mark up references in the
725 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
727 cc488aa7 2022-01-23 stsp If not set, the default value
731 030916b5 2018-07-12 stsp .Sh EXIT STATUS
732 030916b5 2018-07-12 stsp .Ex -std tog
733 030916b5 2018-07-12 stsp .Sh SEE ALSO
734 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
735 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
736 56b9a4ca 2019-06-21 stsp .Xr re_format 7
737 030916b5 2018-07-12 stsp .Sh AUTHORS
738 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
739 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
740 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
741 8ca658b9 2022-07-05 stsp .An Mark Jamsek Aq Mt mark@jamsek.dev
742 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
743 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
744 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
745 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
