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 e9b3576f 2019-03-27 stsp will automatically use split-screen views if the size of the terminal
83 e9b3576f 2019-03-27 stsp 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 2572d286 2022-07-12 stsp If the terminal is not wide enough when switching to a vertical split,
88 2572d286 2022-07-12 stsp views will render in fullscreen.
90 3c1dfe12 2022-07-08 mark When in a split-screen view, decrease the size of the focussed split
91 3c1dfe12 2022-07-08 mark N increments (default: 1).
93 3c1dfe12 2022-07-08 mark When in a split-screen view, increase the size of the focussed split
94 3c1dfe12 2022-07-08 mark N increments (default: 1).
97 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
98 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
100 030916b5 2018-07-12 stsp Display usage information.
101 1795b260 2021-04-02 kn .It Fl V , -version
102 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
105 030916b5 2018-07-12 stsp The commands for
107 030916b5 2018-07-12 stsp are as follows:
108 030916b5 2018-07-12 stsp .Bl -tag -width blame
109 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
110 030916b5 2018-07-12 stsp Display history of a repository.
113 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
114 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
116 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
117 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
118 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
120 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
122 030916b5 2018-07-12 stsp The key bindings for
123 030916b5 2018-07-12 stsp .Cm tog log
124 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
125 030916b5 2018-07-12 stsp .Bl -tag -width Ds
126 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
127 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
128 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
129 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
130 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
131 640cd7ff 2022-06-22 mark Scroll log message field to the right N increments (default: 1).
133 f7443f66 2022-06-16 mark Log message moves left on the screen.
134 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
135 640cd7ff 2022-06-22 mark Scroll log message field to the left N increments (default: 1).
137 f7443f66 2022-06-16 mark Log message moves right on the screen.
139 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
141 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
142 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
143 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
144 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
145 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
146 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
147 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
148 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
149 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
150 27890b18 2021-08-30 stsp .It Cm Home, g
151 912a3f79 2021-08-30 j Move the cursor to the newest commit.
153 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
154 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
155 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
156 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
159 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
160 48bb96f0 2022-06-20 naddy .It Cm Enter
163 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
167 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
168 5036bf37 2018-09-24 stsp .It Cm Backspace
169 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
170 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
172 678cbce5 2019-07-28 stsp .Cm Backspace
173 26f0cb24 2021-08-30 j aborts the running operation.
175 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
176 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
177 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
178 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
179 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
180 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
182 640cd7ff 2022-06-22 mark Find the Nth next commit which matches the current search pattern (default: 1).
184 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
187 678cbce5 2019-07-28 stsp .Cm Backspace
188 678cbce5 2019-07-28 stsp key is pressed.
190 640cd7ff 2022-06-22 mark Find the Nth previous commit which matches the current search pattern
191 640cd7ff 2022-06-22 mark (default: 1).
193 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
196 678cbce5 2019-07-28 stsp .Cm Backspace
197 678cbce5 2019-07-28 stsp key is pressed.
198 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
201 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
205 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
208 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
212 38cb327b 2020-11-24 stsp view listing all references in the repository.
213 38cb327b 2020-11-24 stsp This can then be used to open a new
215 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
218 030916b5 2018-07-12 stsp The options for
219 030916b5 2018-07-12 stsp .Cm tog log
220 030916b5 2018-07-12 stsp are as follows:
221 030916b5 2018-07-12 stsp .Bl -tag -width Ds
223 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
224 1137e0ae 2020-01-27 stsp from other branches.
225 b672a97a 2020-01-27 stsp By default,
226 b672a97a 2020-01-27 stsp .Cm tog log
227 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
230 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
231 030916b5 2018-07-12 stsp .It Fl c Ar commit
232 030916b5 2018-07-12 stsp Start traversing history at the specified
233 030916b5 2018-07-12 stsp .Ar commit .
234 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
235 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
236 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
237 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
238 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
239 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
240 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
241 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
242 ecb28ae0 2018-07-16 stsp working directory.
243 212b39d1 2020-02-24 naddy If this directory is a
245 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
247 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
248 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
249 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
250 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
251 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
252 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
253 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
255 030916b5 2018-07-12 stsp The key bindings for
256 030916b5 2018-07-12 stsp .Cm tog diff
257 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
258 030916b5 2018-07-12 stsp .Bl -tag -width Ds
260 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
262 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
263 640cd7ff 2022-06-22 mark Scroll down N lines (default: 1).
264 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
265 640cd7ff 2022-06-22 mark Scroll up N lines (default: 1).
266 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
267 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
269 f7443f66 2022-06-16 mark Diff output moves left on the screen.
270 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
271 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
273 f7443f66 2022-06-16 mark Diff output moves right on the screen.
275 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
277 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
278 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
279 640cd7ff 2022-06-22 mark Scroll down N pages (default: 1).
280 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
281 640cd7ff 2022-06-22 mark Scroll up N pages (default: 1).
282 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
283 640cd7ff 2022-06-22 mark Scroll down N half pages (default: 1).
284 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
285 640cd7ff 2022-06-22 mark Scroll up N half pages (default: 1).
286 00f6361c 2021-08-30 naddy .It Cm Home, g
287 912a3f79 2021-08-30 j Scroll to the top of the view.
289 912a3f79 2021-08-30 j Scroll to the bottom of the view.
291 640cd7ff 2022-06-22 mark Reduce diff context by N lines (default: 1).
293 640cd7ff 2022-06-22 mark Increase diff context by N lines (default: 1).
294 15a087fe 2019-02-21 stsp .It Cm <, Comma
297 01ca22b1 2020-12-07 stsp view was opened via the
299 c0f61fa4 2022-07-11 mark view, move to the Nth previous (younger) commit.
300 c0f61fa4 2022-07-11 mark If the diff was opened via the
302 c0f61fa4 2022-07-11 mark view, move to the Nth previous line and load the corresponding commit
303 c0f61fa4 2022-07-11 mark (default: 1).
304 15a087fe 2019-02-21 stsp .It Cm >, Full stop
307 01ca22b1 2020-12-07 stsp view was opened via the
309 c0f61fa4 2022-07-11 mark view, move to the Nth next (older) commit.
310 c0f61fa4 2022-07-11 mark If the diff was opened via the
312 c0f61fa4 2022-07-11 mark view, move to the Nth next line and load the corresponding commit (default: 1).
314 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
315 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
316 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
317 66dc9065 2020-02-15 stsp .Xr re_format 7 .
319 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
321 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
322 640cd7ff 2022-06-22 mark (default: 1).
324 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
326 917d79a7 2022-07-01 stsp Change the diff algorithm.
327 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
328 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
329 917d79a7 2022-07-01 stsp This is a global setting which also affects the
334 09b5bff8 2020-02-23 naddy The options for
335 09b5bff8 2020-02-23 naddy .Cm tog diff
336 09b5bff8 2020-02-23 naddy are as follows:
337 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
339 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
340 3dbaef42 2020-11-24 stsp .It Fl C Ar number
341 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
342 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
343 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
344 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
345 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
346 09b5bff8 2020-02-23 naddy working directory.
347 212b39d1 2020-02-24 naddy If this directory is a
349 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
351 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
353 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
354 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
356 030916b5 2018-07-12 stsp The key bindings for
357 030916b5 2018-07-12 stsp .Cm tog blame
358 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
359 030916b5 2018-07-12 stsp .Bl -tag -width Ds
360 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
361 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
362 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
363 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
364 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
365 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
367 f7443f66 2022-06-16 mark File output moves left on the screen.
368 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
369 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
371 f7443f66 2022-06-16 mark File output moves right on the screen.
373 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
375 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
376 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
377 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
378 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
379 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
380 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
381 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
382 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
383 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
384 4deef56f 2021-09-02 naddy .It Cm Home, g
385 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
386 4deef56f 2021-09-02 naddy .It Cm End, G
387 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
388 030916b5 2018-07-12 stsp .It Cm Enter
391 030916b5 2018-07-12 stsp view for the currently selected line's commit.
395 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
396 c0d30c23 2018-10-07 stsp selected line's commit.
400 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
401 c0d30c23 2018-10-07 stsp currently selected line's commit.
405 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
407 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
408 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
409 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
410 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
412 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
414 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
415 640cd7ff 2022-06-22 mark (default: 1).
417 917d79a7 2022-07-01 stsp Change the diff algorithm.
418 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
419 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
420 917d79a7 2022-07-01 stsp This is a global setting which also affects the
425 030916b5 2018-07-12 stsp The options for
426 030916b5 2018-07-12 stsp .Cm tog blame
427 030916b5 2018-07-12 stsp are as follows:
428 030916b5 2018-07-12 stsp .Bl -tag -width Ds
429 030916b5 2018-07-12 stsp .It Fl c Ar commit
430 030916b5 2018-07-12 stsp Start traversing history at the specified
431 030916b5 2018-07-12 stsp .Ar commit .
432 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
433 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
434 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
435 69069811 2018-08-02 stsp .It Fl r Ar repository-path
436 69069811 2018-08-02 stsp Use the repository at the specified path.
437 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
438 69069811 2018-08-02 stsp working directory.
439 212b39d1 2020-02-24 naddy If this directory is a
441 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
443 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
444 030916b5 2018-07-12 stsp Display the repository tree.
447 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
449 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
450 848d6979 2019-08-12 stsp .Bl -column YXZ description
451 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
452 848d6979 2019-08-12 stsp .It / Ta entry is a directory
453 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
454 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
457 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
459 030916b5 2018-07-12 stsp The key bindings for
460 030916b5 2018-07-12 stsp .Cm tog tree
461 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
462 030916b5 2018-07-12 stsp .Bl -tag -width Ds
463 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
464 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
465 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
466 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
467 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
468 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
469 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
470 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
471 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
472 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
473 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
474 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
475 e4526bf5 2021-09-03 naddy .It Cm Home, g
476 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
477 e4526bf5 2021-09-03 naddy .It Cm End, G
478 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
479 030916b5 2018-07-12 stsp .It Cm Enter
480 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
482 030916b5 2018-07-12 stsp view for the currently selected file.
486 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
490 152c1c93 2020-11-29 stsp view listing all references in the repository.
491 152c1c93 2020-11-29 stsp This can then be used to open a new
493 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
494 7837eeac 2018-09-24 stsp .It Cm Backspace
495 640cd7ff 2022-06-22 mark Move back to the Nth parent directory (default: 1).
497 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
501 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
502 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
503 4eec20aa 2019-06-22 stsp against the tree entry's name.
504 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
505 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
507 640cd7ff 2022-06-22 mark Find the Nth next tree entry which matches the current search pattern
508 640cd7ff 2022-06-22 mark (default: 1).
510 640cd7ff 2022-06-22 mark Find the Nth previous tree entry which matches the current search pattern
511 640cd7ff 2022-06-22 mark (default: 1).
514 030916b5 2018-07-12 stsp The options for
515 030916b5 2018-07-12 stsp .Cm tog tree
516 030916b5 2018-07-12 stsp are as follows:
517 030916b5 2018-07-12 stsp .Bl -tag -width Ds
518 030916b5 2018-07-12 stsp .It Fl c Ar commit
519 030916b5 2018-07-12 stsp Start traversing history at the specified
520 030916b5 2018-07-12 stsp .Ar commit .
521 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
522 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
523 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
524 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
525 38cb327b 2020-11-24 stsp Use the repository at the specified path.
526 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
527 38cb327b 2020-11-24 stsp working directory.
528 38cb327b 2020-11-24 stsp If this directory is a
530 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
532 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
533 38cb327b 2020-11-24 stsp Display references in the repository.
535 38cb327b 2020-11-24 stsp The key bindings for
536 38cb327b 2020-11-24 stsp .Cm tog ref
537 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
538 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
539 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
540 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
541 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
542 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
543 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
544 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
545 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
546 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
547 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
548 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
549 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
550 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
551 e4526bf5 2021-09-03 naddy .It Cm Home, g
552 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
553 e4526bf5 2021-09-03 naddy .It Cm End, G
554 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
555 38cb327b 2020-11-24 stsp .It Cm Enter
558 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
559 38cb327b 2020-11-24 stsp currently selected reference.
563 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
565 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
569 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
571 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
573 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
574 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
575 38cb327b 2020-11-24 stsp against absolute reference names.
576 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
577 38cb327b 2020-11-24 stsp .Xr re_format 7 .
579 640cd7ff 2022-06-22 mark Find the Nth next reference which matches the current search pattern
580 640cd7ff 2022-06-22 mark (default: 1).
582 640cd7ff 2022-06-22 mark Find the Nth previous reference which matches the current search pattern
583 640cd7ff 2022-06-22 mark (default: 1).
584 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
585 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
590 38cb327b 2020-11-24 stsp The options for
591 38cb327b 2020-11-24 stsp .Cm tog ref
592 38cb327b 2020-11-24 stsp are as follows:
593 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
594 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
595 74283ab8 2020-02-07 stsp Use the repository at the specified path.
596 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
597 74283ab8 2020-02-07 stsp working directory.
598 74283ab8 2020-02-07 stsp If this directory is a
600 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
603 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
604 d2366e29 2022-07-07 mark .Bl -tag -width TOG_VIEW_SPLIT_MODE
605 917d79a7 2022-07-01 stsp .It Ev TOG_DIFF_ALGORITHM
606 917d79a7 2022-07-01 stsp Determines the default diff algorithm used by
608 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
609 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
610 41e8d27d 2022-07-03 stsp Valid values for
611 41e8d27d 2022-07-03 stsp .Ev TOG_DIFF_ALGORITHM
613 917d79a7 2022-07-01 stsp .Dq patience
615 917d79a7 2022-07-01 stsp .Dq myers .
616 917d79a7 2022-07-01 stsp If unset, the Myers diff algorithm will be used by default.
617 619b3b49 2022-07-04 stsp .It Ev TOG_VIEW_SPLIT_MODE
618 2572d286 2022-07-12 stsp Determines the default layout of split-screen views.
624 2572d286 2022-07-12 stsp will use horizontal split by default.
625 2572d286 2022-07-12 stsp Otherwise, vertical split will be used.
628 2572d286 2022-07-12 stsp key can be used to switch between vertical and horizontal split layout
629 2572d286 2022-07-12 stsp at run-time.
630 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
632 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
633 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
634 6d17833f 2019-11-08 stsp variables documented below.
635 6d17833f 2019-11-08 stsp The colors available in color schemes are
636 6d17833f 2019-11-08 stsp .Dq black ,
638 6d17833f 2019-11-08 stsp .Dq green ,
639 6d17833f 2019-11-08 stsp .Dq yellow ,
641 93a300b2 2021-08-26 stsp .Dq magenta ,
644 1d7fe5cd 2019-11-08 stsp .Dq default
645 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
646 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
647 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
648 6d17833f 2019-11-08 stsp If not set, the default value
649 6d17833f 2019-11-08 stsp .Dq magenta
651 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
652 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
653 6d17833f 2019-11-08 stsp If not set, the default value
656 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
657 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
658 6d17833f 2019-11-08 stsp If not set, the default value
661 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
662 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
663 c0b01bdb 2019-11-08 stsp If not set, the default value
666 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
667 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
668 c0b01bdb 2019-11-08 stsp If not set, the default value
669 c0b01bdb 2019-11-08 stsp .Dq magenta
671 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
672 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
673 c0b01bdb 2019-11-08 stsp If not set, the default value
674 91b8c405 2020-01-25 stsp .Dq magenta
676 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
677 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
678 6d17833f 2019-11-08 stsp If not set, the default value
681 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
682 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
683 c0b01bdb 2019-11-08 stsp If not set, the default value
686 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
687 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
688 11b20872 2019-11-08 stsp If not set, the default value
691 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
692 11b20872 2019-11-08 stsp The color used to mark up author information.
693 11b20872 2019-11-08 stsp If not set, the default value
696 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
697 11b20872 2019-11-08 stsp The color used to mark up date information.
698 11b20872 2019-11-08 stsp If not set, the default value
701 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
702 38cb327b 2020-11-24 stsp The color used to mark up references in the
703 38cb327b 2020-11-24 stsp .Dq refs/heads/
705 38cb327b 2020-11-24 stsp If not set, the default value
708 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
709 38cb327b 2020-11-24 stsp The color used to mark up references in the
710 38cb327b 2020-11-24 stsp .Dq refs/tags/
712 38cb327b 2020-11-24 stsp If not set, the default value
713 38cb327b 2020-11-24 stsp .Dq magenta
715 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
716 38cb327b 2020-11-24 stsp The color used to mark up references in the
717 38cb327b 2020-11-24 stsp .Dq refs/remotes/
719 38cb327b 2020-11-24 stsp If not set, the default value
722 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
723 cc488aa7 2022-01-23 stsp The color used to mark up references in the
724 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
726 cc488aa7 2022-01-23 stsp If not set, the default value
730 030916b5 2018-07-12 stsp .Sh EXIT STATUS
731 030916b5 2018-07-12 stsp .Ex -std tog
732 030916b5 2018-07-12 stsp .Sh SEE ALSO
733 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
734 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
735 56b9a4ca 2019-06-21 stsp .Xr re_format 7
736 030916b5 2018-07-12 stsp .Sh AUTHORS
737 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
738 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
739 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
740 8ca658b9 2022-07-05 stsp .An Mark Jamsek Aq Mt mark@jamsek.dev
741 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
742 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
743 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
744 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
