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
72 fc2737d5 2022-09-15 thomas .It Cm H, F1
73 fc2737d5 2022-09-15 thomas Display run-time help.
74 fc2737d5 2022-09-15 thomas Key bindings for the focussed view will be displayed.
75 fc2737d5 2022-09-15 thomas Pressing this again inside the help view will toggle the display of
76 fc2737d5 2022-09-15 thomas key bindings for all
83 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
85 c0d30c23 2018-10-07 stsp Switch focus between views.
87 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
89 b1c950bf 2022-07-12 thomas will automatically use vertical split-screen views if the size of the
90 b1c950bf 2022-07-12 thomas terminal window is sufficiently large.
92 569abcd7 2022-07-12 thomas Switch the current split-screen layout, and render all active views in
93 569abcd7 2022-07-12 thomas this new layout.
94 b1c950bf 2022-07-12 thomas The split-screen layout can be either vertical or horizontal.
95 569abcd7 2022-07-12 thomas If the terminal is not wide enough when switching to a vertical split,
96 569abcd7 2022-07-12 thomas views will render in fullscreen.
98 53d2bdd3 2022-07-10 thomas When in a split-screen view, decrease the size of the focussed split
99 53d2bdd3 2022-07-10 thomas N increments (default: 1).
101 53d2bdd3 2022-07-10 thomas When in a split-screen view, increase the size of the focussed split
102 53d2bdd3 2022-07-10 thomas N increments (default: 1).
104 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: last line).
106 07dd3ed3 2022-08-06 thomas Go to line N in the view (default: first line).
109 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
110 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
112 030916b5 2018-07-12 stsp Display usage information.
113 1795b260 2021-04-02 kn .It Fl V , -version
114 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
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 .
202 7e8004ba 2022-09-11 thomas but hides the non-matching commits.
203 7e8004ba 2022-09-11 thomas Use the empty string as a pattern to display all commits.
205 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
207 634cb454 2022-07-03 thomas Searching continues until either a match is found or
210 678cbce5 2019-07-28 stsp .Cm Backspace
211 678cbce5 2019-07-28 stsp key is pressed.
213 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
214 07b0611c 2022-06-23 thomas (default: 1).
216 634cb454 2022-07-03 thomas Searching continues until either a match is found or
219 678cbce5 2019-07-28 stsp .Cm Backspace
220 678cbce5 2019-07-28 stsp key is pressed.
221 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
224 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
228 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
231 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
235 38cb327b 2020-11-24 stsp view listing all references in the repository.
236 38cb327b 2020-11-24 stsp This can then be used to open a new
238 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
240 f69c5a46 2022-07-19 thomas Toggle between showing the author and the committer name.
243 030916b5 2018-07-12 stsp The options for
244 030916b5 2018-07-12 stsp .Cm tog log
245 030916b5 2018-07-12 stsp are as follows:
246 030916b5 2018-07-12 stsp .Bl -tag -width Ds
248 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
249 1137e0ae 2020-01-27 stsp from other branches.
250 b672a97a 2020-01-27 stsp By default,
251 b672a97a 2020-01-27 stsp .Cm tog log
252 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
255 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
256 030916b5 2018-07-12 stsp .It Fl c Ar commit
257 030916b5 2018-07-12 stsp Start traversing history at the specified
258 030916b5 2018-07-12 stsp .Ar commit .
259 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
260 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
261 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
262 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
263 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
264 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
265 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
266 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
267 ecb28ae0 2018-07-16 stsp working directory.
268 212b39d1 2020-02-24 naddy If this directory is a
270 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
274 56c96eff 2022-08-30 thomas .Op Fl aw
275 56c96eff 2022-08-30 thomas .Op Fl C Ar number
276 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
277 56c96eff 2022-08-30 thomas .Ar object1
278 56c96eff 2022-08-30 thomas .Ar object2
280 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
281 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
282 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
283 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
284 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
285 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
287 030916b5 2018-07-12 stsp The key bindings for
288 030916b5 2018-07-12 stsp .Cm tog diff
289 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
290 030916b5 2018-07-12 stsp .Bl -tag -width Ds
292 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
294 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
295 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
296 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
297 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
298 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
299 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
301 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
302 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
303 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
305 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
307 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
309 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
310 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
311 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
312 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
313 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
314 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
315 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
316 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
317 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
318 00f6361c 2021-08-30 naddy .It Cm Home, g
319 912a3f79 2021-08-30 j Scroll to the top of the view.
321 912a3f79 2021-08-30 j Scroll to the bottom of the view.
322 82c78e96 2022-08-06 thomas .It Cm \&(
323 82c78e96 2022-08-06 thomas Navigate to the Nth previous file in the diff (default: 1).
324 82c78e96 2022-08-06 thomas .It Cm \&)
325 82c78e96 2022-08-06 thomas Navigate to the Nth next file in the diff (default: 1).
326 82c78e96 2022-08-06 thomas .It Cm \&{
327 82c78e96 2022-08-06 thomas Navigate to the Nth previous hunk in the diff (default: 1).
328 82c78e96 2022-08-06 thomas .It Cm \&}
329 82c78e96 2022-08-06 thomas Navigate to the Nth next hunk in the diff (default: 1).
331 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
333 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
334 777aae21 2022-07-20 thomas .It Cm <, Comma, K
337 01ca22b1 2020-12-07 stsp view was opened via the
339 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
340 4fc71f3b 2022-07-12 thomas If the diff was opened via the
341 4fc71f3b 2022-07-12 thomas .Cm blame
342 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
343 4fc71f3b 2022-07-12 thomas (default: 1).
344 777aae21 2022-07-20 thomas .It Cm >, Full stop, J
347 01ca22b1 2020-12-07 stsp view was opened via the
349 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
350 4fc71f3b 2022-07-12 thomas If the diff was opened via the
351 4fc71f3b 2022-07-12 thomas .Cm blame
352 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
354 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
355 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
356 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
357 66dc9065 2020-02-15 stsp .Xr re_format 7 .
359 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
361 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
362 07b0611c 2022-06-23 thomas (default: 1).
364 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
366 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
367 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
368 d40a767d 2022-07-03 thomas Patience (slow and tidy).
369 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
370 adf4c9e0 2022-07-03 thomas .Cm blame
374 09b5bff8 2020-02-23 naddy The options for
375 09b5bff8 2020-02-23 naddy .Cm tog diff
376 09b5bff8 2020-02-23 naddy are as follows:
377 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
379 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
380 3dbaef42 2020-11-24 stsp .It Fl C Ar number
381 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
382 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
383 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
384 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
385 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
386 09b5bff8 2020-02-23 naddy working directory.
387 212b39d1 2020-02-24 naddy If this directory is a
389 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
391 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
394 56c96eff 2022-08-30 thomas .Cm blame
395 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
396 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
399 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
401 030916b5 2018-07-12 stsp The key bindings for
402 030916b5 2018-07-12 stsp .Cm tog blame
403 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
404 030916b5 2018-07-12 stsp .Bl -tag -width Ds
405 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
406 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
407 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
408 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
409 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
410 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
412 d74d8993 2022-06-23 thomas File output moves left on the screen.
413 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
414 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
416 d74d8993 2022-06-23 thomas File output moves right on the screen.
418 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
420 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
421 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
422 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
423 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
424 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
425 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
426 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
427 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
428 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
429 4deef56f 2021-09-02 naddy .It Cm Home, g
430 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
431 4deef56f 2021-09-02 naddy .It Cm End, G
432 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
433 030916b5 2018-07-12 stsp .It Cm Enter
436 030916b5 2018-07-12 stsp view for the currently selected line's commit.
440 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
441 c0d30c23 2018-10-07 stsp selected line's commit.
445 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
446 c0d30c23 2018-10-07 stsp currently selected line's commit.
450 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
454 eaeaa612 2022-07-20 thomas view for the currently selected annotated line.
456 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
457 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
458 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
459 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
461 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
463 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
464 07b0611c 2022-06-23 thomas (default: 1).
466 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
467 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
468 d40a767d 2022-07-03 thomas Patience (slow and tidy).
469 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
474 030916b5 2018-07-12 stsp The options for
475 030916b5 2018-07-12 stsp .Cm tog blame
476 030916b5 2018-07-12 stsp are as follows:
477 030916b5 2018-07-12 stsp .Bl -tag -width Ds
478 030916b5 2018-07-12 stsp .It Fl c Ar commit
479 030916b5 2018-07-12 stsp Start traversing history at the specified
480 030916b5 2018-07-12 stsp .Ar commit .
481 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
482 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
483 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
484 69069811 2018-08-02 stsp .It Fl r Ar repository-path
485 69069811 2018-08-02 stsp Use the repository at the specified path.
486 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
487 69069811 2018-08-02 stsp working directory.
488 212b39d1 2020-02-24 naddy If this directory is a
490 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
494 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
495 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
496 56c96eff 2022-08-30 thomas .Op Ar path
498 030916b5 2018-07-12 stsp Display the repository tree.
501 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
503 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
504 848d6979 2019-08-12 stsp .Bl -column YXZ description
505 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
506 848d6979 2019-08-12 stsp .It / Ta entry is a directory
507 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
508 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
511 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
513 030916b5 2018-07-12 stsp The key bindings for
514 030916b5 2018-07-12 stsp .Cm tog tree
515 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
516 030916b5 2018-07-12 stsp .Bl -tag -width Ds
517 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
518 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
519 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
520 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
521 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
522 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
523 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
524 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
525 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
526 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
527 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
528 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
529 e4526bf5 2021-09-03 naddy .It Cm Home, g
530 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
531 e4526bf5 2021-09-03 naddy .It Cm End, G
532 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
533 030916b5 2018-07-12 stsp .It Cm Enter
534 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
536 030916b5 2018-07-12 stsp view for the currently selected file.
540 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
544 152c1c93 2020-11-29 stsp view listing all references in the repository.
545 152c1c93 2020-11-29 stsp This can then be used to open a new
547 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
548 7837eeac 2018-09-24 stsp .It Cm Backspace
549 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
551 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
555 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
556 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
557 4eec20aa 2019-06-22 stsp against the tree entry's name.
558 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
559 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
561 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
562 07b0611c 2022-06-23 thomas (default: 1).
564 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
565 07b0611c 2022-06-23 thomas (default: 1).
568 030916b5 2018-07-12 stsp The options for
569 030916b5 2018-07-12 stsp .Cm tog tree
570 030916b5 2018-07-12 stsp are as follows:
571 030916b5 2018-07-12 stsp .Bl -tag -width Ds
572 030916b5 2018-07-12 stsp .It Fl c Ar commit
573 030916b5 2018-07-12 stsp Start traversing history at the specified
574 030916b5 2018-07-12 stsp .Ar commit .
575 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
576 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
577 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
578 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
579 38cb327b 2020-11-24 stsp Use the repository at the specified path.
580 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
581 38cb327b 2020-11-24 stsp working directory.
582 38cb327b 2020-11-24 stsp If this directory is a
584 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
586 56c96eff 2022-08-30 thomas .It Cm ref Op Fl r Ar repository-path
587 38cb327b 2020-11-24 stsp Display references in the repository.
589 38cb327b 2020-11-24 stsp The key bindings for
590 38cb327b 2020-11-24 stsp .Cm tog ref
591 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
592 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
593 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
594 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
595 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
596 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
597 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
598 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
599 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
600 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
601 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
602 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
603 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
604 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
605 e4526bf5 2021-09-03 naddy .It Cm Home, g
606 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
607 e4526bf5 2021-09-03 naddy .It Cm End, G
608 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
609 38cb327b 2020-11-24 stsp .It Cm Enter
612 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
613 38cb327b 2020-11-24 stsp currently selected reference.
617 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
619 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
623 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
625 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
627 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
628 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
629 38cb327b 2020-11-24 stsp against absolute reference names.
630 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
631 38cb327b 2020-11-24 stsp .Xr re_format 7 .
633 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
634 07b0611c 2022-06-23 thomas (default: 1).
636 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
637 07b0611c 2022-06-23 thomas (default: 1).
638 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
639 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
644 38cb327b 2020-11-24 stsp The options for
645 38cb327b 2020-11-24 stsp .Cm tog ref
646 38cb327b 2020-11-24 stsp are as follows:
647 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
648 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
649 74283ab8 2020-02-07 stsp Use the repository at the specified path.
650 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
651 74283ab8 2020-02-07 stsp working directory.
652 74283ab8 2020-02-07 stsp If this directory is a
654 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
657 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
658 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
659 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
660 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
662 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
663 d40a767d 2022-07-03 thomas Patience (slow and tidy).
664 d40a767d 2022-07-03 thomas Valid values for
665 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
667 adf4c9e0 2022-07-03 thomas .Dq patience
669 adf4c9e0 2022-07-03 thomas .Dq myers .
670 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
671 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
672 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
673 0b948cdd 2022-07-04 thomas If set to
678 569abcd7 2022-07-12 thomas will use horizontal split by default.
679 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
682 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
683 569abcd7 2022-07-12 thomas at run-time.
684 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
686 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
687 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
688 6d17833f 2019-11-08 stsp variables documented below.
689 6d17833f 2019-11-08 stsp The colors available in color schemes are
690 6d17833f 2019-11-08 stsp .Dq black ,
692 6d17833f 2019-11-08 stsp .Dq green ,
693 6d17833f 2019-11-08 stsp .Dq yellow ,
695 93a300b2 2021-08-26 stsp .Dq magenta ,
698 1d7fe5cd 2019-11-08 stsp .Dq default
699 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
700 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
701 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
702 6d17833f 2019-11-08 stsp If not set, the default value
703 6d17833f 2019-11-08 stsp .Dq magenta
705 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
706 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
707 6d17833f 2019-11-08 stsp If not set, the default value
710 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
711 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
712 6d17833f 2019-11-08 stsp If not set, the default value
715 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
716 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
717 c0b01bdb 2019-11-08 stsp If not set, the default value
720 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
721 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
722 c0b01bdb 2019-11-08 stsp If not set, the default value
723 c0b01bdb 2019-11-08 stsp .Dq magenta
725 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
726 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
727 c0b01bdb 2019-11-08 stsp If not set, the default value
728 91b8c405 2020-01-25 stsp .Dq magenta
730 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
731 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
732 6d17833f 2019-11-08 stsp If not set, the default value
735 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
736 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
737 c0b01bdb 2019-11-08 stsp If not set, the default value
740 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
741 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
742 11b20872 2019-11-08 stsp If not set, the default value
745 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
746 11b20872 2019-11-08 stsp The color used to mark up author information.
747 11b20872 2019-11-08 stsp If not set, the default value
750 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
751 11b20872 2019-11-08 stsp The color used to mark up date information.
752 11b20872 2019-11-08 stsp If not set, the default value
755 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
756 38cb327b 2020-11-24 stsp The color used to mark up references in the
757 38cb327b 2020-11-24 stsp .Dq refs/heads/
759 38cb327b 2020-11-24 stsp If not set, the default value
762 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
763 38cb327b 2020-11-24 stsp The color used to mark up references in the
764 38cb327b 2020-11-24 stsp .Dq refs/tags/
766 38cb327b 2020-11-24 stsp If not set, the default value
767 38cb327b 2020-11-24 stsp .Dq magenta
769 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
770 38cb327b 2020-11-24 stsp The color used to mark up references in the
771 38cb327b 2020-11-24 stsp .Dq refs/remotes/
773 38cb327b 2020-11-24 stsp If not set, the default value
776 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
777 2183bbf6 2022-01-23 thomas The color used to mark up references in the
778 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
779 2183bbf6 2022-01-23 thomas namespace.
780 2183bbf6 2022-01-23 thomas If not set, the default value
784 030916b5 2018-07-12 stsp .Sh EXIT STATUS
785 030916b5 2018-07-12 stsp .Ex -std tog
786 030916b5 2018-07-12 stsp .Sh SEE ALSO
787 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
788 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
789 56b9a4ca 2019-06-21 stsp .Xr re_format 7
790 030916b5 2018-07-12 stsp .Sh AUTHORS
791 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
792 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
793 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
794 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
795 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
796 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
797 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
798 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
