2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
4 030916b5 2018-07-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 030916b5 2018-07-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 030916b5 2018-07-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 030916b5 2018-07-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 030916b5 2018-07-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 030916b5 2018-07-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 030916b5 2018-07-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 030916b5 2018-07-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 030916b5 2018-07-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 030916b5 2018-07-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
21 aee2a8bd 2019-08-05 stsp .Nd Git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
24 ee85c5e8 2020-02-29 stsp .Op Ar command
26 030916b5 2018-07-12 stsp .Op Ar arg ...
30 030916b5 2018-07-12 stsp .Sh DESCRIPTION
32 aee2a8bd 2019-08-05 stsp is an interactive read-only browser for Git repositories.
33 030916b5 2018-07-12 stsp This repository format is described in
34 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
38 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
39 9419758a 2019-03-27 stsp .It Log view
40 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
41 87aa0e98 2018-08-18 stsp This view is displayed initially if no
43 ee85c5e8 2020-02-29 stsp is specified, or if just a
45 87aa0e98 2018-08-18 stsp is specified.
46 9419758a 2019-03-27 stsp .It Diff view
47 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
48 9419758a 2019-03-27 stsp .It Blame view
49 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
50 9419758a 2019-03-27 stsp .It Tree view
51 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
52 38cb327b 2020-11-24 stsp .It Ref view
53 38cb327b 2020-11-24 stsp Displays references in the repository.
57 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
58 07b0611c 2022-06-23 thomas Some command-specific key bindings may be prefixed with an integer, which is
59 07b0611c 2022-06-23 thomas denoted by N in the descriptions below, and is used as a modifier to the
60 07b0611c 2022-06-23 thomas operation as indicated.
62 fa502711 2022-07-03 thomas will echo digits to the screen when count modifiers are entered, and complete
63 fa502711 2022-07-03 thomas the sequence upon input of the first non-numeric character.
64 fa502711 2022-07-03 thomas Count modifiers can be aborted by entering an unmapped key.
65 634cb454 2022-07-03 thomas Once a compound command is executed, the operation can be cancelled with
68 634cb454 2022-07-03 thomas .Cm Backspace .
70 87aa0e98 2018-08-18 stsp The global key bindings are:
71 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
76 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
78 c0d30c23 2018-10-07 stsp Switch focus between views.
80 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
82 b1c950bf 2022-07-12 thomas will automatically use vertical split-screen views if the size of the
83 b1c950bf 2022-07-12 thomas terminal window is sufficiently large.
85 569abcd7 2022-07-12 thomas Switch the current split-screen layout, and render all active views in
86 569abcd7 2022-07-12 thomas this new layout.
87 b1c950bf 2022-07-12 thomas The split-screen layout can be either vertical or horizontal.
88 569abcd7 2022-07-12 thomas If the terminal is not wide enough when switching to a vertical split,
89 569abcd7 2022-07-12 thomas views will render in fullscreen.
91 53d2bdd3 2022-07-10 thomas When in a split-screen view, decrease the size of the focussed split
92 53d2bdd3 2022-07-10 thomas N increments (default: 1).
94 53d2bdd3 2022-07-10 thomas When in a split-screen view, increase the size of the focussed split
95 53d2bdd3 2022-07-10 thomas N increments (default: 1).
97 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: last line).
99 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: first line).
102 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
103 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
105 030916b5 2018-07-12 stsp Display usage information.
106 1795b260 2021-04-02 kn .It Fl V , -version
107 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
110 030916b5 2018-07-12 stsp The commands for
112 030916b5 2018-07-12 stsp are as follows:
113 030916b5 2018-07-12 stsp .Bl -tag -width blame
117 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
118 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
119 56c96eff 2022-08-30 thomas .Op Ar path
121 030916b5 2018-07-12 stsp Display history of a repository.
124 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
125 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
127 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
128 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
129 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
131 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
133 030916b5 2018-07-12 stsp The key bindings for
134 030916b5 2018-07-12 stsp .Cm tog log
135 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
136 030916b5 2018-07-12 stsp .Bl -tag -width Ds
137 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, >, Full stop, Ctrl-n
138 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
139 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, <, Comma, Ctrl-p
140 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
141 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
142 07b0611c 2022-06-23 thomas Scroll log message field to the right N increments (default: 1).
144 d74d8993 2022-06-23 thomas Log message moves left on the screen.
145 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
146 07b0611c 2022-06-23 thomas Scroll log message field to the left N increments (default: 1).
148 d74d8993 2022-06-23 thomas Log message moves right on the screen.
150 05171be4 2022-06-23 thomas Scroll log message field to the rightmost position.
152 05171be4 2022-06-23 thomas Scroll log message field to the leftmost position.
153 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
154 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
155 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
156 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
157 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
158 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
159 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
160 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
161 27890b18 2021-08-30 stsp .It Cm Home, g
162 912a3f79 2021-08-30 j Move the cursor to the newest commit.
164 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
165 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
166 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
167 4b06140e 2022-03-22 thomas If needed, this operation can be cancelled with
170 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
171 4c2d69cb 2022-06-23 thomas .It Cm Enter
174 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
178 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
179 5036bf37 2018-09-24 stsp .It Cm Backspace
180 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
181 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
183 678cbce5 2019-07-28 stsp .Cm Backspace
184 26f0cb24 2021-08-30 j aborts the running operation.
186 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
187 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
188 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
189 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
190 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
191 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
193 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
195 634cb454 2022-07-03 thomas Searching continues until either a match is found or
198 678cbce5 2019-07-28 stsp .Cm Backspace
199 678cbce5 2019-07-28 stsp key is pressed.
201 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
202 07b0611c 2022-06-23 thomas (default: 1).
204 634cb454 2022-07-03 thomas Searching continues until either a match is found or
207 678cbce5 2019-07-28 stsp .Cm Backspace
208 678cbce5 2019-07-28 stsp key is pressed.
209 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
212 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
216 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
219 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
223 38cb327b 2020-11-24 stsp view listing all references in the repository.
224 38cb327b 2020-11-24 stsp This can then be used to open a new
226 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
228 f69c5a46 2022-07-19 thomas Toggle between showing the author and the committer name.
231 030916b5 2018-07-12 stsp The options for
232 030916b5 2018-07-12 stsp .Cm tog log
233 030916b5 2018-07-12 stsp are as follows:
234 030916b5 2018-07-12 stsp .Bl -tag -width Ds
236 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
237 1137e0ae 2020-01-27 stsp from other branches.
238 b672a97a 2020-01-27 stsp By default,
239 b672a97a 2020-01-27 stsp .Cm tog log
240 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
243 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
244 030916b5 2018-07-12 stsp .It Fl c Ar commit
245 030916b5 2018-07-12 stsp Start traversing history at the specified
246 030916b5 2018-07-12 stsp .Ar commit .
247 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
248 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
249 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
250 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
251 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
252 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
253 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
254 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
255 ecb28ae0 2018-07-16 stsp working directory.
256 212b39d1 2020-02-24 naddy If this directory is a
258 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
262 56c96eff 2022-08-30 thomas .Op Fl aw
263 56c96eff 2022-08-30 thomas .Op Fl C Ar number
264 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
265 56c96eff 2022-08-30 thomas .Ar object1
266 56c96eff 2022-08-30 thomas .Ar object2
268 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
269 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
270 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
271 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
272 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
273 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
275 030916b5 2018-07-12 stsp The key bindings for
276 030916b5 2018-07-12 stsp .Cm tog diff
277 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
278 030916b5 2018-07-12 stsp .Bl -tag -width Ds
280 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
282 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
283 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
284 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
285 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
286 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
287 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
289 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
290 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
291 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
293 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
295 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
297 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
298 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
299 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
300 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
301 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
302 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
303 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
304 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
305 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
306 00f6361c 2021-08-30 naddy .It Cm Home, g
307 912a3f79 2021-08-30 j Scroll to the top of the view.
309 912a3f79 2021-08-30 j Scroll to the bottom of the view.
310 82c78e96 2022-08-06 thomas .It Cm \&(
311 82c78e96 2022-08-06 thomas Navigate to the Nth previous file in the diff (default: 1).
312 82c78e96 2022-08-06 thomas .It Cm \&)
313 82c78e96 2022-08-06 thomas Navigate to the Nth next file in the diff (default: 1).
314 82c78e96 2022-08-06 thomas .It Cm \&{
315 82c78e96 2022-08-06 thomas Navigate to the Nth previous hunk in the diff (default: 1).
316 82c78e96 2022-08-06 thomas .It Cm \&}
317 82c78e96 2022-08-06 thomas Navigate to the Nth next hunk in the diff (default: 1).
319 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
321 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
322 777aae21 2022-07-20 thomas .It Cm <, Comma, K
325 01ca22b1 2020-12-07 stsp view was opened via the
327 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
328 4fc71f3b 2022-07-12 thomas If the diff was opened via the
329 4fc71f3b 2022-07-12 thomas .Cm blame
330 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
331 4fc71f3b 2022-07-12 thomas (default: 1).
332 777aae21 2022-07-20 thomas .It Cm >, Full stop, J
335 01ca22b1 2020-12-07 stsp view was opened via the
337 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
338 4fc71f3b 2022-07-12 thomas If the diff was opened via the
339 4fc71f3b 2022-07-12 thomas .Cm blame
340 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
342 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
343 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
344 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
345 66dc9065 2020-02-15 stsp .Xr re_format 7 .
347 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
349 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
350 07b0611c 2022-06-23 thomas (default: 1).
352 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
354 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
355 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
356 d40a767d 2022-07-03 thomas Patience (slow and tidy).
357 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
358 adf4c9e0 2022-07-03 thomas .Cm blame
362 09b5bff8 2020-02-23 naddy The options for
363 09b5bff8 2020-02-23 naddy .Cm tog diff
364 09b5bff8 2020-02-23 naddy are as follows:
365 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
367 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
368 3dbaef42 2020-11-24 stsp .It Fl C Ar number
369 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
370 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
371 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
372 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
373 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
374 09b5bff8 2020-02-23 naddy working directory.
375 212b39d1 2020-02-24 naddy If this directory is a
377 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
379 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
382 56c96eff 2022-08-30 thomas .Cm blame
383 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
384 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
387 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
389 030916b5 2018-07-12 stsp The key bindings for
390 030916b5 2018-07-12 stsp .Cm tog blame
391 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
392 030916b5 2018-07-12 stsp .Bl -tag -width Ds
393 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
394 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
395 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
396 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
397 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
398 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
400 d74d8993 2022-06-23 thomas File output moves left on the screen.
401 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
402 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
404 d74d8993 2022-06-23 thomas File output moves right on the screen.
406 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
408 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
409 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
410 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
411 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
412 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
413 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
414 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
415 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
416 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
417 4deef56f 2021-09-02 naddy .It Cm Home, g
418 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
419 4deef56f 2021-09-02 naddy .It Cm End, G
420 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
421 030916b5 2018-07-12 stsp .It Cm Enter
424 030916b5 2018-07-12 stsp view for the currently selected line's commit.
428 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
429 c0d30c23 2018-10-07 stsp selected line's commit.
433 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
434 c0d30c23 2018-10-07 stsp currently selected line's commit.
438 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
442 eaeaa612 2022-07-20 thomas view for the currently selected annotated line.
444 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
445 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
446 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
447 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
449 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
451 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
452 07b0611c 2022-06-23 thomas (default: 1).
454 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
455 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
456 d40a767d 2022-07-03 thomas Patience (slow and tidy).
457 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
462 030916b5 2018-07-12 stsp The options for
463 030916b5 2018-07-12 stsp .Cm tog blame
464 030916b5 2018-07-12 stsp are as follows:
465 030916b5 2018-07-12 stsp .Bl -tag -width Ds
466 030916b5 2018-07-12 stsp .It Fl c Ar commit
467 030916b5 2018-07-12 stsp Start traversing history at the specified
468 030916b5 2018-07-12 stsp .Ar commit .
469 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
470 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
471 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
472 69069811 2018-08-02 stsp .It Fl r Ar repository-path
473 69069811 2018-08-02 stsp Use the repository at the specified path.
474 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
475 69069811 2018-08-02 stsp working directory.
476 212b39d1 2020-02-24 naddy If this directory is a
478 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
482 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
483 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
484 56c96eff 2022-08-30 thomas .Op Ar path
486 030916b5 2018-07-12 stsp Display the repository tree.
489 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
491 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
492 848d6979 2019-08-12 stsp .Bl -column YXZ description
493 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
494 848d6979 2019-08-12 stsp .It / Ta entry is a directory
495 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
496 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
499 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
501 030916b5 2018-07-12 stsp The key bindings for
502 030916b5 2018-07-12 stsp .Cm tog tree
503 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
504 030916b5 2018-07-12 stsp .Bl -tag -width Ds
505 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
506 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
507 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
508 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
509 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
510 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
511 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
512 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
513 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
514 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
515 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
516 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
517 e4526bf5 2021-09-03 naddy .It Cm Home, g
518 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
519 e4526bf5 2021-09-03 naddy .It Cm End, G
520 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
521 030916b5 2018-07-12 stsp .It Cm Enter
522 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
524 030916b5 2018-07-12 stsp view for the currently selected file.
528 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
532 152c1c93 2020-11-29 stsp view listing all references in the repository.
533 152c1c93 2020-11-29 stsp This can then be used to open a new
535 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
536 7837eeac 2018-09-24 stsp .It Cm Backspace
537 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
539 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
543 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
544 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
545 4eec20aa 2019-06-22 stsp against the tree entry's name.
546 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
547 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
549 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
550 07b0611c 2022-06-23 thomas (default: 1).
552 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
553 07b0611c 2022-06-23 thomas (default: 1).
556 030916b5 2018-07-12 stsp The options for
557 030916b5 2018-07-12 stsp .Cm tog tree
558 030916b5 2018-07-12 stsp are as follows:
559 030916b5 2018-07-12 stsp .Bl -tag -width Ds
560 030916b5 2018-07-12 stsp .It Fl c Ar commit
561 030916b5 2018-07-12 stsp Start traversing history at the specified
562 030916b5 2018-07-12 stsp .Ar commit .
563 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
564 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
565 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
566 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
567 38cb327b 2020-11-24 stsp Use the repository at the specified path.
568 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
569 38cb327b 2020-11-24 stsp working directory.
570 38cb327b 2020-11-24 stsp If this directory is a
572 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
574 56c96eff 2022-08-30 thomas .It Cm ref Op Fl r Ar repository-path
575 38cb327b 2020-11-24 stsp Display references in the repository.
577 38cb327b 2020-11-24 stsp The key bindings for
578 38cb327b 2020-11-24 stsp .Cm tog ref
579 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
580 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
581 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
582 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
583 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
584 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
585 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
586 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
587 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
588 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
589 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
590 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
591 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
592 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
593 e4526bf5 2021-09-03 naddy .It Cm Home, g
594 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
595 e4526bf5 2021-09-03 naddy .It Cm End, G
596 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
597 38cb327b 2020-11-24 stsp .It Cm Enter
600 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
601 38cb327b 2020-11-24 stsp currently selected reference.
605 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
607 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
611 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
613 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
615 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
616 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
617 38cb327b 2020-11-24 stsp against absolute reference names.
618 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
619 38cb327b 2020-11-24 stsp .Xr re_format 7 .
621 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
622 07b0611c 2022-06-23 thomas (default: 1).
624 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
625 07b0611c 2022-06-23 thomas (default: 1).
626 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
627 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
632 38cb327b 2020-11-24 stsp The options for
633 38cb327b 2020-11-24 stsp .Cm tog ref
634 38cb327b 2020-11-24 stsp are as follows:
635 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
636 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
637 74283ab8 2020-02-07 stsp Use the repository at the specified path.
638 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
639 74283ab8 2020-02-07 stsp working directory.
640 74283ab8 2020-02-07 stsp If this directory is a
642 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
645 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
646 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
647 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
648 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
650 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
651 d40a767d 2022-07-03 thomas Patience (slow and tidy).
652 d40a767d 2022-07-03 thomas Valid values for
653 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
655 adf4c9e0 2022-07-03 thomas .Dq patience
657 adf4c9e0 2022-07-03 thomas .Dq myers .
658 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
659 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
660 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
661 0b948cdd 2022-07-04 thomas If set to
666 569abcd7 2022-07-12 thomas will use horizontal split by default.
667 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
670 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
671 569abcd7 2022-07-12 thomas at run-time.
672 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
674 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
675 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
676 6d17833f 2019-11-08 stsp variables documented below.
677 6d17833f 2019-11-08 stsp The colors available in color schemes are
678 6d17833f 2019-11-08 stsp .Dq black ,
680 6d17833f 2019-11-08 stsp .Dq green ,
681 6d17833f 2019-11-08 stsp .Dq yellow ,
683 93a300b2 2021-08-26 stsp .Dq magenta ,
686 1d7fe5cd 2019-11-08 stsp .Dq default
687 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
688 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
689 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
690 6d17833f 2019-11-08 stsp If not set, the default value
691 6d17833f 2019-11-08 stsp .Dq magenta
693 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
694 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
695 6d17833f 2019-11-08 stsp If not set, the default value
698 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
699 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
700 6d17833f 2019-11-08 stsp If not set, the default value
703 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
704 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
705 c0b01bdb 2019-11-08 stsp If not set, the default value
708 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
709 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
710 c0b01bdb 2019-11-08 stsp If not set, the default value
711 c0b01bdb 2019-11-08 stsp .Dq magenta
713 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
714 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
715 c0b01bdb 2019-11-08 stsp If not set, the default value
716 91b8c405 2020-01-25 stsp .Dq magenta
718 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
719 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
720 6d17833f 2019-11-08 stsp If not set, the default value
723 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
724 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
725 c0b01bdb 2019-11-08 stsp If not set, the default value
728 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
729 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
730 11b20872 2019-11-08 stsp If not set, the default value
733 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
734 11b20872 2019-11-08 stsp The color used to mark up author information.
735 11b20872 2019-11-08 stsp If not set, the default value
738 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
739 11b20872 2019-11-08 stsp The color used to mark up date information.
740 11b20872 2019-11-08 stsp If not set, the default value
743 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
744 38cb327b 2020-11-24 stsp The color used to mark up references in the
745 38cb327b 2020-11-24 stsp .Dq refs/heads/
747 38cb327b 2020-11-24 stsp If not set, the default value
750 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
751 38cb327b 2020-11-24 stsp The color used to mark up references in the
752 38cb327b 2020-11-24 stsp .Dq refs/tags/
754 38cb327b 2020-11-24 stsp If not set, the default value
755 38cb327b 2020-11-24 stsp .Dq magenta
757 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
758 38cb327b 2020-11-24 stsp The color used to mark up references in the
759 38cb327b 2020-11-24 stsp .Dq refs/remotes/
761 38cb327b 2020-11-24 stsp If not set, the default value
764 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
765 2183bbf6 2022-01-23 thomas The color used to mark up references in the
766 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
767 2183bbf6 2022-01-23 thomas namespace.
768 2183bbf6 2022-01-23 thomas If not set, the default value
772 030916b5 2018-07-12 stsp .Sh EXIT STATUS
773 030916b5 2018-07-12 stsp .Ex -std tog
774 030916b5 2018-07-12 stsp .Sh SEE ALSO
775 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
776 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
777 56b9a4ca 2019-06-21 stsp .Xr re_format 7
778 030916b5 2018-07-12 stsp .Sh AUTHORS
779 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
780 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
781 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
782 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
783 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
784 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
785 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
786 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
