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 .
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 67d6e2c2 2022-07-12 stsp will automatically use vertical split-screen views if the size of the
83 67d6e2c2 2022-07-12 stsp terminal window is sufficiently large.
85 2572d286 2022-07-12 stsp Switch the current split-screen layout, and render all active views in
86 2572d286 2022-07-12 stsp this new layout.
87 67d6e2c2 2022-07-12 stsp The split-screen layout can be either vertical or horizontal.
88 2572d286 2022-07-12 stsp If the terminal is not wide enough when switching to a vertical split,
89 2572d286 2022-07-12 stsp views will render in fullscreen.
91 3c1dfe12 2022-07-08 mark When in a split-screen view, decrease the size of the focussed split
92 3c1dfe12 2022-07-08 mark N increments (default: 1).
94 3c1dfe12 2022-07-08 mark When in a split-screen view, increase the size of the focussed split
95 3c1dfe12 2022-07-08 mark N increments (default: 1).
97 94b80cfa 2022-08-01 mark Go to line N in the view (default: last line).
99 94b80cfa 2022-08-01 mark 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
114 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
115 030916b5 2018-07-12 stsp Display history of a repository.
118 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
119 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
121 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
122 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
123 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
125 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
127 030916b5 2018-07-12 stsp The key bindings for
128 030916b5 2018-07-12 stsp .Cm tog log
129 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
130 030916b5 2018-07-12 stsp .Bl -tag -width Ds
131 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
132 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
133 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
134 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
135 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
136 640cd7ff 2022-06-22 mark Scroll log message field to the right N increments (default: 1).
138 f7443f66 2022-06-16 mark Log message moves left on the screen.
139 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
140 640cd7ff 2022-06-22 mark Scroll log message field to the left N increments (default: 1).
142 f7443f66 2022-06-16 mark Log message moves right on the screen.
144 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
146 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
147 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
148 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
149 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
150 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
151 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
152 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
153 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
154 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
155 27890b18 2021-08-30 stsp .It Cm Home, g
156 912a3f79 2021-08-30 j Move the cursor to the newest commit.
158 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
159 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
160 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
161 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
164 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
165 48bb96f0 2022-06-20 naddy .It Cm Enter
168 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
172 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
173 5036bf37 2018-09-24 stsp .It Cm Backspace
174 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
175 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
177 678cbce5 2019-07-28 stsp .Cm Backspace
178 26f0cb24 2021-08-30 j aborts the running operation.
180 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
181 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
182 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
183 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
184 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
185 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
187 640cd7ff 2022-06-22 mark Find the Nth next commit which matches the current search pattern (default: 1).
189 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
192 678cbce5 2019-07-28 stsp .Cm Backspace
193 678cbce5 2019-07-28 stsp key is pressed.
195 640cd7ff 2022-06-22 mark Find the Nth previous commit which matches the current search pattern
196 640cd7ff 2022-06-22 mark (default: 1).
198 a6d37fac 2022-07-03 mark Searching continues until either a match is found or
201 678cbce5 2019-07-28 stsp .Cm Backspace
202 678cbce5 2019-07-28 stsp key is pressed.
203 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
206 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
210 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
213 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
217 38cb327b 2020-11-24 stsp view listing all references in the repository.
218 38cb327b 2020-11-24 stsp This can then be used to open a new
220 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
222 10aab77f 2022-07-19 op Toggle between showing the author and the committer name.
225 030916b5 2018-07-12 stsp The options for
226 030916b5 2018-07-12 stsp .Cm tog log
227 030916b5 2018-07-12 stsp are as follows:
228 030916b5 2018-07-12 stsp .Bl -tag -width Ds
230 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
231 1137e0ae 2020-01-27 stsp from other branches.
232 b672a97a 2020-01-27 stsp By default,
233 b672a97a 2020-01-27 stsp .Cm tog log
234 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
237 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
238 030916b5 2018-07-12 stsp .It Fl c Ar commit
239 030916b5 2018-07-12 stsp Start traversing history at the specified
240 030916b5 2018-07-12 stsp .Ar commit .
241 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
242 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
243 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
244 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
245 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
246 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
247 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
248 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
249 ecb28ae0 2018-07-16 stsp working directory.
250 212b39d1 2020-02-24 naddy If this directory is a
252 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
254 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
255 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
256 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
257 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
258 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
259 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
260 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
262 030916b5 2018-07-12 stsp The key bindings for
263 030916b5 2018-07-12 stsp .Cm tog diff
264 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
265 030916b5 2018-07-12 stsp .Bl -tag -width Ds
267 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
269 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
270 640cd7ff 2022-06-22 mark Scroll down N lines (default: 1).
271 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
272 640cd7ff 2022-06-22 mark Scroll up N lines (default: 1).
273 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
274 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
276 f7443f66 2022-06-16 mark Diff output moves left on the screen.
277 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
278 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
280 f7443f66 2022-06-16 mark Diff output moves right on the screen.
282 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
284 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
285 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
286 640cd7ff 2022-06-22 mark Scroll down N pages (default: 1).
287 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
288 640cd7ff 2022-06-22 mark Scroll up N pages (default: 1).
289 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
290 640cd7ff 2022-06-22 mark Scroll down N half pages (default: 1).
291 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
292 640cd7ff 2022-06-22 mark Scroll up N half pages (default: 1).
293 00f6361c 2021-08-30 naddy .It Cm Home, g
294 912a3f79 2021-08-30 j Scroll to the top of the view.
296 912a3f79 2021-08-30 j Scroll to the bottom of the view.
298 640cd7ff 2022-06-22 mark Reduce diff context by N lines (default: 1).
300 640cd7ff 2022-06-22 mark Increase diff context by N lines (default: 1).
301 2b3e6702 2022-07-20 mark .It Cm <, Comma, K
304 01ca22b1 2020-12-07 stsp view was opened via the
306 c0f61fa4 2022-07-11 mark view, move to the Nth previous (younger) commit.
307 c0f61fa4 2022-07-11 mark If the diff was opened via the
309 c0f61fa4 2022-07-11 mark view, move to the Nth previous line and load the corresponding commit
310 c0f61fa4 2022-07-11 mark (default: 1).
311 2b3e6702 2022-07-20 mark .It Cm >, Full stop, J
314 01ca22b1 2020-12-07 stsp view was opened via the
316 c0f61fa4 2022-07-11 mark view, move to the Nth next (older) commit.
317 c0f61fa4 2022-07-11 mark If the diff was opened via the
319 c0f61fa4 2022-07-11 mark view, move to the Nth next line and load the corresponding commit (default: 1).
321 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
322 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
323 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
324 66dc9065 2020-02-15 stsp .Xr re_format 7 .
326 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
328 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
329 640cd7ff 2022-06-22 mark (default: 1).
331 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
333 917d79a7 2022-07-01 stsp Change the diff algorithm.
334 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
335 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
336 917d79a7 2022-07-01 stsp This is a global setting which also affects the
341 09b5bff8 2020-02-23 naddy The options for
342 09b5bff8 2020-02-23 naddy .Cm tog diff
343 09b5bff8 2020-02-23 naddy are as follows:
344 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
346 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
347 3dbaef42 2020-11-24 stsp .It Fl C Ar number
348 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
349 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
350 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
351 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
352 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
353 09b5bff8 2020-02-23 naddy working directory.
354 212b39d1 2020-02-24 naddy If this directory is a
356 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
358 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
360 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
361 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
363 030916b5 2018-07-12 stsp The key bindings for
364 030916b5 2018-07-12 stsp .Cm tog blame
365 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
366 030916b5 2018-07-12 stsp .Bl -tag -width Ds
367 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
368 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
369 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
370 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
371 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
372 640cd7ff 2022-06-22 mark Scroll view to the right N increments (default: 1).
374 f7443f66 2022-06-16 mark File output moves left on the screen.
375 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
376 640cd7ff 2022-06-22 mark Scroll view to the left N increments (default: 1).
378 f7443f66 2022-06-16 mark File output moves right on the screen.
380 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
382 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
383 61417565 2022-06-20 mark .It Cm Page-down, Space, Ctrl+f, f
384 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
385 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
386 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
387 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
388 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
389 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
390 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
391 4deef56f 2021-09-02 naddy .It Cm Home, g
392 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
393 4deef56f 2021-09-02 naddy .It Cm End, G
394 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
395 030916b5 2018-07-12 stsp .It Cm Enter
398 030916b5 2018-07-12 stsp view for the currently selected line's commit.
402 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
403 c0d30c23 2018-10-07 stsp selected line's commit.
407 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
408 c0d30c23 2018-10-07 stsp currently selected line's commit.
412 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
416 05f04cdf 2022-07-20 mark view for the currently selected annotated line.
418 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
419 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
420 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
421 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
423 640cd7ff 2022-06-22 mark Find the Nth next line which matches the current search pattern (default: 1).
425 640cd7ff 2022-06-22 mark Find the Nth previous line which matches the current search pattern
426 640cd7ff 2022-06-22 mark (default: 1).
428 917d79a7 2022-07-01 stsp Change the diff algorithm.
429 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
430 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
431 917d79a7 2022-07-01 stsp This is a global setting which also affects the
436 030916b5 2018-07-12 stsp The options for
437 030916b5 2018-07-12 stsp .Cm tog blame
438 030916b5 2018-07-12 stsp are as follows:
439 030916b5 2018-07-12 stsp .Bl -tag -width Ds
440 030916b5 2018-07-12 stsp .It Fl c Ar commit
441 030916b5 2018-07-12 stsp Start traversing history at the specified
442 030916b5 2018-07-12 stsp .Ar commit .
443 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
444 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
445 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
446 69069811 2018-08-02 stsp .It Fl r Ar repository-path
447 69069811 2018-08-02 stsp Use the repository at the specified path.
448 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
449 69069811 2018-08-02 stsp working directory.
450 212b39d1 2020-02-24 naddy If this directory is a
452 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
454 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
455 030916b5 2018-07-12 stsp Display the repository tree.
458 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
460 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
461 848d6979 2019-08-12 stsp .Bl -column YXZ description
462 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
463 848d6979 2019-08-12 stsp .It / Ta entry is a directory
464 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
465 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
468 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
470 030916b5 2018-07-12 stsp The key bindings for
471 030916b5 2018-07-12 stsp .Cm tog tree
472 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
473 030916b5 2018-07-12 stsp .Bl -tag -width Ds
474 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
475 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
476 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
477 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
478 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
479 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
480 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
481 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
482 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
483 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
484 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
485 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
486 e4526bf5 2021-09-03 naddy .It Cm Home, g
487 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
488 e4526bf5 2021-09-03 naddy .It Cm End, G
489 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
490 030916b5 2018-07-12 stsp .It Cm Enter
491 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
493 030916b5 2018-07-12 stsp view for the currently selected file.
497 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
501 152c1c93 2020-11-29 stsp view listing all references in the repository.
502 152c1c93 2020-11-29 stsp This can then be used to open a new
504 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
505 7837eeac 2018-09-24 stsp .It Cm Backspace
506 640cd7ff 2022-06-22 mark Move back to the Nth parent directory (default: 1).
508 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
512 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
513 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
514 4eec20aa 2019-06-22 stsp against the tree entry's name.
515 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
516 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
518 640cd7ff 2022-06-22 mark Find the Nth next tree entry which matches the current search pattern
519 640cd7ff 2022-06-22 mark (default: 1).
521 640cd7ff 2022-06-22 mark Find the Nth previous tree entry which matches the current search pattern
522 640cd7ff 2022-06-22 mark (default: 1).
525 030916b5 2018-07-12 stsp The options for
526 030916b5 2018-07-12 stsp .Cm tog tree
527 030916b5 2018-07-12 stsp are as follows:
528 030916b5 2018-07-12 stsp .Bl -tag -width Ds
529 030916b5 2018-07-12 stsp .It Fl c Ar commit
530 030916b5 2018-07-12 stsp Start traversing history at the specified
531 030916b5 2018-07-12 stsp .Ar commit .
532 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
533 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
534 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
535 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
536 38cb327b 2020-11-24 stsp Use the repository at the specified path.
537 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
538 38cb327b 2020-11-24 stsp working directory.
539 38cb327b 2020-11-24 stsp If this directory is a
541 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
543 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
544 38cb327b 2020-11-24 stsp Display references in the repository.
546 38cb327b 2020-11-24 stsp The key bindings for
547 38cb327b 2020-11-24 stsp .Cm tog ref
548 640cd7ff 2022-06-22 mark are as follows (N denotes optional prefixed count modifier):
549 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
550 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
551 640cd7ff 2022-06-22 mark Move the selection cursor down N lines (default: 1).
552 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
553 640cd7ff 2022-06-22 mark Move the selection cursor up N lines (default: 1).
554 48bb96f0 2022-06-20 naddy .It Cm Page-down, Space, Ctrl+f, f
555 640cd7ff 2022-06-22 mark Move the selection cursor down N pages (default: 1).
556 61417565 2022-06-20 mark .It Cm Page-up, Ctrl+b, b
557 640cd7ff 2022-06-22 mark Move the selection cursor up N pages (default: 1).
558 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
559 640cd7ff 2022-06-22 mark Move the selection cursor down N half pages (default: 1).
560 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
561 640cd7ff 2022-06-22 mark Move the selection cursor up N half pages (default: 1).
562 e4526bf5 2021-09-03 naddy .It Cm Home, g
563 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
564 e4526bf5 2021-09-03 naddy .It Cm End, G
565 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
566 38cb327b 2020-11-24 stsp .It Cm Enter
569 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
570 38cb327b 2020-11-24 stsp currently selected reference.
574 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
576 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
580 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
582 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
584 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
585 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
586 38cb327b 2020-11-24 stsp against absolute reference names.
587 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
588 38cb327b 2020-11-24 stsp .Xr re_format 7 .
590 640cd7ff 2022-06-22 mark Find the Nth next reference which matches the current search pattern
591 640cd7ff 2022-06-22 mark (default: 1).
593 640cd7ff 2022-06-22 mark Find the Nth previous reference which matches the current search pattern
594 640cd7ff 2022-06-22 mark (default: 1).
595 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
596 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
601 38cb327b 2020-11-24 stsp The options for
602 38cb327b 2020-11-24 stsp .Cm tog ref
603 38cb327b 2020-11-24 stsp are as follows:
604 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
605 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
606 74283ab8 2020-02-07 stsp Use the repository at the specified path.
607 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
608 74283ab8 2020-02-07 stsp working directory.
609 74283ab8 2020-02-07 stsp If this directory is a
611 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
614 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
615 d2366e29 2022-07-07 mark .Bl -tag -width TOG_VIEW_SPLIT_MODE
616 917d79a7 2022-07-01 stsp .It Ev TOG_DIFF_ALGORITHM
617 917d79a7 2022-07-01 stsp Determines the default diff algorithm used by
619 41e8d27d 2022-07-03 stsp Supported diff algorithms are Myers (quick and dirty) and
620 41e8d27d 2022-07-03 stsp Patience (slow and tidy).
621 41e8d27d 2022-07-03 stsp Valid values for
622 41e8d27d 2022-07-03 stsp .Ev TOG_DIFF_ALGORITHM
624 917d79a7 2022-07-01 stsp .Dq patience
626 917d79a7 2022-07-01 stsp .Dq myers .
627 917d79a7 2022-07-01 stsp If unset, the Myers diff algorithm will be used by default.
628 619b3b49 2022-07-04 stsp .It Ev TOG_VIEW_SPLIT_MODE
629 2572d286 2022-07-12 stsp Determines the default layout of split-screen views.
635 2572d286 2022-07-12 stsp will use horizontal split by default.
636 2572d286 2022-07-12 stsp Otherwise, vertical split will be used.
639 2572d286 2022-07-12 stsp key can be used to switch between vertical and horizontal split layout
640 2572d286 2022-07-12 stsp at run-time.
641 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
643 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
644 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
645 6d17833f 2019-11-08 stsp variables documented below.
646 6d17833f 2019-11-08 stsp The colors available in color schemes are
647 6d17833f 2019-11-08 stsp .Dq black ,
649 6d17833f 2019-11-08 stsp .Dq green ,
650 6d17833f 2019-11-08 stsp .Dq yellow ,
652 93a300b2 2021-08-26 stsp .Dq magenta ,
655 1d7fe5cd 2019-11-08 stsp .Dq default
656 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
657 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
658 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
659 6d17833f 2019-11-08 stsp If not set, the default value
660 6d17833f 2019-11-08 stsp .Dq magenta
662 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
663 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
664 6d17833f 2019-11-08 stsp If not set, the default value
667 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
668 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
669 6d17833f 2019-11-08 stsp If not set, the default value
672 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
673 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
674 c0b01bdb 2019-11-08 stsp If not set, the default value
677 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
678 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
679 c0b01bdb 2019-11-08 stsp If not set, the default value
680 c0b01bdb 2019-11-08 stsp .Dq magenta
682 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
683 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
684 c0b01bdb 2019-11-08 stsp If not set, the default value
685 91b8c405 2020-01-25 stsp .Dq magenta
687 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
688 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
689 6d17833f 2019-11-08 stsp If not set, the default value
692 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
693 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
694 c0b01bdb 2019-11-08 stsp If not set, the default value
697 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
698 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
699 11b20872 2019-11-08 stsp If not set, the default value
702 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
703 11b20872 2019-11-08 stsp The color used to mark up author information.
704 11b20872 2019-11-08 stsp If not set, the default value
707 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
708 11b20872 2019-11-08 stsp The color used to mark up date information.
709 11b20872 2019-11-08 stsp If not set, the default value
712 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
713 38cb327b 2020-11-24 stsp The color used to mark up references in the
714 38cb327b 2020-11-24 stsp .Dq refs/heads/
716 38cb327b 2020-11-24 stsp If not set, the default value
719 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
720 38cb327b 2020-11-24 stsp The color used to mark up references in the
721 38cb327b 2020-11-24 stsp .Dq refs/tags/
723 38cb327b 2020-11-24 stsp If not set, the default value
724 38cb327b 2020-11-24 stsp .Dq magenta
726 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
727 38cb327b 2020-11-24 stsp The color used to mark up references in the
728 38cb327b 2020-11-24 stsp .Dq refs/remotes/
730 38cb327b 2020-11-24 stsp If not set, the default value
733 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
734 cc488aa7 2022-01-23 stsp The color used to mark up references in the
735 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
737 cc488aa7 2022-01-23 stsp If not set, the default value
741 030916b5 2018-07-12 stsp .Sh EXIT STATUS
742 030916b5 2018-07-12 stsp .Ex -std tog
743 030916b5 2018-07-12 stsp .Sh SEE ALSO
744 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
745 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
746 56b9a4ca 2019-06-21 stsp .Xr re_format 7
747 030916b5 2018-07-12 stsp .Sh AUTHORS
748 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
749 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
750 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
751 8ca658b9 2022-07-05 stsp .An Mark Jamsek Aq Mt mark@jamsek.dev
752 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
753 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
754 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
755 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
