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
25 0a58e722 2022-10-04 thomas .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 ee0cf61c 2022-10-05 thomas Global options must precede the command name, and are as follows:
71 ee0cf61c 2022-10-05 thomas .Bl -tag -width tenletters
73 ee0cf61c 2022-10-05 thomas Display usage information.
74 ee0cf61c 2022-10-05 thomas .It Fl V , -version
75 ee0cf61c 2022-10-05 thomas Display program version and exit immediately.
78 87aa0e98 2018-08-18 stsp The global key bindings are:
79 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
80 fc2737d5 2022-09-15 thomas .It Cm H, F1
81 fc2737d5 2022-09-15 thomas Display run-time help.
82 fc2737d5 2022-09-15 thomas Key bindings for the focussed view will be displayed.
83 fc2737d5 2022-09-15 thomas Pressing this again inside the help view will toggle the display of
84 fc2737d5 2022-09-15 thomas key bindings for all
91 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
93 c0d30c23 2018-10-07 stsp Switch focus between views.
95 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
97 b1c950bf 2022-07-12 thomas will automatically use vertical split-screen views if the size of the
98 b1c950bf 2022-07-12 thomas terminal window is sufficiently large.
100 569abcd7 2022-07-12 thomas Switch the current split-screen layout, and render all active views in
101 569abcd7 2022-07-12 thomas this new layout.
102 b1c950bf 2022-07-12 thomas The split-screen layout can be either vertical or horizontal.
103 569abcd7 2022-07-12 thomas If the terminal is not wide enough when switching to a vertical split,
104 569abcd7 2022-07-12 thomas views will render in fullscreen.
106 53d2bdd3 2022-07-10 thomas When in a split-screen view, decrease the size of the focussed split
107 53d2bdd3 2022-07-10 thomas N increments (default: 1).
109 53d2bdd3 2022-07-10 thomas When in a split-screen view, increase the size of the focussed split
110 53d2bdd3 2022-07-10 thomas N increments (default: 1).
112 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: last line).
114 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: first line).
117 030916b5 2018-07-12 stsp The commands for
119 030916b5 2018-07-12 stsp are as follows:
120 030916b5 2018-07-12 stsp .Bl -tag -width blame
124 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
125 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
126 56c96eff 2022-08-30 thomas .Op Ar path
128 030916b5 2018-07-12 stsp Display history of a repository.
131 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
132 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
134 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
135 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
136 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
138 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
140 030916b5 2018-07-12 stsp The key bindings for
141 030916b5 2018-07-12 stsp .Cm tog log
142 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
143 030916b5 2018-07-12 stsp .Bl -tag -width Ds
144 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, >, Full stop, Ctrl-n
145 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
146 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, <, Comma, Ctrl-p
147 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
148 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
149 07b0611c 2022-06-23 thomas Scroll log message field to the right N increments (default: 1).
151 d74d8993 2022-06-23 thomas Log message moves left on the screen.
152 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
153 07b0611c 2022-06-23 thomas Scroll log message field to the left N increments (default: 1).
155 d74d8993 2022-06-23 thomas Log message moves right on the screen.
157 05171be4 2022-06-23 thomas Scroll log message field to the rightmost position.
159 05171be4 2022-06-23 thomas Scroll log message field to the leftmost position.
160 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
161 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
162 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
163 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
164 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
165 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
166 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
167 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
168 27890b18 2021-08-30 stsp .It Cm Home, g
169 912a3f79 2021-08-30 j Move the cursor to the newest commit.
171 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
172 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
173 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
174 4b06140e 2022-03-22 thomas If needed, this operation can be cancelled with
177 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
178 4c2d69cb 2022-06-23 thomas .It Cm Enter
181 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
185 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
186 5036bf37 2018-09-24 stsp .It Cm Backspace
187 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
188 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
190 678cbce5 2019-07-28 stsp .Cm Backspace
191 26f0cb24 2021-08-30 j aborts the running operation.
193 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
194 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
195 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
196 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
197 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
198 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
200 aadc20e8 2022-09-23 thomas Prompt for a pattern and limit the log view's list of commits to those
201 aadc20e8 2022-09-23 thomas which match the pattern.
202 aadc20e8 2022-09-23 thomas If no pattern is specified, i.e. the
204 aadc20e8 2022-09-23 thomas prompt is immediately closed with the Enter key, then the pattern is
206 aadc20e8 2022-09-23 thomas Until the pattern is cleared, the limited list of commits replaces the
207 aadc20e8 2022-09-23 thomas full list of commits for all operations supported by the log view.
208 aadc20e8 2022-09-23 thomas For example, a search started with
210 aadc20e8 2022-09-23 thomas will search the limited list of commits, rather than searching all commits.
211 aadc20e8 2022-09-23 thomas The pattern is an extended regular expression which is matched
212 aadc20e8 2022-09-23 thomas against a commit's author name, committer name, log message, and
213 aadc20e8 2022-09-23 thomas commit ID SHA1 hash.
214 aadc20e8 2022-09-23 thomas Regular expression syntax is documented in
215 aadc20e8 2022-09-23 thomas .Xr re_format 7 .
217 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
219 634cb454 2022-07-03 thomas Searching continues until either a match is found or
222 678cbce5 2019-07-28 stsp .Cm Backspace
223 678cbce5 2019-07-28 stsp key is pressed.
225 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
226 07b0611c 2022-06-23 thomas (default: 1).
228 634cb454 2022-07-03 thomas Searching continues until either a match is found or
231 678cbce5 2019-07-28 stsp .Cm Backspace
232 678cbce5 2019-07-28 stsp key is pressed.
233 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
236 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
240 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
243 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
247 38cb327b 2020-11-24 stsp view listing all references in the repository.
248 38cb327b 2020-11-24 stsp This can then be used to open a new
250 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
252 8eca0bdb 2023-01-02 thomas Toggle between showing the committer name and the author name.
255 030916b5 2018-07-12 stsp The options for
256 030916b5 2018-07-12 stsp .Cm tog log
257 030916b5 2018-07-12 stsp are as follows:
258 030916b5 2018-07-12 stsp .Bl -tag -width Ds
260 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
261 1137e0ae 2020-01-27 stsp from other branches.
262 b672a97a 2020-01-27 stsp By default,
263 b672a97a 2020-01-27 stsp .Cm tog log
264 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
267 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
268 030916b5 2018-07-12 stsp .It Fl c Ar commit
269 030916b5 2018-07-12 stsp Start traversing history at the specified
270 030916b5 2018-07-12 stsp .Ar commit .
271 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
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.
274 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
275 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
276 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
277 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
278 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
279 ecb28ae0 2018-07-16 stsp working directory.
280 212b39d1 2020-02-24 naddy If this directory is a
282 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
286 56c96eff 2022-08-30 thomas .Op Fl aw
287 56c96eff 2022-08-30 thomas .Op Fl C Ar number
288 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
289 56c96eff 2022-08-30 thomas .Ar object1
290 56c96eff 2022-08-30 thomas .Ar object2
292 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
293 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
294 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
295 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
296 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
297 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
299 030916b5 2018-07-12 stsp The key bindings for
300 030916b5 2018-07-12 stsp .Cm tog diff
301 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
302 030916b5 2018-07-12 stsp .Bl -tag -width Ds
304 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
306 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
307 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
308 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
309 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
310 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
311 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
313 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
314 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
315 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
317 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
319 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
321 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
322 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
323 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
324 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
325 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
326 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
327 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
328 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
329 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
330 00f6361c 2021-08-30 naddy .It Cm Home, g
331 912a3f79 2021-08-30 j Scroll to the top of the view.
333 912a3f79 2021-08-30 j Scroll to the bottom of the view.
334 82c78e96 2022-08-06 thomas .It Cm \&(
335 82c78e96 2022-08-06 thomas Navigate to the Nth previous file in the diff (default: 1).
336 82c78e96 2022-08-06 thomas .It Cm \&)
337 82c78e96 2022-08-06 thomas Navigate to the Nth next file in the diff (default: 1).
338 82c78e96 2022-08-06 thomas .It Cm \&{
339 82c78e96 2022-08-06 thomas Navigate to the Nth previous hunk in the diff (default: 1).
340 82c78e96 2022-08-06 thomas .It Cm \&}
341 82c78e96 2022-08-06 thomas Navigate to the Nth next hunk in the diff (default: 1).
343 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
345 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
346 777aae21 2022-07-20 thomas .It Cm <, Comma, K
349 01ca22b1 2020-12-07 stsp view was opened via the
351 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
352 4fc71f3b 2022-07-12 thomas If the diff was opened via the
353 4fc71f3b 2022-07-12 thomas .Cm blame
354 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
355 4fc71f3b 2022-07-12 thomas (default: 1).
356 777aae21 2022-07-20 thomas .It Cm >, Full stop, J
359 01ca22b1 2020-12-07 stsp view was opened via the
361 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
362 4fc71f3b 2022-07-12 thomas If the diff was opened via the
363 4fc71f3b 2022-07-12 thomas .Cm blame
364 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
366 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
367 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
368 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
369 66dc9065 2020-02-15 stsp .Xr re_format 7 .
371 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
373 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
374 07b0611c 2022-06-23 thomas (default: 1).
376 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
378 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
379 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
380 d40a767d 2022-07-03 thomas Patience (slow and tidy).
381 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
382 adf4c9e0 2022-07-03 thomas .Cm blame
386 09b5bff8 2020-02-23 naddy The options for
387 09b5bff8 2020-02-23 naddy .Cm tog diff
388 09b5bff8 2020-02-23 naddy are as follows:
389 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
391 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
392 3dbaef42 2020-11-24 stsp .It Fl C Ar number
393 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
394 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
395 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
396 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
397 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
398 09b5bff8 2020-02-23 naddy working directory.
399 212b39d1 2020-02-24 naddy If this directory is a
401 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
403 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
406 56c96eff 2022-08-30 thomas .Cm blame
407 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
408 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
411 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
413 030916b5 2018-07-12 stsp The key bindings for
414 030916b5 2018-07-12 stsp .Cm tog blame
415 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
416 030916b5 2018-07-12 stsp .Bl -tag -width Ds
417 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
418 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
419 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
420 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
421 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
422 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
424 d74d8993 2022-06-23 thomas File output moves left on the screen.
425 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
426 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
428 d74d8993 2022-06-23 thomas File output moves right on the screen.
430 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
432 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
433 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
434 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
435 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
436 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
437 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
438 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
439 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
440 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
441 4deef56f 2021-09-02 naddy .It Cm Home, g
442 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
443 4deef56f 2021-09-02 naddy .It Cm End, G
444 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
445 030916b5 2018-07-12 stsp .It Cm Enter
448 030916b5 2018-07-12 stsp view for the currently selected line's commit.
452 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
453 c0d30c23 2018-10-07 stsp selected line's commit.
457 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
458 c0d30c23 2018-10-07 stsp currently selected line's commit.
462 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
466 eaeaa612 2022-07-20 thomas view for the currently selected annotated line.
468 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
469 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
470 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
471 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
473 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
475 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
476 07b0611c 2022-06-23 thomas (default: 1).
478 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
479 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
480 d40a767d 2022-07-03 thomas Patience (slow and tidy).
481 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
486 030916b5 2018-07-12 stsp The options for
487 030916b5 2018-07-12 stsp .Cm tog blame
488 030916b5 2018-07-12 stsp are as follows:
489 030916b5 2018-07-12 stsp .Bl -tag -width Ds
490 030916b5 2018-07-12 stsp .It Fl c Ar commit
491 030916b5 2018-07-12 stsp Start traversing history at the specified
492 030916b5 2018-07-12 stsp .Ar commit .
493 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
494 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
495 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
496 69069811 2018-08-02 stsp .It Fl r Ar repository-path
497 69069811 2018-08-02 stsp Use the repository at the specified path.
498 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
499 69069811 2018-08-02 stsp working directory.
500 212b39d1 2020-02-24 naddy If this directory is a
502 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
506 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
507 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
508 56c96eff 2022-08-30 thomas .Op Ar path
510 030916b5 2018-07-12 stsp Display the repository tree.
513 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
515 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
516 848d6979 2019-08-12 stsp .Bl -column YXZ description
517 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
518 848d6979 2019-08-12 stsp .It / Ta entry is a directory
519 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
520 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
523 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
525 030916b5 2018-07-12 stsp The key bindings for
526 030916b5 2018-07-12 stsp .Cm tog tree
527 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
528 030916b5 2018-07-12 stsp .Bl -tag -width Ds
529 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
530 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
531 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
532 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
533 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
534 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
535 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
536 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
537 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
538 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
539 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
540 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
541 e4526bf5 2021-09-03 naddy .It Cm Home, g
542 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
543 e4526bf5 2021-09-03 naddy .It Cm End, G
544 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
545 030916b5 2018-07-12 stsp .It Cm Enter
546 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
548 030916b5 2018-07-12 stsp view for the currently selected file.
552 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
556 152c1c93 2020-11-29 stsp view listing all references in the repository.
557 152c1c93 2020-11-29 stsp This can then be used to open a new
559 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
560 7837eeac 2018-09-24 stsp .It Cm Backspace
561 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
563 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
567 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
568 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
569 4eec20aa 2019-06-22 stsp against the tree entry's name.
570 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
571 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
573 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
574 07b0611c 2022-06-23 thomas (default: 1).
576 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
577 07b0611c 2022-06-23 thomas (default: 1).
580 030916b5 2018-07-12 stsp The options for
581 030916b5 2018-07-12 stsp .Cm tog tree
582 030916b5 2018-07-12 stsp are as follows:
583 030916b5 2018-07-12 stsp .Bl -tag -width Ds
584 030916b5 2018-07-12 stsp .It Fl c Ar commit
585 030916b5 2018-07-12 stsp Start traversing history at the specified
586 030916b5 2018-07-12 stsp .Ar commit .
587 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
588 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
589 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
590 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
591 38cb327b 2020-11-24 stsp Use the repository at the specified path.
592 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
593 38cb327b 2020-11-24 stsp working directory.
594 38cb327b 2020-11-24 stsp If this directory is a
596 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
598 56c96eff 2022-08-30 thomas .It Cm ref Op Fl r Ar repository-path
599 38cb327b 2020-11-24 stsp Display references in the repository.
601 38cb327b 2020-11-24 stsp The key bindings for
602 38cb327b 2020-11-24 stsp .Cm tog ref
603 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
604 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
605 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
606 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
607 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
608 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
609 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
610 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
611 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
612 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
613 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
614 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
615 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
616 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
617 e4526bf5 2021-09-03 naddy .It Cm Home, g
618 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
619 e4526bf5 2021-09-03 naddy .It Cm End, G
620 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
621 38cb327b 2020-11-24 stsp .It Cm Enter
624 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
625 38cb327b 2020-11-24 stsp currently selected reference.
629 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
631 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
635 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
637 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
639 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
640 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
641 38cb327b 2020-11-24 stsp against absolute reference names.
642 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
643 38cb327b 2020-11-24 stsp .Xr re_format 7 .
645 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
646 07b0611c 2022-06-23 thomas (default: 1).
648 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
649 07b0611c 2022-06-23 thomas (default: 1).
650 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
651 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
656 38cb327b 2020-11-24 stsp The options for
657 38cb327b 2020-11-24 stsp .Cm tog ref
658 38cb327b 2020-11-24 stsp are as follows:
659 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
660 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
661 74283ab8 2020-02-07 stsp Use the repository at the specified path.
662 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
663 74283ab8 2020-02-07 stsp working directory.
664 74283ab8 2020-02-07 stsp If this directory is a
666 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
669 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
670 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
671 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
672 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
674 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
675 d40a767d 2022-07-03 thomas Patience (slow and tidy).
676 d40a767d 2022-07-03 thomas Valid values for
677 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
679 adf4c9e0 2022-07-03 thomas .Dq patience
681 adf4c9e0 2022-07-03 thomas .Dq myers .
682 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
683 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
684 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
685 0b948cdd 2022-07-04 thomas If set to
690 569abcd7 2022-07-12 thomas will use horizontal split by default.
691 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
694 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
695 569abcd7 2022-07-12 thomas at run-time.
696 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
698 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
699 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
700 6d17833f 2019-11-08 stsp variables documented below.
701 6d17833f 2019-11-08 stsp The colors available in color schemes are
702 6d17833f 2019-11-08 stsp .Dq black ,
704 6d17833f 2019-11-08 stsp .Dq green ,
705 6d17833f 2019-11-08 stsp .Dq yellow ,
707 93a300b2 2021-08-26 stsp .Dq magenta ,
710 1d7fe5cd 2019-11-08 stsp .Dq default
711 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
712 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
713 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
714 6d17833f 2019-11-08 stsp If not set, the default value
715 6d17833f 2019-11-08 stsp .Dq magenta
717 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
718 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
719 6d17833f 2019-11-08 stsp If not set, the default value
722 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
723 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
724 6d17833f 2019-11-08 stsp If not set, the default value
727 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
728 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
729 c0b01bdb 2019-11-08 stsp If not set, the default value
732 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
733 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
734 c0b01bdb 2019-11-08 stsp If not set, the default value
735 c0b01bdb 2019-11-08 stsp .Dq magenta
737 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
738 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
739 c0b01bdb 2019-11-08 stsp If not set, the default value
740 91b8c405 2020-01-25 stsp .Dq magenta
742 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
743 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
744 6d17833f 2019-11-08 stsp If not set, the default value
747 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
748 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
749 c0b01bdb 2019-11-08 stsp If not set, the default value
752 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
753 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
754 11b20872 2019-11-08 stsp If not set, the default value
757 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
758 11b20872 2019-11-08 stsp The color used to mark up author information.
759 11b20872 2019-11-08 stsp If not set, the default value
762 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
763 11b20872 2019-11-08 stsp The color used to mark up date information.
764 11b20872 2019-11-08 stsp If not set, the default value
767 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
768 38cb327b 2020-11-24 stsp The color used to mark up references in the
769 38cb327b 2020-11-24 stsp .Dq refs/heads/
771 38cb327b 2020-11-24 stsp If not set, the default value
774 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
775 38cb327b 2020-11-24 stsp The color used to mark up references in the
776 38cb327b 2020-11-24 stsp .Dq refs/tags/
778 38cb327b 2020-11-24 stsp If not set, the default value
779 38cb327b 2020-11-24 stsp .Dq magenta
781 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
782 38cb327b 2020-11-24 stsp The color used to mark up references in the
783 38cb327b 2020-11-24 stsp .Dq refs/remotes/
785 38cb327b 2020-11-24 stsp If not set, the default value
788 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
789 2183bbf6 2022-01-23 thomas The color used to mark up references in the
790 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
791 2183bbf6 2022-01-23 thomas namespace.
792 2183bbf6 2022-01-23 thomas If not set, the default value
796 030916b5 2018-07-12 stsp .Sh EXIT STATUS
797 030916b5 2018-07-12 stsp .Ex -std tog
798 030916b5 2018-07-12 stsp .Sh SEE ALSO
799 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
800 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
801 56b9a4ca 2019-06-21 stsp .Xr re_format 7
802 030916b5 2018-07-12 stsp .Sh AUTHORS
803 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
804 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
805 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
806 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
807 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
808 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
809 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
810 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
