2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
4 030916b5 2018-07-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 030916b5 2018-07-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 030916b5 2018-07-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 030916b5 2018-07-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 030916b5 2018-07-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 030916b5 2018-07-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 030916b5 2018-07-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 030916b5 2018-07-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 030916b5 2018-07-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 030916b5 2018-07-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
21 aee2a8bd 2019-08-05 stsp .Nd Git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
24 ee85c5e8 2020-02-29 stsp .Op Ar command
26 030916b5 2018-07-12 stsp .Op Ar arg ...
30 030916b5 2018-07-12 stsp .Sh DESCRIPTION
32 aee2a8bd 2019-08-05 stsp is an interactive read-only browser for Git repositories.
33 030916b5 2018-07-12 stsp This repository format is described in
34 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
38 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
39 9419758a 2019-03-27 stsp .It Log view
40 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
41 87aa0e98 2018-08-18 stsp This view is displayed initially if no
43 ee85c5e8 2020-02-29 stsp is specified, or if just a
45 87aa0e98 2018-08-18 stsp is specified.
46 9419758a 2019-03-27 stsp .It Diff view
47 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
48 9419758a 2019-03-27 stsp .It Blame view
49 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
50 9419758a 2019-03-27 stsp .It Tree view
51 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
52 38cb327b 2020-11-24 stsp .It Ref view
53 38cb327b 2020-11-24 stsp Displays references in the repository.
57 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
58 07b0611c 2022-06-23 thomas Some command-specific key bindings may be prefixed with an integer, which is
59 07b0611c 2022-06-23 thomas denoted by N in the descriptions below, and is used as a modifier to the
60 07b0611c 2022-06-23 thomas operation as indicated.
62 fa502711 2022-07-03 thomas will echo digits to the screen when count modifiers are entered, and complete
63 fa502711 2022-07-03 thomas the sequence upon input of the first non-numeric character.
64 fa502711 2022-07-03 thomas Count modifiers can be aborted by entering an unmapped key.
65 634cb454 2022-07-03 thomas Once a compound command is executed, the operation can be cancelled with
68 634cb454 2022-07-03 thomas .Cm Backspace .
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.
85 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
86 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
88 030916b5 2018-07-12 stsp Display usage information.
89 1795b260 2021-04-02 kn .It Fl V , -version
90 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
93 030916b5 2018-07-12 stsp The commands for
95 030916b5 2018-07-12 stsp are as follows:
96 030916b5 2018-07-12 stsp .Bl -tag -width blame
97 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
98 030916b5 2018-07-12 stsp Display history of a repository.
101 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
102 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
104 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
105 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
106 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
108 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
110 030916b5 2018-07-12 stsp The key bindings for
111 030916b5 2018-07-12 stsp .Cm tog log
112 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
113 030916b5 2018-07-12 stsp .Bl -tag -width Ds
114 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, >, Full stop, Ctrl-n
115 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
116 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, <, Comma, Ctrl-p
117 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
118 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
119 07b0611c 2022-06-23 thomas Scroll log message field to the right N increments (default: 1).
121 d74d8993 2022-06-23 thomas Log message moves left on the screen.
122 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
123 07b0611c 2022-06-23 thomas Scroll log message field to the left N increments (default: 1).
125 d74d8993 2022-06-23 thomas Log message moves right on the screen.
127 05171be4 2022-06-23 thomas Scroll log message field to the rightmost position.
129 05171be4 2022-06-23 thomas Scroll log message field to the leftmost position.
130 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
131 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
132 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
133 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
134 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
135 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
136 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
137 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
138 27890b18 2021-08-30 stsp .It Cm Home, g
139 912a3f79 2021-08-30 j Move the cursor to the newest commit.
141 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
142 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
143 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
144 4b06140e 2022-03-22 thomas If needed, this operation can be cancelled with
147 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
148 4c2d69cb 2022-06-23 thomas .It Cm Enter
151 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
155 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
156 5036bf37 2018-09-24 stsp .It Cm Backspace
157 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
158 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
160 678cbce5 2019-07-28 stsp .Cm Backspace
161 26f0cb24 2021-08-30 j aborts the running operation.
163 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
164 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
165 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
166 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
167 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
168 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
170 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
172 634cb454 2022-07-03 thomas Searching continues until either a match is found or
175 678cbce5 2019-07-28 stsp .Cm Backspace
176 678cbce5 2019-07-28 stsp key is pressed.
178 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
179 07b0611c 2022-06-23 thomas (default: 1).
181 634cb454 2022-07-03 thomas Searching continues until either a match is found or
184 678cbce5 2019-07-28 stsp .Cm Backspace
185 678cbce5 2019-07-28 stsp key is pressed.
186 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
189 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
193 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
196 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
200 38cb327b 2020-11-24 stsp view listing all references in the repository.
201 38cb327b 2020-11-24 stsp This can then be used to open a new
203 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
206 030916b5 2018-07-12 stsp The options for
207 030916b5 2018-07-12 stsp .Cm tog log
208 030916b5 2018-07-12 stsp are as follows:
209 030916b5 2018-07-12 stsp .Bl -tag -width Ds
211 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
212 1137e0ae 2020-01-27 stsp from other branches.
213 b672a97a 2020-01-27 stsp By default,
214 b672a97a 2020-01-27 stsp .Cm tog log
215 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
218 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
219 030916b5 2018-07-12 stsp .It Fl c Ar commit
220 030916b5 2018-07-12 stsp Start traversing history at the specified
221 030916b5 2018-07-12 stsp .Ar commit .
222 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
223 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
224 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
225 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
226 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
227 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
228 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
229 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
230 ecb28ae0 2018-07-16 stsp working directory.
231 212b39d1 2020-02-24 naddy If this directory is a
233 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
235 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
236 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
237 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
238 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
239 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
240 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
241 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
243 030916b5 2018-07-12 stsp The key bindings for
244 030916b5 2018-07-12 stsp .Cm tog diff
245 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
246 030916b5 2018-07-12 stsp .Bl -tag -width Ds
248 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
250 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
251 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
252 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
253 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
254 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
255 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
257 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
258 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
259 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
261 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
263 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
265 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
266 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
267 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
268 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
269 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
270 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
271 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
272 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
273 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
274 00f6361c 2021-08-30 naddy .It Cm Home, g
275 912a3f79 2021-08-30 j Scroll to the top of the view.
277 912a3f79 2021-08-30 j Scroll to the bottom of the view.
279 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
281 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
282 15a087fe 2019-02-21 stsp .It Cm <, Comma
285 01ca22b1 2020-12-07 stsp view was opened via the
287 07b0611c 2022-06-23 thomas view, move to the Nth previous (younger) commit (default: 1).
288 15a087fe 2019-02-21 stsp .It Cm >, Full stop
291 01ca22b1 2020-12-07 stsp view was opened via the
293 07b0611c 2022-06-23 thomas view, move to the Nth next (older) commit (default: 1).
295 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
296 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
297 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
298 66dc9065 2020-02-15 stsp .Xr re_format 7 .
300 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
302 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
303 07b0611c 2022-06-23 thomas (default: 1).
305 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
307 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
308 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
309 d40a767d 2022-07-03 thomas Patience (slow and tidy).
310 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
311 adf4c9e0 2022-07-03 thomas .Cm blame
315 09b5bff8 2020-02-23 naddy The options for
316 09b5bff8 2020-02-23 naddy .Cm tog diff
317 09b5bff8 2020-02-23 naddy are as follows:
318 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
320 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
321 3dbaef42 2020-11-24 stsp .It Fl C Ar number
322 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
323 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
324 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
325 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
326 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
327 09b5bff8 2020-02-23 naddy working directory.
328 212b39d1 2020-02-24 naddy If this directory is a
330 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
332 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
334 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
335 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
337 030916b5 2018-07-12 stsp The key bindings for
338 030916b5 2018-07-12 stsp .Cm tog blame
339 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
340 030916b5 2018-07-12 stsp .Bl -tag -width Ds
341 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
342 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
343 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
344 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
345 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
346 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
348 d74d8993 2022-06-23 thomas File output moves left on the screen.
349 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
350 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
352 d74d8993 2022-06-23 thomas File output moves right on the screen.
354 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
356 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
357 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
358 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
359 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
360 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
361 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
362 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
363 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
364 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
365 4deef56f 2021-09-02 naddy .It Cm Home, g
366 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
367 4deef56f 2021-09-02 naddy .It Cm End, G
368 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
369 030916b5 2018-07-12 stsp .It Cm Enter
372 030916b5 2018-07-12 stsp view for the currently selected line's commit.
376 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
377 c0d30c23 2018-10-07 stsp selected line's commit.
381 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
382 c0d30c23 2018-10-07 stsp currently selected line's commit.
386 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
388 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
389 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
390 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
391 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
393 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
395 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
396 07b0611c 2022-06-23 thomas (default: 1).
398 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
399 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
400 d40a767d 2022-07-03 thomas Patience (slow and tidy).
401 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
406 030916b5 2018-07-12 stsp The options for
407 030916b5 2018-07-12 stsp .Cm tog blame
408 030916b5 2018-07-12 stsp are as follows:
409 030916b5 2018-07-12 stsp .Bl -tag -width Ds
410 030916b5 2018-07-12 stsp .It Fl c Ar commit
411 030916b5 2018-07-12 stsp Start traversing history at the specified
412 030916b5 2018-07-12 stsp .Ar commit .
413 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
414 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
415 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
416 69069811 2018-08-02 stsp .It Fl r Ar repository-path
417 69069811 2018-08-02 stsp Use the repository at the specified path.
418 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
419 69069811 2018-08-02 stsp working directory.
420 212b39d1 2020-02-24 naddy If this directory is a
422 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
424 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
425 030916b5 2018-07-12 stsp Display the repository tree.
428 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
430 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
431 848d6979 2019-08-12 stsp .Bl -column YXZ description
432 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
433 848d6979 2019-08-12 stsp .It / Ta entry is a directory
434 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
435 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
438 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
440 030916b5 2018-07-12 stsp The key bindings for
441 030916b5 2018-07-12 stsp .Cm tog tree
442 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
443 030916b5 2018-07-12 stsp .Bl -tag -width Ds
444 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
445 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
446 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
447 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
448 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
449 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
450 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
451 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
452 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
453 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
454 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
455 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
456 e4526bf5 2021-09-03 naddy .It Cm Home, g
457 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
458 e4526bf5 2021-09-03 naddy .It Cm End, G
459 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
460 030916b5 2018-07-12 stsp .It Cm Enter
461 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
463 030916b5 2018-07-12 stsp view for the currently selected file.
467 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
471 152c1c93 2020-11-29 stsp view listing all references in the repository.
472 152c1c93 2020-11-29 stsp This can then be used to open a new
474 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
475 7837eeac 2018-09-24 stsp .It Cm Backspace
476 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
478 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
482 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
483 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
484 4eec20aa 2019-06-22 stsp against the tree entry's name.
485 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
486 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
488 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
489 07b0611c 2022-06-23 thomas (default: 1).
491 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
492 07b0611c 2022-06-23 thomas (default: 1).
495 030916b5 2018-07-12 stsp The options for
496 030916b5 2018-07-12 stsp .Cm tog tree
497 030916b5 2018-07-12 stsp are as follows:
498 030916b5 2018-07-12 stsp .Bl -tag -width Ds
499 030916b5 2018-07-12 stsp .It Fl c Ar commit
500 030916b5 2018-07-12 stsp Start traversing history at the specified
501 030916b5 2018-07-12 stsp .Ar commit .
502 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
503 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
504 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
505 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
506 38cb327b 2020-11-24 stsp Use the repository at the specified path.
507 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
508 38cb327b 2020-11-24 stsp working directory.
509 38cb327b 2020-11-24 stsp If this directory is a
511 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
513 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
514 38cb327b 2020-11-24 stsp Display references in the repository.
516 38cb327b 2020-11-24 stsp The key bindings for
517 38cb327b 2020-11-24 stsp .Cm tog ref
518 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
519 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
520 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
521 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
522 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
523 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
524 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
525 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
526 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
527 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
528 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
529 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
530 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
531 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
532 e4526bf5 2021-09-03 naddy .It Cm Home, g
533 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
534 e4526bf5 2021-09-03 naddy .It Cm End, G
535 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
536 38cb327b 2020-11-24 stsp .It Cm Enter
539 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
540 38cb327b 2020-11-24 stsp currently selected reference.
544 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
546 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
550 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
552 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
554 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
555 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
556 38cb327b 2020-11-24 stsp against absolute reference names.
557 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
558 38cb327b 2020-11-24 stsp .Xr re_format 7 .
560 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
561 07b0611c 2022-06-23 thomas (default: 1).
563 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
564 07b0611c 2022-06-23 thomas (default: 1).
565 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
566 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
571 38cb327b 2020-11-24 stsp The options for
572 38cb327b 2020-11-24 stsp .Cm tog ref
573 38cb327b 2020-11-24 stsp are as follows:
574 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
575 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
576 74283ab8 2020-02-07 stsp Use the repository at the specified path.
577 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
578 74283ab8 2020-02-07 stsp working directory.
579 74283ab8 2020-02-07 stsp If this directory is a
581 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
584 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
585 adf4c9e0 2022-07-03 thomas .Bl -tag -width TOG_DIFF_ALGORITHM
586 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
587 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
589 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
590 d40a767d 2022-07-03 thomas Patience (slow and tidy).
591 d40a767d 2022-07-03 thomas Valid values for
592 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
594 adf4c9e0 2022-07-03 thomas .Dq patience
596 adf4c9e0 2022-07-03 thomas .Dq myers .
597 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
598 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
599 0b948cdd 2022-07-04 thomas Determines whether
601 0b948cdd 2022-07-04 thomas will use vertical or horizontal split for split-screen views.
602 0b948cdd 2022-07-04 thomas If set to
604 0b948cdd 2022-07-04 thomas then split-screen views will be split horizontally.
605 0b948cdd 2022-07-04 thomas Otherwise, split-screen views will be split vertically.
606 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
608 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
609 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
610 6d17833f 2019-11-08 stsp variables documented below.
611 6d17833f 2019-11-08 stsp The colors available in color schemes are
612 6d17833f 2019-11-08 stsp .Dq black ,
614 6d17833f 2019-11-08 stsp .Dq green ,
615 6d17833f 2019-11-08 stsp .Dq yellow ,
617 93a300b2 2021-08-26 stsp .Dq magenta ,
620 1d7fe5cd 2019-11-08 stsp .Dq default
621 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
622 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
623 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
624 6d17833f 2019-11-08 stsp If not set, the default value
625 6d17833f 2019-11-08 stsp .Dq magenta
627 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
628 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
629 6d17833f 2019-11-08 stsp If not set, the default value
632 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
633 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
634 6d17833f 2019-11-08 stsp If not set, the default value
637 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
638 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
639 c0b01bdb 2019-11-08 stsp If not set, the default value
642 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
643 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
644 c0b01bdb 2019-11-08 stsp If not set, the default value
645 c0b01bdb 2019-11-08 stsp .Dq magenta
647 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
648 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
649 c0b01bdb 2019-11-08 stsp If not set, the default value
650 91b8c405 2020-01-25 stsp .Dq magenta
652 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
653 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
654 6d17833f 2019-11-08 stsp If not set, the default value
657 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
658 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
659 c0b01bdb 2019-11-08 stsp If not set, the default value
662 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
663 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
664 11b20872 2019-11-08 stsp If not set, the default value
667 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
668 11b20872 2019-11-08 stsp The color used to mark up author information.
669 11b20872 2019-11-08 stsp If not set, the default value
672 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
673 11b20872 2019-11-08 stsp The color used to mark up date information.
674 11b20872 2019-11-08 stsp If not set, the default value
677 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
678 38cb327b 2020-11-24 stsp The color used to mark up references in the
679 38cb327b 2020-11-24 stsp .Dq refs/heads/
681 38cb327b 2020-11-24 stsp If not set, the default value
684 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
685 38cb327b 2020-11-24 stsp The color used to mark up references in the
686 38cb327b 2020-11-24 stsp .Dq refs/tags/
688 38cb327b 2020-11-24 stsp If not set, the default value
689 38cb327b 2020-11-24 stsp .Dq magenta
691 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
692 38cb327b 2020-11-24 stsp The color used to mark up references in the
693 38cb327b 2020-11-24 stsp .Dq refs/remotes/
695 38cb327b 2020-11-24 stsp If not set, the default value
698 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
699 2183bbf6 2022-01-23 thomas The color used to mark up references in the
700 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
701 2183bbf6 2022-01-23 thomas namespace.
702 2183bbf6 2022-01-23 thomas If not set, the default value
706 030916b5 2018-07-12 stsp .Sh EXIT STATUS
707 030916b5 2018-07-12 stsp .Ex -std tog
708 030916b5 2018-07-12 stsp .Sh SEE ALSO
709 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
710 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
711 56b9a4ca 2019-06-21 stsp .Xr re_format 7
712 030916b5 2018-07-12 stsp .Sh AUTHORS
713 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
714 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
715 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
716 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
717 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
718 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
719 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
720 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org