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 .
69 87aa0e98 2018-08-18 stsp The global key bindings are:
70 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
75 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
77 c0d30c23 2018-10-07 stsp Switch focus between views.
79 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
81 e9b3576f 2019-03-27 stsp will automatically use split-screen views if the size of the terminal
82 e9b3576f 2019-03-27 stsp window is sufficiently large.
84 d2366e29 2022-07-07 mark When in a split-screen view,
86 d2366e29 2022-07-07 mark will switch to the alternate split mode.
87 d2366e29 2022-07-07 mark If the current view is in a horizontal split and the terminal window is not
88 d2366e29 2022-07-07 mark wide enough, the view will remain unchanged.
91 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
92 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
94 030916b5 2018-07-12 stsp Display usage information.
95 1795b260 2021-04-02 kn .It Fl V , -version
96 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
99 030916b5 2018-07-12 stsp The commands for
101 030916b5 2018-07-12 stsp are as follows:
102 030916b5 2018-07-12 stsp .Bl -tag -width blame
103 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
104 030916b5 2018-07-12 stsp Display history of a repository.
107 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
108 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
110 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
111 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
112 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
114 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
116 030916b5 2018-07-12 stsp The key bindings for
117 030916b5 2018-07-12 stsp .Cm tog log
118 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
119 030916b5 2018-07-12 stsp .Bl -tag -width Ds
120 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
121 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
122 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
123 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
124 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
125 640cd7ff 2022-06-22 mark Scroll log message field to the right N increments (default: 1).
127 f7443f66 2022-06-16 mark Log message moves left on the screen.
128 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
129 640cd7ff 2022-06-22 mark Scroll log message field to the left N increments (default: 1).
131 f7443f66 2022-06-16 mark Log message moves right on the screen.
133 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
135 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
136 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
137 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
138 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
139 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
140 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
141 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
142 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
143 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
144 27890b18 2021-08-30 stsp .It Cm Home, g
145 912a3f79 2021-08-30 j Move the cursor to the newest commit.
147 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
148 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
149 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
150 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
153 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
154 48bb96f0 2022-06-20 naddy .It Cm Enter
157 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
161 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
162 5036bf37 2018-09-24 stsp .It Cm Backspace
163 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
164 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
166 678cbce5 2019-07-28 stsp .Cm Backspace
167 26f0cb24 2021-08-30 j aborts the running operation.
169 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
170 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
171 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
172 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
173 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
174 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
176 640cd7ff 2022-06-22 mark Find the Nth next commit which matches the current search pattern (default: 1).
178 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
181 678cbce5 2019-07-28 stsp .Cm Backspace
182 678cbce5 2019-07-28 stsp key is pressed.
184 640cd7ff 2022-06-22 mark Find the Nth previous commit which matches the current search pattern
185 640cd7ff 2022-06-22 mark (default: 1).
187 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
190 678cbce5 2019-07-28 stsp .Cm Backspace
191 678cbce5 2019-07-28 stsp key is pressed.
192 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
195 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
199 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
202 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
206 38cb327b 2020-11-24 stsp view listing all references in the repository.
207 38cb327b 2020-11-24 stsp This can then be used to open a new
209 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
212 030916b5 2018-07-12 stsp The options for
213 030916b5 2018-07-12 stsp .Cm tog log
214 030916b5 2018-07-12 stsp are as follows:
215 030916b5 2018-07-12 stsp .Bl -tag -width Ds
217 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
218 1137e0ae 2020-01-27 stsp from other branches.
219 b672a97a 2020-01-27 stsp By default,
220 b672a97a 2020-01-27 stsp .Cm tog log
221 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
224 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
225 030916b5 2018-07-12 stsp .It Fl c Ar commit
226 030916b5 2018-07-12 stsp Start traversing history at the specified
227 030916b5 2018-07-12 stsp .Ar commit .
228 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
229 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
230 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
231 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
232 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
233 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
234 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
235 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
236 ecb28ae0 2018-07-16 stsp working directory.
237 212b39d1 2020-02-24 naddy If this directory is a
239 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
241 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
242 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
243 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
244 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
245 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
246 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
247 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
249 030916b5 2018-07-12 stsp The key bindings for
250 030916b5 2018-07-12 stsp .Cm tog diff
251 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
252 030916b5 2018-07-12 stsp .Bl -tag -width Ds
254 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
256 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
257 640cd7ff 2022-06-22 mark Scroll down N lines (default: 1).
258 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
259 640cd7ff 2022-06-22 mark Scroll up N lines (default: 1).
260 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
261 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
263 f7443f66 2022-06-16 mark Diff output moves left on the screen.
264 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
265 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
267 f7443f66 2022-06-16 mark Diff output moves right on the screen.
269 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
271 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
272 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
273 640cd7ff 2022-06-22 mark Scroll down N pages (default: 1).
274 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
275 640cd7ff 2022-06-22 mark Scroll up N pages (default: 1).
276 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
277 640cd7ff 2022-06-22 mark Scroll down N half pages (default: 1).
278 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
279 640cd7ff 2022-06-22 mark Scroll up N half pages (default: 1).
280 00f6361c 2021-08-30 naddy .It Cm Home, g
281 912a3f79 2021-08-30 j Scroll to the top of the view.
283 912a3f79 2021-08-30 j Scroll to the bottom of the view.
285 640cd7ff 2022-06-22 mark Reduce diff context by N lines (default: 1).
287 640cd7ff 2022-06-22 mark Increase diff context by N lines (default: 1).
288 15a087fe 2019-02-21 stsp .It Cm <, Comma
291 01ca22b1 2020-12-07 stsp view was opened via the
293 640cd7ff 2022-06-22 mark view, move to the Nth previous (younger) commit (default: 1).
294 15a087fe 2019-02-21 stsp .It Cm >, Full stop
297 01ca22b1 2020-12-07 stsp view was opened via the
299 640cd7ff 2022-06-22 mark view, move to the Nth next (older) commit (default: 1).
301 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
302 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
303 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
304 66dc9065 2020-02-15 stsp .Xr re_format 7 .
306 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
308 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
309 640cd7ff 2022-06-22 mark (default: 1).
311 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
313 917d79a7 2022-07-01 stsp Change the diff algorithm.
314 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
315 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
316 917d79a7 2022-07-01 stsp This is a global setting which also affects the
321 09b5bff8 2020-02-23 naddy The options for
322 09b5bff8 2020-02-23 naddy .Cm tog diff
323 09b5bff8 2020-02-23 naddy are as follows:
324 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
326 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
327 3dbaef42 2020-11-24 stsp .It Fl C Ar number
328 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
329 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
330 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
331 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
332 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
333 09b5bff8 2020-02-23 naddy working directory.
334 212b39d1 2020-02-24 naddy If this directory is a
336 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
338 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
340 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
341 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
343 030916b5 2018-07-12 stsp The key bindings for
344 030916b5 2018-07-12 stsp .Cm tog blame
345 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
346 030916b5 2018-07-12 stsp .Bl -tag -width Ds
347 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
348 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
349 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
350 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
351 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
352 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
354 f7443f66 2022-06-16 mark File output moves left on the screen.
355 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
356 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
358 f7443f66 2022-06-16 mark File output moves right on the screen.
360 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
362 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
363 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
364 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
365 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
366 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
367 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
368 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
369 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
370 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
371 4deef56f 2021-09-02 naddy .It Cm Home, g
372 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
373 4deef56f 2021-09-02 naddy .It Cm End, G
374 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
375 030916b5 2018-07-12 stsp .It Cm Enter
378 030916b5 2018-07-12 stsp view for the currently selected line's commit.
382 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
383 c0d30c23 2018-10-07 stsp selected line's commit.
387 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
388 c0d30c23 2018-10-07 stsp currently selected line's commit.
392 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
394 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
395 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
396 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
397 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
399 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
401 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
402 640cd7ff 2022-06-22 mark (default: 1).
404 917d79a7 2022-07-01 stsp Change the diff algorithm.
405 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
406 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
407 917d79a7 2022-07-01 stsp This is a global setting which also affects the
412 030916b5 2018-07-12 stsp The options for
413 030916b5 2018-07-12 stsp .Cm tog blame
414 030916b5 2018-07-12 stsp are as follows:
415 030916b5 2018-07-12 stsp .Bl -tag -width Ds
416 030916b5 2018-07-12 stsp .It Fl c Ar commit
417 030916b5 2018-07-12 stsp Start traversing history at the specified
418 030916b5 2018-07-12 stsp .Ar commit .
419 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
420 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
421 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
422 69069811 2018-08-02 stsp .It Fl r Ar repository-path
423 69069811 2018-08-02 stsp Use the repository at the specified path.
424 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
425 69069811 2018-08-02 stsp working directory.
426 212b39d1 2020-02-24 naddy If this directory is a
428 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
430 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
431 030916b5 2018-07-12 stsp Display the repository tree.
434 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
436 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
437 848d6979 2019-08-12 stsp .Bl -column YXZ description
438 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
439 848d6979 2019-08-12 stsp .It / Ta entry is a directory
440 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
441 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
444 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
446 030916b5 2018-07-12 stsp The key bindings for
447 030916b5 2018-07-12 stsp .Cm tog tree
448 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
449 030916b5 2018-07-12 stsp .Bl -tag -width Ds
450 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
451 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
452 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
453 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
454 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
455 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
456 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
457 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
458 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
459 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
460 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
461 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
462 e4526bf5 2021-09-03 naddy .It Cm Home, g
463 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
464 e4526bf5 2021-09-03 naddy .It Cm End, G
465 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
466 030916b5 2018-07-12 stsp .It Cm Enter
467 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
469 030916b5 2018-07-12 stsp view for the currently selected file.
473 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
477 152c1c93 2020-11-29 stsp view listing all references in the repository.
478 152c1c93 2020-11-29 stsp This can then be used to open a new
480 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
481 7837eeac 2018-09-24 stsp .It Cm Backspace
482 640cd7ff 2022-06-22 mark Move back to the Nth parent directory (default: 1).
484 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
488 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
489 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
490 4eec20aa 2019-06-22 stsp against the tree entry's name.
491 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
492 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
494 640cd7ff 2022-06-22 mark Find the Nth next tree entry which matches the current search pattern
495 640cd7ff 2022-06-22 mark (default: 1).
497 640cd7ff 2022-06-22 mark Find the Nth previous tree entry which matches the current search pattern
498 640cd7ff 2022-06-22 mark (default: 1).
501 030916b5 2018-07-12 stsp The options for
502 030916b5 2018-07-12 stsp .Cm tog tree
503 030916b5 2018-07-12 stsp are as follows:
504 030916b5 2018-07-12 stsp .Bl -tag -width Ds
505 030916b5 2018-07-12 stsp .It Fl c Ar commit
506 030916b5 2018-07-12 stsp Start traversing history at the specified
507 030916b5 2018-07-12 stsp .Ar commit .
508 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
509 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
510 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
511 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
512 38cb327b 2020-11-24 stsp Use the repository at the specified path.
513 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
514 38cb327b 2020-11-24 stsp working directory.
515 38cb327b 2020-11-24 stsp If this directory is a
517 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
519 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
520 38cb327b 2020-11-24 stsp Display references in the repository.
522 38cb327b 2020-11-24 stsp The key bindings for
523 38cb327b 2020-11-24 stsp .Cm tog ref
524 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
525 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
526 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
527 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
528 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
529 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
530 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
531 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
532 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
533 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
534 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
535 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
536 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
537 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
538 e4526bf5 2021-09-03 naddy .It Cm Home, g
539 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
540 e4526bf5 2021-09-03 naddy .It Cm End, G
541 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
542 38cb327b 2020-11-24 stsp .It Cm Enter
545 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
546 38cb327b 2020-11-24 stsp currently selected reference.
550 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
552 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
556 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
558 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
560 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
561 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
562 38cb327b 2020-11-24 stsp against absolute reference names.
563 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
564 38cb327b 2020-11-24 stsp .Xr re_format 7 .
566 640cd7ff 2022-06-22 mark Find the Nth next reference which matches the current search pattern
567 640cd7ff 2022-06-22 mark (default: 1).
569 640cd7ff 2022-06-22 mark Find the Nth previous reference which matches the current search pattern
570 640cd7ff 2022-06-22 mark (default: 1).
571 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
572 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
577 38cb327b 2020-11-24 stsp The options for
578 38cb327b 2020-11-24 stsp .Cm tog ref
579 38cb327b 2020-11-24 stsp are as follows:
580 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
581 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
582 74283ab8 2020-02-07 stsp Use the repository at the specified path.
583 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
584 74283ab8 2020-02-07 stsp working directory.
585 74283ab8 2020-02-07 stsp If this directory is a
587 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
590 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
591 d2366e29 2022-07-07 mark .Bl -tag -width TOG_VIEW_SPLIT_MODE
592 917d79a7 2022-07-01 stsp .It Ev TOG_DIFF_ALGORITHM
593 917d79a7 2022-07-01 stsp Determines the default diff algorithm used by
595 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
596 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
597 41e8d27d 2022-07-03 stsp Valid values for
598 41e8d27d 2022-07-03 stsp .Ev TOG_DIFF_ALGORITHM
600 917d79a7 2022-07-01 stsp .Dq patience
602 917d79a7 2022-07-01 stsp .Dq myers .
603 917d79a7 2022-07-01 stsp If unset, the Myers diff algorithm will be used by default.
604 619b3b49 2022-07-04 stsp .It Ev TOG_VIEW_SPLIT_MODE
605 619b3b49 2022-07-04 stsp Determines whether
607 619b3b49 2022-07-04 stsp will use vertical or horizontal split for split-screen views.
610 619b3b49 2022-07-04 stsp then split-screen views will be split horizontally.
611 619b3b49 2022-07-04 stsp Otherwise, split-screen views will be split vertically.
612 d2366e29 2022-07-07 mark Splits can be manipulated in-session as documented above.
613 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
615 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
616 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
617 6d17833f 2019-11-08 stsp variables documented below.
618 6d17833f 2019-11-08 stsp The colors available in color schemes are
619 6d17833f 2019-11-08 stsp .Dq black ,
621 6d17833f 2019-11-08 stsp .Dq green ,
622 6d17833f 2019-11-08 stsp .Dq yellow ,
624 93a300b2 2021-08-26 stsp .Dq magenta ,
627 1d7fe5cd 2019-11-08 stsp .Dq default
628 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
629 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
630 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
631 6d17833f 2019-11-08 stsp If not set, the default value
632 6d17833f 2019-11-08 stsp .Dq magenta
634 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
635 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
636 6d17833f 2019-11-08 stsp If not set, the default value
639 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
640 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
641 6d17833f 2019-11-08 stsp If not set, the default value
644 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
645 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
646 c0b01bdb 2019-11-08 stsp If not set, the default value
649 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
650 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
651 c0b01bdb 2019-11-08 stsp If not set, the default value
652 c0b01bdb 2019-11-08 stsp .Dq magenta
654 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
655 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
656 c0b01bdb 2019-11-08 stsp If not set, the default value
657 91b8c405 2020-01-25 stsp .Dq magenta
659 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
660 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
661 6d17833f 2019-11-08 stsp If not set, the default value
664 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
665 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
666 c0b01bdb 2019-11-08 stsp If not set, the default value
669 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
670 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
671 11b20872 2019-11-08 stsp If not set, the default value
674 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
675 11b20872 2019-11-08 stsp The color used to mark up author information.
676 11b20872 2019-11-08 stsp If not set, the default value
679 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
680 11b20872 2019-11-08 stsp The color used to mark up date information.
681 11b20872 2019-11-08 stsp If not set, the default value
684 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
685 38cb327b 2020-11-24 stsp The color used to mark up references in the
686 38cb327b 2020-11-24 stsp .Dq refs/heads/
688 38cb327b 2020-11-24 stsp If not set, the default value
691 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
692 38cb327b 2020-11-24 stsp The color used to mark up references in the
693 38cb327b 2020-11-24 stsp .Dq refs/tags/
695 38cb327b 2020-11-24 stsp If not set, the default value
696 38cb327b 2020-11-24 stsp .Dq magenta
698 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
699 38cb327b 2020-11-24 stsp The color used to mark up references in the
700 38cb327b 2020-11-24 stsp .Dq refs/remotes/
702 38cb327b 2020-11-24 stsp If not set, the default value
705 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
706 cc488aa7 2022-01-23 stsp The color used to mark up references in the
707 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
709 cc488aa7 2022-01-23 stsp If not set, the default value
713 030916b5 2018-07-12 stsp .Sh EXIT STATUS
714 030916b5 2018-07-12 stsp .Ex -std tog
715 030916b5 2018-07-12 stsp .Sh SEE ALSO
716 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
717 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
718 56b9a4ca 2019-06-21 stsp .Xr re_format 7
719 030916b5 2018-07-12 stsp .Sh AUTHORS
720 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
721 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
722 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
723 8ca658b9 2022-07-05 stsp .An Mark Jamsek Aq Mt mark@jamsek.dev
724 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
725 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
726 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
727 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org