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 .
195 7e8004ba 2022-09-11 thomas but hides the non-matching commits.
196 7e8004ba 2022-09-11 thomas Use the empty string as a pattern to display all commits.
198 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
200 634cb454 2022-07-03 thomas Searching continues until either a match is found or
203 678cbce5 2019-07-28 stsp .Cm Backspace
204 678cbce5 2019-07-28 stsp key is pressed.
206 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
207 07b0611c 2022-06-23 thomas (default: 1).
209 634cb454 2022-07-03 thomas Searching continues until either a match is found or
212 678cbce5 2019-07-28 stsp .Cm Backspace
213 678cbce5 2019-07-28 stsp key is pressed.
214 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
217 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
221 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
224 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
228 38cb327b 2020-11-24 stsp view listing all references in the repository.
229 38cb327b 2020-11-24 stsp This can then be used to open a new
231 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
233 f69c5a46 2022-07-19 thomas Toggle between showing the author and the committer name.
236 030916b5 2018-07-12 stsp The options for
237 030916b5 2018-07-12 stsp .Cm tog log
238 030916b5 2018-07-12 stsp are as follows:
239 030916b5 2018-07-12 stsp .Bl -tag -width Ds
241 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
242 1137e0ae 2020-01-27 stsp from other branches.
243 b672a97a 2020-01-27 stsp By default,
244 b672a97a 2020-01-27 stsp .Cm tog log
245 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
248 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
249 030916b5 2018-07-12 stsp .It Fl c Ar commit
250 030916b5 2018-07-12 stsp Start traversing history at the specified
251 030916b5 2018-07-12 stsp .Ar commit .
252 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
253 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
254 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
255 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
256 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
257 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
258 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
259 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
260 ecb28ae0 2018-07-16 stsp working directory.
261 212b39d1 2020-02-24 naddy If this directory is a
263 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
267 56c96eff 2022-08-30 thomas .Op Fl aw
268 56c96eff 2022-08-30 thomas .Op Fl C Ar number
269 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
270 56c96eff 2022-08-30 thomas .Ar object1
271 56c96eff 2022-08-30 thomas .Ar object2
273 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
274 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
275 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
276 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
277 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
278 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
280 030916b5 2018-07-12 stsp The key bindings for
281 030916b5 2018-07-12 stsp .Cm tog diff
282 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
283 030916b5 2018-07-12 stsp .Bl -tag -width Ds
285 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
287 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
288 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
289 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
290 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
291 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
292 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
294 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
295 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
296 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
298 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
300 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
302 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
303 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
304 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
305 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
306 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
307 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
308 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
309 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
310 07b0611c 2022-06-23 thomas Scroll up N half pages (default: 1).
311 00f6361c 2021-08-30 naddy .It Cm Home, g
312 912a3f79 2021-08-30 j Scroll to the top of the view.
314 912a3f79 2021-08-30 j Scroll to the bottom of the view.
315 82c78e96 2022-08-06 thomas .It Cm \&(
316 82c78e96 2022-08-06 thomas Navigate to the Nth previous file in the diff (default: 1).
317 82c78e96 2022-08-06 thomas .It Cm \&)
318 82c78e96 2022-08-06 thomas Navigate to the Nth next file in the diff (default: 1).
319 82c78e96 2022-08-06 thomas .It Cm \&{
320 82c78e96 2022-08-06 thomas Navigate to the Nth previous hunk in the diff (default: 1).
321 82c78e96 2022-08-06 thomas .It Cm \&}
322 82c78e96 2022-08-06 thomas Navigate to the Nth next hunk in the diff (default: 1).
324 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
326 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
327 777aae21 2022-07-20 thomas .It Cm <, Comma, K
330 01ca22b1 2020-12-07 stsp view was opened via the
332 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
333 4fc71f3b 2022-07-12 thomas If the diff was opened via the
334 4fc71f3b 2022-07-12 thomas .Cm blame
335 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
336 4fc71f3b 2022-07-12 thomas (default: 1).
337 777aae21 2022-07-20 thomas .It Cm >, Full stop, J
340 01ca22b1 2020-12-07 stsp view was opened via the
342 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
343 4fc71f3b 2022-07-12 thomas If the diff was opened via the
344 4fc71f3b 2022-07-12 thomas .Cm blame
345 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
347 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
348 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
349 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
350 66dc9065 2020-02-15 stsp .Xr re_format 7 .
352 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
354 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
355 07b0611c 2022-06-23 thomas (default: 1).
357 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
359 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
360 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
361 d40a767d 2022-07-03 thomas Patience (slow and tidy).
362 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
363 adf4c9e0 2022-07-03 thomas .Cm blame
367 09b5bff8 2020-02-23 naddy The options for
368 09b5bff8 2020-02-23 naddy .Cm tog diff
369 09b5bff8 2020-02-23 naddy are as follows:
370 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
372 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
373 3dbaef42 2020-11-24 stsp .It Fl C Ar number
374 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
375 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
376 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
377 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
378 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
379 09b5bff8 2020-02-23 naddy working directory.
380 212b39d1 2020-02-24 naddy If this directory is a
382 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
384 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
387 56c96eff 2022-08-30 thomas .Cm blame
388 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
389 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
392 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
394 030916b5 2018-07-12 stsp The key bindings for
395 030916b5 2018-07-12 stsp .Cm tog blame
396 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
397 030916b5 2018-07-12 stsp .Bl -tag -width Ds
398 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
399 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
400 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
401 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
402 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
403 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
405 d74d8993 2022-06-23 thomas File output moves left on the screen.
406 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
407 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
409 d74d8993 2022-06-23 thomas File output moves right on the screen.
411 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
413 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
414 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
415 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
416 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
417 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
418 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
419 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
420 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
421 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
422 4deef56f 2021-09-02 naddy .It Cm Home, g
423 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
424 4deef56f 2021-09-02 naddy .It Cm End, G
425 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
426 030916b5 2018-07-12 stsp .It Cm Enter
429 030916b5 2018-07-12 stsp view for the currently selected line's commit.
433 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
434 c0d30c23 2018-10-07 stsp selected line's commit.
438 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
439 c0d30c23 2018-10-07 stsp currently selected line's commit.
443 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
447 eaeaa612 2022-07-20 thomas view for the currently selected annotated line.
449 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
450 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
451 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
452 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
454 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
456 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
457 07b0611c 2022-06-23 thomas (default: 1).
459 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
460 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
461 d40a767d 2022-07-03 thomas Patience (slow and tidy).
462 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
467 030916b5 2018-07-12 stsp The options for
468 030916b5 2018-07-12 stsp .Cm tog blame
469 030916b5 2018-07-12 stsp are as follows:
470 030916b5 2018-07-12 stsp .Bl -tag -width Ds
471 030916b5 2018-07-12 stsp .It Fl c Ar commit
472 030916b5 2018-07-12 stsp Start traversing history at the specified
473 030916b5 2018-07-12 stsp .Ar commit .
474 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
475 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
476 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
477 69069811 2018-08-02 stsp .It Fl r Ar repository-path
478 69069811 2018-08-02 stsp Use the repository at the specified path.
479 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
480 69069811 2018-08-02 stsp working directory.
481 212b39d1 2020-02-24 naddy If this directory is a
483 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
487 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
488 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
489 56c96eff 2022-08-30 thomas .Op Ar path
491 030916b5 2018-07-12 stsp Display the repository tree.
494 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
496 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
497 848d6979 2019-08-12 stsp .Bl -column YXZ description
498 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
499 848d6979 2019-08-12 stsp .It / Ta entry is a directory
500 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
501 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
504 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
506 030916b5 2018-07-12 stsp The key bindings for
507 030916b5 2018-07-12 stsp .Cm tog tree
508 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
509 030916b5 2018-07-12 stsp .Bl -tag -width Ds
510 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
511 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
512 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
513 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
514 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
515 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
516 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
517 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
518 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
519 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
520 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
521 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
522 e4526bf5 2021-09-03 naddy .It Cm Home, g
523 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
524 e4526bf5 2021-09-03 naddy .It Cm End, G
525 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
526 030916b5 2018-07-12 stsp .It Cm Enter
527 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
529 030916b5 2018-07-12 stsp view for the currently selected file.
533 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
537 152c1c93 2020-11-29 stsp view listing all references in the repository.
538 152c1c93 2020-11-29 stsp This can then be used to open a new
540 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
541 7837eeac 2018-09-24 stsp .It Cm Backspace
542 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
544 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
548 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
549 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
550 4eec20aa 2019-06-22 stsp against the tree entry's name.
551 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
552 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
554 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
555 07b0611c 2022-06-23 thomas (default: 1).
557 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
558 07b0611c 2022-06-23 thomas (default: 1).
561 030916b5 2018-07-12 stsp The options for
562 030916b5 2018-07-12 stsp .Cm tog tree
563 030916b5 2018-07-12 stsp are as follows:
564 030916b5 2018-07-12 stsp .Bl -tag -width Ds
565 030916b5 2018-07-12 stsp .It Fl c Ar commit
566 030916b5 2018-07-12 stsp Start traversing history at the specified
567 030916b5 2018-07-12 stsp .Ar commit .
568 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
569 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
570 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
571 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
572 38cb327b 2020-11-24 stsp Use the repository at the specified path.
573 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
574 38cb327b 2020-11-24 stsp working directory.
575 38cb327b 2020-11-24 stsp If this directory is a
577 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
579 56c96eff 2022-08-30 thomas .It Cm ref Op Fl r Ar repository-path
580 38cb327b 2020-11-24 stsp Display references in the repository.
582 38cb327b 2020-11-24 stsp The key bindings for
583 38cb327b 2020-11-24 stsp .Cm tog ref
584 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
585 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
586 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
587 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
588 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
589 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
590 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
591 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
592 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
593 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
594 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
595 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
596 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
597 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
598 e4526bf5 2021-09-03 naddy .It Cm Home, g
599 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
600 e4526bf5 2021-09-03 naddy .It Cm End, G
601 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
602 38cb327b 2020-11-24 stsp .It Cm Enter
605 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
606 38cb327b 2020-11-24 stsp currently selected reference.
610 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
612 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
616 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
618 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
620 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
621 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
622 38cb327b 2020-11-24 stsp against absolute reference names.
623 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
624 38cb327b 2020-11-24 stsp .Xr re_format 7 .
626 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
627 07b0611c 2022-06-23 thomas (default: 1).
629 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
630 07b0611c 2022-06-23 thomas (default: 1).
631 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
632 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
637 38cb327b 2020-11-24 stsp The options for
638 38cb327b 2020-11-24 stsp .Cm tog ref
639 38cb327b 2020-11-24 stsp are as follows:
640 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
641 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
642 74283ab8 2020-02-07 stsp Use the repository at the specified path.
643 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
644 74283ab8 2020-02-07 stsp working directory.
645 74283ab8 2020-02-07 stsp If this directory is a
647 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
650 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
651 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
652 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
653 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
655 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
656 d40a767d 2022-07-03 thomas Patience (slow and tidy).
657 d40a767d 2022-07-03 thomas Valid values for
658 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
660 adf4c9e0 2022-07-03 thomas .Dq patience
662 adf4c9e0 2022-07-03 thomas .Dq myers .
663 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
664 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
665 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
666 0b948cdd 2022-07-04 thomas If set to
671 569abcd7 2022-07-12 thomas will use horizontal split by default.
672 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
675 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
676 569abcd7 2022-07-12 thomas at run-time.
677 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
679 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
680 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
681 6d17833f 2019-11-08 stsp variables documented below.
682 6d17833f 2019-11-08 stsp The colors available in color schemes are
683 6d17833f 2019-11-08 stsp .Dq black ,
685 6d17833f 2019-11-08 stsp .Dq green ,
686 6d17833f 2019-11-08 stsp .Dq yellow ,
688 93a300b2 2021-08-26 stsp .Dq magenta ,
691 1d7fe5cd 2019-11-08 stsp .Dq default
692 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
693 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
694 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
695 6d17833f 2019-11-08 stsp If not set, the default value
696 6d17833f 2019-11-08 stsp .Dq magenta
698 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
699 6d17833f 2019-11-08 stsp The color used to mark up added 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_CHUNK_HEADER
704 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
705 6d17833f 2019-11-08 stsp If not set, the default value
708 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
709 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
710 c0b01bdb 2019-11-08 stsp If not set, the default value
713 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
714 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
715 c0b01bdb 2019-11-08 stsp If not set, the default value
716 c0b01bdb 2019-11-08 stsp .Dq magenta
718 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
719 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
720 c0b01bdb 2019-11-08 stsp If not set, the default value
721 91b8c405 2020-01-25 stsp .Dq magenta
723 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
724 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
725 6d17833f 2019-11-08 stsp If not set, the default value
728 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
729 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
730 c0b01bdb 2019-11-08 stsp If not set, the default value
733 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
734 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
735 11b20872 2019-11-08 stsp If not set, the default value
738 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
739 11b20872 2019-11-08 stsp The color used to mark up author information.
740 11b20872 2019-11-08 stsp If not set, the default value
743 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
744 11b20872 2019-11-08 stsp The color used to mark up date information.
745 11b20872 2019-11-08 stsp If not set, the default value
748 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
749 38cb327b 2020-11-24 stsp The color used to mark up references in the
750 38cb327b 2020-11-24 stsp .Dq refs/heads/
752 38cb327b 2020-11-24 stsp If not set, the default value
755 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
756 38cb327b 2020-11-24 stsp The color used to mark up references in the
757 38cb327b 2020-11-24 stsp .Dq refs/tags/
759 38cb327b 2020-11-24 stsp If not set, the default value
760 38cb327b 2020-11-24 stsp .Dq magenta
762 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
763 38cb327b 2020-11-24 stsp The color used to mark up references in the
764 38cb327b 2020-11-24 stsp .Dq refs/remotes/
766 38cb327b 2020-11-24 stsp If not set, the default value
769 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
770 2183bbf6 2022-01-23 thomas The color used to mark up references in the
771 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
772 2183bbf6 2022-01-23 thomas namespace.
773 2183bbf6 2022-01-23 thomas If not set, the default value
777 030916b5 2018-07-12 stsp .Sh EXIT STATUS
778 030916b5 2018-07-12 stsp .Ex -std tog
779 030916b5 2018-07-12 stsp .Sh SEE ALSO
780 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
781 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
782 56b9a4ca 2019-06-21 stsp .Xr re_format 7
783 030916b5 2018-07-12 stsp .Sh AUTHORS
784 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
785 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
786 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
787 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
788 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
789 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
790 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
791 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
