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 640cd7ff 2022-06-22 mark Some command-specific key bindings may be prefixed with an integer, which is
59 640cd7ff 2022-06-22 mark denoted by N in the descriptions below, and is used as a modifier to the
60 640cd7ff 2022-06-22 mark operation as indicated.
62 f0032ce6 2022-07-02 mark will echo digits to the screen when count modifiers are entered, and complete
63 f0032ce6 2022-07-02 mark the sequence upon input of the first non-numeric character.
64 f0032ce6 2022-07-02 mark Count modifiers can be aborted by entering an unmapped key.
65 a6d37fac 2022-07-03 mark Once a compound command is executed, the operation can be cancelled with
68 a6d37fac 2022-07-03 mark .Cm Backspace .
69 87aa0e98 2018-08-18 stsp The global key bindings are:
70 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
75 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
77 c0d30c23 2018-10-07 stsp Switch focus between views.
79 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
81 e9b3576f 2019-03-27 stsp will automatically use split-screen views if the size of the terminal
82 e9b3576f 2019-03-27 stsp window is sufficiently large.
84 2572d286 2022-07-12 stsp Switch the current split-screen layout, and render all active views in
85 2572d286 2022-07-12 stsp this new layout.
86 2572d286 2022-07-12 stsp If the terminal is not wide enough when switching to a vertical split,
87 2572d286 2022-07-12 stsp views will render in fullscreen.
89 3c1dfe12 2022-07-08 mark When in a split-screen view, decrease the size of the focussed split
90 3c1dfe12 2022-07-08 mark N increments (default: 1).
92 3c1dfe12 2022-07-08 mark When in a split-screen view, increase the size of the focussed split
93 3c1dfe12 2022-07-08 mark N increments (default: 1).
96 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
97 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
99 030916b5 2018-07-12 stsp Display usage information.
100 1795b260 2021-04-02 kn .It Fl V , -version
101 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
104 030916b5 2018-07-12 stsp The commands for
106 030916b5 2018-07-12 stsp are as follows:
107 030916b5 2018-07-12 stsp .Bl -tag -width blame
108 b672a97a 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
109 030916b5 2018-07-12 stsp Display history of a repository.
112 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
113 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
115 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
116 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
117 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
119 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
121 030916b5 2018-07-12 stsp The key bindings for
122 030916b5 2018-07-12 stsp .Cm tog log
123 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
124 030916b5 2018-07-12 stsp .Bl -tag -width Ds
125 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
126 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
127 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
128 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
129 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
130 640cd7ff 2022-06-22 mark Scroll log message field to the right N increments (default: 1).
132 f7443f66 2022-06-16 mark Log message moves left on the screen.
133 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
134 640cd7ff 2022-06-22 mark Scroll log message field to the left N increments (default: 1).
136 f7443f66 2022-06-16 mark Log message moves right on the screen.
138 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
140 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
141 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
142 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
143 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
144 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
145 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
146 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
147 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
148 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
149 27890b18 2021-08-30 stsp .It Cm Home, g
150 912a3f79 2021-08-30 j Move the cursor to the newest commit.
152 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
153 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
154 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
155 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
158 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
159 48bb96f0 2022-06-20 naddy .It Cm Enter
162 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
166 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
167 5036bf37 2018-09-24 stsp .It Cm Backspace
168 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
169 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
171 678cbce5 2019-07-28 stsp .Cm Backspace
172 26f0cb24 2021-08-30 j aborts the running operation.
174 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
175 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
176 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
177 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
178 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
179 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
181 640cd7ff 2022-06-22 mark Find the Nth next commit which matches the current search pattern (default: 1).
183 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
186 678cbce5 2019-07-28 stsp .Cm Backspace
187 678cbce5 2019-07-28 stsp key is pressed.
189 640cd7ff 2022-06-22 mark Find the Nth previous commit which matches the current search pattern
190 640cd7ff 2022-06-22 mark (default: 1).
192 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
195 678cbce5 2019-07-28 stsp .Cm Backspace
196 678cbce5 2019-07-28 stsp key is pressed.
197 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
200 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
204 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
207 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
211 38cb327b 2020-11-24 stsp view listing all references in the repository.
212 38cb327b 2020-11-24 stsp This can then be used to open a new
214 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
217 030916b5 2018-07-12 stsp The options for
218 030916b5 2018-07-12 stsp .Cm tog log
219 030916b5 2018-07-12 stsp are as follows:
220 030916b5 2018-07-12 stsp .Bl -tag -width Ds
222 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
223 1137e0ae 2020-01-27 stsp from other branches.
224 b672a97a 2020-01-27 stsp By default,
225 b672a97a 2020-01-27 stsp .Cm tog log
226 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
229 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
230 030916b5 2018-07-12 stsp .It Fl c Ar commit
231 030916b5 2018-07-12 stsp Start traversing history at the specified
232 030916b5 2018-07-12 stsp .Ar commit .
233 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
234 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
235 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
236 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
237 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
238 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
239 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
240 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
241 ecb28ae0 2018-07-16 stsp working directory.
242 212b39d1 2020-02-24 naddy If this directory is a
244 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
246 21920d7e 2020-12-07 stsp .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl w Oc Ar object1 Ar object2
247 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
248 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
249 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
250 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
251 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
252 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
254 030916b5 2018-07-12 stsp The key bindings for
255 030916b5 2018-07-12 stsp .Cm tog diff
256 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
257 030916b5 2018-07-12 stsp .Bl -tag -width Ds
259 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
261 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
262 640cd7ff 2022-06-22 mark Scroll down N lines (default: 1).
263 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
264 640cd7ff 2022-06-22 mark Scroll up N lines (default: 1).
265 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
266 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
268 f7443f66 2022-06-16 mark Diff output moves left on the screen.
269 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
270 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
272 f7443f66 2022-06-16 mark Diff output moves right on the screen.
274 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
276 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
277 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
278 640cd7ff 2022-06-22 mark Scroll down N pages (default: 1).
279 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
280 640cd7ff 2022-06-22 mark Scroll up N pages (default: 1).
281 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
282 640cd7ff 2022-06-22 mark Scroll down N half pages (default: 1).
283 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
284 640cd7ff 2022-06-22 mark Scroll up N half pages (default: 1).
285 00f6361c 2021-08-30 naddy .It Cm Home, g
286 912a3f79 2021-08-30 j Scroll to the top of the view.
288 912a3f79 2021-08-30 j Scroll to the bottom of the view.
290 640cd7ff 2022-06-22 mark Reduce diff context by N lines (default: 1).
292 640cd7ff 2022-06-22 mark Increase diff context by N lines (default: 1).
293 15a087fe 2019-02-21 stsp .It Cm <, Comma
296 01ca22b1 2020-12-07 stsp view was opened via the
298 c0f61fa4 2022-07-11 mark view, move to the Nth previous (younger) commit.
299 c0f61fa4 2022-07-11 mark If the diff was opened via the
301 c0f61fa4 2022-07-11 mark view, move to the Nth previous line and load the corresponding commit
302 c0f61fa4 2022-07-11 mark (default: 1).
303 15a087fe 2019-02-21 stsp .It Cm >, Full stop
306 01ca22b1 2020-12-07 stsp view was opened via the
308 c0f61fa4 2022-07-11 mark view, move to the Nth next (older) commit.
309 c0f61fa4 2022-07-11 mark If the diff was opened via the
311 c0f61fa4 2022-07-11 mark view, move to the Nth next line and load the corresponding commit (default: 1).
313 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
314 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
315 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
316 66dc9065 2020-02-15 stsp .Xr re_format 7 .
318 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
320 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
321 640cd7ff 2022-06-22 mark (default: 1).
323 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
325 917d79a7 2022-07-01 stsp Change the diff algorithm.
326 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
327 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
328 917d79a7 2022-07-01 stsp This is a global setting which also affects the
333 09b5bff8 2020-02-23 naddy The options for
334 09b5bff8 2020-02-23 naddy .Cm tog diff
335 09b5bff8 2020-02-23 naddy are as follows:
336 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
338 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
339 3dbaef42 2020-11-24 stsp .It Fl C Ar number
340 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
341 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
342 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
343 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
344 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
345 09b5bff8 2020-02-23 naddy working directory.
346 212b39d1 2020-02-24 naddy If this directory is a
348 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
350 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
352 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
353 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
355 030916b5 2018-07-12 stsp The key bindings for
356 030916b5 2018-07-12 stsp .Cm tog blame
357 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
358 030916b5 2018-07-12 stsp .Bl -tag -width Ds
359 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
360 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
361 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
362 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
363 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
364 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
366 f7443f66 2022-06-16 mark File output moves left on the screen.
367 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
368 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
370 f7443f66 2022-06-16 mark File output moves right on the screen.
372 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
374 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
375 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
376 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
377 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
378 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
379 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
380 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
381 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
382 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
383 4deef56f 2021-09-02 naddy .It Cm Home, g
384 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
385 4deef56f 2021-09-02 naddy .It Cm End, G
386 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
387 030916b5 2018-07-12 stsp .It Cm Enter
390 030916b5 2018-07-12 stsp view for the currently selected line's commit.
394 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
395 c0d30c23 2018-10-07 stsp selected line's commit.
399 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
400 c0d30c23 2018-10-07 stsp currently selected line's commit.
404 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
406 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
407 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
408 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
409 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
411 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
413 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
414 640cd7ff 2022-06-22 mark (default: 1).
416 917d79a7 2022-07-01 stsp Change the diff algorithm.
417 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
418 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
419 917d79a7 2022-07-01 stsp This is a global setting which also affects the
424 030916b5 2018-07-12 stsp The options for
425 030916b5 2018-07-12 stsp .Cm tog blame
426 030916b5 2018-07-12 stsp are as follows:
427 030916b5 2018-07-12 stsp .Bl -tag -width Ds
428 030916b5 2018-07-12 stsp .It Fl c Ar commit
429 030916b5 2018-07-12 stsp Start traversing history at the specified
430 030916b5 2018-07-12 stsp .Ar commit .
431 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
432 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
433 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
434 69069811 2018-08-02 stsp .It Fl r Ar repository-path
435 69069811 2018-08-02 stsp Use the repository at the specified path.
436 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
437 69069811 2018-08-02 stsp working directory.
438 212b39d1 2020-02-24 naddy If this directory is a
440 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
442 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
443 030916b5 2018-07-12 stsp Display the repository tree.
446 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
448 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
449 848d6979 2019-08-12 stsp .Bl -column YXZ description
450 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
451 848d6979 2019-08-12 stsp .It / Ta entry is a directory
452 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
453 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
456 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
458 030916b5 2018-07-12 stsp The key bindings for
459 030916b5 2018-07-12 stsp .Cm tog tree
460 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
461 030916b5 2018-07-12 stsp .Bl -tag -width Ds
462 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
463 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
464 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
465 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
466 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
467 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
468 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
469 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
470 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
471 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
472 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
473 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
474 e4526bf5 2021-09-03 naddy .It Cm Home, g
475 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
476 e4526bf5 2021-09-03 naddy .It Cm End, G
477 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
478 030916b5 2018-07-12 stsp .It Cm Enter
479 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
481 030916b5 2018-07-12 stsp view for the currently selected file.
485 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
489 152c1c93 2020-11-29 stsp view listing all references in the repository.
490 152c1c93 2020-11-29 stsp This can then be used to open a new
492 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
493 7837eeac 2018-09-24 stsp .It Cm Backspace
494 640cd7ff 2022-06-22 mark Move back to the Nth parent directory (default: 1).
496 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
500 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
501 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
502 4eec20aa 2019-06-22 stsp against the tree entry's name.
503 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
504 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
506 640cd7ff 2022-06-22 mark Find the Nth next tree entry which matches the current search pattern
507 640cd7ff 2022-06-22 mark (default: 1).
509 640cd7ff 2022-06-22 mark Find the Nth previous tree entry which matches the current search pattern
510 640cd7ff 2022-06-22 mark (default: 1).
513 030916b5 2018-07-12 stsp The options for
514 030916b5 2018-07-12 stsp .Cm tog tree
515 030916b5 2018-07-12 stsp are as follows:
516 030916b5 2018-07-12 stsp .Bl -tag -width Ds
517 030916b5 2018-07-12 stsp .It Fl c Ar commit
518 030916b5 2018-07-12 stsp Start traversing history at the specified
519 030916b5 2018-07-12 stsp .Ar commit .
520 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
521 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
522 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
523 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
524 38cb327b 2020-11-24 stsp Use the repository at the specified path.
525 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
526 38cb327b 2020-11-24 stsp working directory.
527 38cb327b 2020-11-24 stsp If this directory is a
529 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
531 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
532 38cb327b 2020-11-24 stsp Display references in the repository.
534 38cb327b 2020-11-24 stsp The key bindings for
535 38cb327b 2020-11-24 stsp .Cm tog ref
536 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
537 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
538 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
539 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
540 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
541 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
542 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
543 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
544 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
545 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
546 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
547 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
548 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
549 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
550 e4526bf5 2021-09-03 naddy .It Cm Home, g
551 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
552 e4526bf5 2021-09-03 naddy .It Cm End, G
553 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
554 38cb327b 2020-11-24 stsp .It Cm Enter
557 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
558 38cb327b 2020-11-24 stsp currently selected reference.
562 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
564 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
568 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
570 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
572 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
573 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
574 38cb327b 2020-11-24 stsp against absolute reference names.
575 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
576 38cb327b 2020-11-24 stsp .Xr re_format 7 .
578 640cd7ff 2022-06-22 mark Find the Nth next reference which matches the current search pattern
579 640cd7ff 2022-06-22 mark (default: 1).
581 640cd7ff 2022-06-22 mark Find the Nth previous reference which matches the current search pattern
582 640cd7ff 2022-06-22 mark (default: 1).
583 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
584 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
589 38cb327b 2020-11-24 stsp The options for
590 38cb327b 2020-11-24 stsp .Cm tog ref
591 38cb327b 2020-11-24 stsp are as follows:
592 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
593 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
594 74283ab8 2020-02-07 stsp Use the repository at the specified path.
595 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
596 74283ab8 2020-02-07 stsp working directory.
597 74283ab8 2020-02-07 stsp If this directory is a
599 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
602 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
603 d2366e29 2022-07-07 mark .Bl -tag -width TOG_VIEW_SPLIT_MODE
604 917d79a7 2022-07-01 stsp .It Ev TOG_DIFF_ALGORITHM
605 917d79a7 2022-07-01 stsp Determines the default diff algorithm used by
607 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
608 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
609 41e8d27d 2022-07-03 stsp Valid values for
610 41e8d27d 2022-07-03 stsp .Ev TOG_DIFF_ALGORITHM
612 917d79a7 2022-07-01 stsp .Dq patience
614 917d79a7 2022-07-01 stsp .Dq myers .
615 917d79a7 2022-07-01 stsp If unset, the Myers diff algorithm will be used by default.
616 619b3b49 2022-07-04 stsp .It Ev TOG_VIEW_SPLIT_MODE
617 2572d286 2022-07-12 stsp Determines the default layout of split-screen views.
623 2572d286 2022-07-12 stsp will use horizontal split by default.
624 2572d286 2022-07-12 stsp Otherwise, vertical split will be used.
627 2572d286 2022-07-12 stsp key can be used to switch between vertical and horizontal split layout
628 2572d286 2022-07-12 stsp at run-time.
629 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
631 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
632 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
633 6d17833f 2019-11-08 stsp variables documented below.
634 6d17833f 2019-11-08 stsp The colors available in color schemes are
635 6d17833f 2019-11-08 stsp .Dq black ,
637 6d17833f 2019-11-08 stsp .Dq green ,
638 6d17833f 2019-11-08 stsp .Dq yellow ,
640 93a300b2 2021-08-26 stsp .Dq magenta ,
643 1d7fe5cd 2019-11-08 stsp .Dq default
644 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
645 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
646 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
647 6d17833f 2019-11-08 stsp If not set, the default value
648 6d17833f 2019-11-08 stsp .Dq magenta
650 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
651 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
652 6d17833f 2019-11-08 stsp If not set, the default value
655 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
656 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
657 6d17833f 2019-11-08 stsp If not set, the default value
660 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
661 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
662 c0b01bdb 2019-11-08 stsp If not set, the default value
665 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
666 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
667 c0b01bdb 2019-11-08 stsp If not set, the default value
668 c0b01bdb 2019-11-08 stsp .Dq magenta
670 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
671 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
672 c0b01bdb 2019-11-08 stsp If not set, the default value
673 91b8c405 2020-01-25 stsp .Dq magenta
675 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
676 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
677 6d17833f 2019-11-08 stsp If not set, the default value
680 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
681 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
682 c0b01bdb 2019-11-08 stsp If not set, the default value
685 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
686 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
687 11b20872 2019-11-08 stsp If not set, the default value
690 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
691 11b20872 2019-11-08 stsp The color used to mark up author information.
692 11b20872 2019-11-08 stsp If not set, the default value
695 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
696 11b20872 2019-11-08 stsp The color used to mark up date information.
697 11b20872 2019-11-08 stsp If not set, the default value
700 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
701 38cb327b 2020-11-24 stsp The color used to mark up references in the
702 38cb327b 2020-11-24 stsp .Dq refs/heads/
704 38cb327b 2020-11-24 stsp If not set, the default value
707 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
708 38cb327b 2020-11-24 stsp The color used to mark up references in the
709 38cb327b 2020-11-24 stsp .Dq refs/tags/
711 38cb327b 2020-11-24 stsp If not set, the default value
712 38cb327b 2020-11-24 stsp .Dq magenta
714 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
715 38cb327b 2020-11-24 stsp The color used to mark up references in the
716 38cb327b 2020-11-24 stsp .Dq refs/remotes/
718 38cb327b 2020-11-24 stsp If not set, the default value
721 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
722 cc488aa7 2022-01-23 stsp The color used to mark up references in the
723 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
725 cc488aa7 2022-01-23 stsp If not set, the default value
729 030916b5 2018-07-12 stsp .Sh EXIT STATUS
730 030916b5 2018-07-12 stsp .Ex -std tog
731 030916b5 2018-07-12 stsp .Sh SEE ALSO
732 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
733 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
734 56b9a4ca 2019-06-21 stsp .Xr re_format 7
735 030916b5 2018-07-12 stsp .Sh AUTHORS
736 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
737 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
738 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
739 8ca658b9 2022-07-05 stsp .An Mark Jamsek Aq Mt mark@jamsek.dev
740 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
741 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
742 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
743 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
