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
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 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
130 030916b5 2018-07-12 stsp .Bl -tag -width Ds
131 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, >, Full stop, Ctrl-n
132 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
133 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, <, Comma, Ctrl-p
134 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
135 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
136 07b0611c 2022-06-23 thomas Scroll log message field to the right N increments (default: 1).
138 d74d8993 2022-06-23 thomas Log message moves left on the screen.
139 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
140 07b0611c 2022-06-23 thomas Scroll log message field to the left N increments (default: 1).
142 d74d8993 2022-06-23 thomas Log message moves right on the screen.
144 05171be4 2022-06-23 thomas Scroll log message field to the rightmost position.
146 05171be4 2022-06-23 thomas Scroll log message field to the leftmost position.
147 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
148 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
149 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
150 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
151 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
152 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
153 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
154 07b0611c 2022-06-23 thomas 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 4b06140e 2022-03-22 thomas If needed, this operation can be cancelled with
164 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
165 4c2d69cb 2022-06-23 thomas .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 07b0611c 2022-06-23 thomas Find the Nth next commit which matches the current search pattern (default: 1).
189 634cb454 2022-07-03 thomas 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 07b0611c 2022-06-23 thomas Find the Nth previous commit which matches the current search pattern
196 07b0611c 2022-06-23 thomas (default: 1).
198 634cb454 2022-07-03 thomas 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 f69c5a46 2022-07-19 thomas 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 07b0611c 2022-06-23 thomas 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 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
270 07b0611c 2022-06-23 thomas Scroll down N lines (default: 1).
271 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
272 07b0611c 2022-06-23 thomas Scroll up N lines (default: 1).
273 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
274 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
276 d74d8993 2022-06-23 thomas Diff output moves left on the screen.
277 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
278 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
280 d74d8993 2022-06-23 thomas Diff output moves right on the screen.
282 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
284 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
285 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
286 07b0611c 2022-06-23 thomas Scroll down N pages (default: 1).
287 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
288 07b0611c 2022-06-23 thomas Scroll up N pages (default: 1).
289 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
290 07b0611c 2022-06-23 thomas Scroll down N half pages (default: 1).
291 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
292 07b0611c 2022-06-23 thomas 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.
297 82c78e96 2022-08-06 thomas .It Cm \&(
298 82c78e96 2022-08-06 thomas Navigate to the Nth previous file in the diff (default: 1).
299 82c78e96 2022-08-06 thomas .It Cm \&)
300 82c78e96 2022-08-06 thomas Navigate to the Nth next file in the diff (default: 1).
301 82c78e96 2022-08-06 thomas .It Cm \&{
302 82c78e96 2022-08-06 thomas Navigate to the Nth previous hunk in the diff (default: 1).
303 82c78e96 2022-08-06 thomas .It Cm \&}
304 82c78e96 2022-08-06 thomas Navigate to the Nth next hunk in the diff (default: 1).
306 07b0611c 2022-06-23 thomas Reduce diff context by N lines (default: 1).
308 07b0611c 2022-06-23 thomas Increase diff context by N lines (default: 1).
309 777aae21 2022-07-20 thomas .It Cm <, Comma, K
312 01ca22b1 2020-12-07 stsp view was opened via the
314 4fc71f3b 2022-07-12 thomas view, move to the Nth previous (younger) commit.
315 4fc71f3b 2022-07-12 thomas If the diff was opened via the
316 4fc71f3b 2022-07-12 thomas .Cm blame
317 4fc71f3b 2022-07-12 thomas view, move to the Nth previous line and load the corresponding commit
318 4fc71f3b 2022-07-12 thomas (default: 1).
319 777aae21 2022-07-20 thomas .It Cm >, Full stop, J
322 01ca22b1 2020-12-07 stsp view was opened via the
324 4fc71f3b 2022-07-12 thomas view, move to the Nth next (older) commit.
325 4fc71f3b 2022-07-12 thomas If the diff was opened via the
326 4fc71f3b 2022-07-12 thomas .Cm blame
327 4fc71f3b 2022-07-12 thomas view, move to the Nth next line and load the corresponding commit (default: 1).
329 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
330 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
331 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
332 66dc9065 2020-02-15 stsp .Xr re_format 7 .
334 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
336 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
337 07b0611c 2022-06-23 thomas (default: 1).
339 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
341 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
342 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
343 d40a767d 2022-07-03 thomas Patience (slow and tidy).
344 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
345 adf4c9e0 2022-07-03 thomas .Cm blame
349 09b5bff8 2020-02-23 naddy The options for
350 09b5bff8 2020-02-23 naddy .Cm tog diff
351 09b5bff8 2020-02-23 naddy are as follows:
352 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
354 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
355 3dbaef42 2020-11-24 stsp .It Fl C Ar number
356 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
357 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
358 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
359 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
360 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
361 09b5bff8 2020-02-23 naddy working directory.
362 212b39d1 2020-02-24 naddy If this directory is a
364 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
366 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
368 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
369 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
371 030916b5 2018-07-12 stsp The key bindings for
372 030916b5 2018-07-12 stsp .Cm tog blame
373 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
374 030916b5 2018-07-12 stsp .Bl -tag -width Ds
375 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
376 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
377 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
378 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
379 05171be4 2022-06-23 thomas .It Cm Right-arrow, l
380 07b0611c 2022-06-23 thomas Scroll view to the right N increments (default: 1).
382 d74d8993 2022-06-23 thomas File output moves left on the screen.
383 05171be4 2022-06-23 thomas .It Cm Left-arrow, h
384 07b0611c 2022-06-23 thomas Scroll view to the left N increments (default: 1).
386 d74d8993 2022-06-23 thomas File output moves right on the screen.
388 05171be4 2022-06-23 thomas Scroll view to the rightmost position.
390 05171be4 2022-06-23 thomas Scroll view left to the start of the line.
391 1c5e5faa 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
392 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
393 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
394 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
395 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
396 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
397 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
398 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
399 4deef56f 2021-09-02 naddy .It Cm Home, g
400 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
401 4deef56f 2021-09-02 naddy .It Cm End, G
402 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
403 030916b5 2018-07-12 stsp .It Cm Enter
406 030916b5 2018-07-12 stsp view for the currently selected line's commit.
410 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
411 c0d30c23 2018-10-07 stsp selected line's commit.
415 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
416 c0d30c23 2018-10-07 stsp currently selected line's commit.
420 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
424 eaeaa612 2022-07-20 thomas view for the currently selected annotated line.
426 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
427 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
428 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
429 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
431 07b0611c 2022-06-23 thomas Find the Nth next line which matches the current search pattern (default: 1).
433 07b0611c 2022-06-23 thomas Find the Nth previous line which matches the current search pattern
434 07b0611c 2022-06-23 thomas (default: 1).
436 adf4c9e0 2022-07-03 thomas Change the diff algorithm.
437 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
438 d40a767d 2022-07-03 thomas Patience (slow and tidy).
439 adf4c9e0 2022-07-03 thomas This is a global setting which also affects the
444 030916b5 2018-07-12 stsp The options for
445 030916b5 2018-07-12 stsp .Cm tog blame
446 030916b5 2018-07-12 stsp are as follows:
447 030916b5 2018-07-12 stsp .Bl -tag -width Ds
448 030916b5 2018-07-12 stsp .It Fl c Ar commit
449 030916b5 2018-07-12 stsp Start traversing history at the specified
450 030916b5 2018-07-12 stsp .Ar commit .
451 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
452 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
453 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
454 69069811 2018-08-02 stsp .It Fl r Ar repository-path
455 69069811 2018-08-02 stsp Use the repository at the specified path.
456 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
457 69069811 2018-08-02 stsp working directory.
458 212b39d1 2020-02-24 naddy If this directory is a
460 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
462 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
463 030916b5 2018-07-12 stsp Display the repository tree.
466 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
468 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
469 848d6979 2019-08-12 stsp .Bl -column YXZ description
470 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
471 848d6979 2019-08-12 stsp .It / Ta entry is a directory
472 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
473 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
476 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
478 030916b5 2018-07-12 stsp The key bindings for
479 030916b5 2018-07-12 stsp .Cm tog tree
480 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
481 030916b5 2018-07-12 stsp .Bl -tag -width Ds
482 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
483 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
484 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
485 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
486 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
487 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
488 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
489 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
490 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
491 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
492 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
493 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
494 e4526bf5 2021-09-03 naddy .It Cm Home, g
495 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
496 e4526bf5 2021-09-03 naddy .It Cm End, G
497 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
498 030916b5 2018-07-12 stsp .It Cm Enter
499 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
501 030916b5 2018-07-12 stsp view for the currently selected file.
505 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
509 152c1c93 2020-11-29 stsp view listing all references in the repository.
510 152c1c93 2020-11-29 stsp This can then be used to open a new
512 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
513 7837eeac 2018-09-24 stsp .It Cm Backspace
514 07b0611c 2022-06-23 thomas Move back to the Nth parent directory (default: 1).
516 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
520 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
521 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
522 4eec20aa 2019-06-22 stsp against the tree entry's name.
523 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
524 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
526 07b0611c 2022-06-23 thomas Find the Nth next tree entry which matches the current search pattern
527 07b0611c 2022-06-23 thomas (default: 1).
529 07b0611c 2022-06-23 thomas Find the Nth previous tree entry which matches the current search pattern
530 07b0611c 2022-06-23 thomas (default: 1).
533 030916b5 2018-07-12 stsp The options for
534 030916b5 2018-07-12 stsp .Cm tog tree
535 030916b5 2018-07-12 stsp are as follows:
536 030916b5 2018-07-12 stsp .Bl -tag -width Ds
537 030916b5 2018-07-12 stsp .It Fl c Ar commit
538 030916b5 2018-07-12 stsp Start traversing history at the specified
539 030916b5 2018-07-12 stsp .Ar commit .
540 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
541 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
542 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
543 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
544 38cb327b 2020-11-24 stsp Use the repository at the specified path.
545 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
546 38cb327b 2020-11-24 stsp working directory.
547 38cb327b 2020-11-24 stsp If this directory is a
549 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
551 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
552 38cb327b 2020-11-24 stsp Display references in the repository.
554 38cb327b 2020-11-24 stsp The key bindings for
555 38cb327b 2020-11-24 stsp .Cm tog ref
556 07b0611c 2022-06-23 thomas are as follows (N denotes optional prefixed count modifier):
557 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
558 f7140bf5 2021-10-17 thomas .It Cm Down-arrow, j, Ctrl-n
559 07b0611c 2022-06-23 thomas Move the selection cursor down N lines (default: 1).
560 f7140bf5 2021-10-17 thomas .It Cm Up-arrow, k, Ctrl-p
561 07b0611c 2022-06-23 thomas Move the selection cursor up N lines (default: 1).
562 4c2d69cb 2022-06-23 thomas .It Cm Page-down, Space, Ctrl+f, f
563 07b0611c 2022-06-23 thomas Move the selection cursor down N pages (default: 1).
564 1c5e5faa 2022-06-23 thomas .It Cm Page-up, Ctrl+b, b
565 07b0611c 2022-06-23 thomas Move the selection cursor up N pages (default: 1).
566 23427b14 2022-06-23 thomas .It Cm Ctrl+d, d
567 07b0611c 2022-06-23 thomas Move the selection cursor down N half pages (default: 1).
568 23427b14 2022-06-23 thomas .It Cm Ctrl+u, u
569 07b0611c 2022-06-23 thomas Move the selection cursor up N half pages (default: 1).
570 e4526bf5 2021-09-03 naddy .It Cm Home, g
571 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
572 e4526bf5 2021-09-03 naddy .It Cm End, G
573 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
574 38cb327b 2020-11-24 stsp .It Cm Enter
577 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
578 38cb327b 2020-11-24 stsp currently selected reference.
582 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
584 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
588 84227eb1 2022-06-23 thomas Show last modified date of each displayed reference.
590 3bfadbd4 2021-11-20 thomas Toggle display order of references between sort by name and sort by timestamp.
592 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
593 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
594 38cb327b 2020-11-24 stsp against absolute reference names.
595 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
596 38cb327b 2020-11-24 stsp .Xr re_format 7 .
598 07b0611c 2022-06-23 thomas Find the Nth next reference which matches the current search pattern
599 07b0611c 2022-06-23 thomas (default: 1).
601 07b0611c 2022-06-23 thomas Find the Nth previous reference which matches the current search pattern
602 07b0611c 2022-06-23 thomas (default: 1).
603 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
604 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
609 38cb327b 2020-11-24 stsp The options for
610 38cb327b 2020-11-24 stsp .Cm tog ref
611 38cb327b 2020-11-24 stsp are as follows:
612 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
613 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
614 74283ab8 2020-02-07 stsp Use the repository at the specified path.
615 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
616 74283ab8 2020-02-07 stsp working directory.
617 74283ab8 2020-02-07 stsp If this directory is a
619 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
622 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
623 64486692 2022-07-07 thomas .Bl -tag -width TOG_VIEW_SPLIT_MODE
624 adf4c9e0 2022-07-03 thomas .It Ev TOG_DIFF_ALGORITHM
625 adf4c9e0 2022-07-03 thomas Determines the default diff algorithm used by
627 d40a767d 2022-07-03 thomas Supported diff algorithms are Myers (quick and dirty) and
628 d40a767d 2022-07-03 thomas Patience (slow and tidy).
629 d40a767d 2022-07-03 thomas Valid values for
630 d40a767d 2022-07-03 thomas .Ev TOG_DIFF_ALGORITHM
632 adf4c9e0 2022-07-03 thomas .Dq patience
634 adf4c9e0 2022-07-03 thomas .Dq myers .
635 adf4c9e0 2022-07-03 thomas If unset, the Myers diff algorithm will be used by default.
636 0b948cdd 2022-07-04 thomas .It Ev TOG_VIEW_SPLIT_MODE
637 569abcd7 2022-07-12 thomas Determines the default layout of split-screen views.
638 0b948cdd 2022-07-04 thomas If set to
643 569abcd7 2022-07-12 thomas will use horizontal split by default.
644 569abcd7 2022-07-12 thomas Otherwise, vertical split will be used.
647 569abcd7 2022-07-12 thomas key can be used to switch between vertical and horizontal split layout
648 569abcd7 2022-07-12 thomas at run-time.
649 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
651 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
652 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
653 6d17833f 2019-11-08 stsp variables documented below.
654 6d17833f 2019-11-08 stsp The colors available in color schemes are
655 6d17833f 2019-11-08 stsp .Dq black ,
657 6d17833f 2019-11-08 stsp .Dq green ,
658 6d17833f 2019-11-08 stsp .Dq yellow ,
660 93a300b2 2021-08-26 stsp .Dq magenta ,
663 1d7fe5cd 2019-11-08 stsp .Dq default
664 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
665 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
666 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
667 6d17833f 2019-11-08 stsp If not set, the default value
668 6d17833f 2019-11-08 stsp .Dq magenta
670 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
671 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
672 6d17833f 2019-11-08 stsp If not set, the default value
675 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
676 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
677 6d17833f 2019-11-08 stsp If not set, the default value
680 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
681 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
682 c0b01bdb 2019-11-08 stsp If not set, the default value
685 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
686 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
687 c0b01bdb 2019-11-08 stsp If not set, the default value
688 c0b01bdb 2019-11-08 stsp .Dq magenta
690 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
691 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
692 c0b01bdb 2019-11-08 stsp If not set, the default value
693 91b8c405 2020-01-25 stsp .Dq magenta
695 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
696 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
697 6d17833f 2019-11-08 stsp If not set, the default value
700 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
701 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
702 c0b01bdb 2019-11-08 stsp If not set, the default value
705 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
706 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
707 11b20872 2019-11-08 stsp If not set, the default value
710 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
711 11b20872 2019-11-08 stsp The color used to mark up author information.
712 11b20872 2019-11-08 stsp If not set, the default value
715 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
716 11b20872 2019-11-08 stsp The color used to mark up date information.
717 11b20872 2019-11-08 stsp If not set, the default value
720 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
721 38cb327b 2020-11-24 stsp The color used to mark up references in the
722 38cb327b 2020-11-24 stsp .Dq refs/heads/
724 38cb327b 2020-11-24 stsp If not set, the default value
727 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
728 38cb327b 2020-11-24 stsp The color used to mark up references in the
729 38cb327b 2020-11-24 stsp .Dq refs/tags/
731 38cb327b 2020-11-24 stsp If not set, the default value
732 38cb327b 2020-11-24 stsp .Dq magenta
734 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
735 38cb327b 2020-11-24 stsp The color used to mark up references in the
736 38cb327b 2020-11-24 stsp .Dq refs/remotes/
738 38cb327b 2020-11-24 stsp If not set, the default value
741 2183bbf6 2022-01-23 thomas .It Ev TOG_COLOR_REFS_BACKUP
742 2183bbf6 2022-01-23 thomas The color used to mark up references in the
743 2183bbf6 2022-01-23 thomas .Dq refs/got/backup/
744 2183bbf6 2022-01-23 thomas namespace.
745 2183bbf6 2022-01-23 thomas If not set, the default value
749 030916b5 2018-07-12 stsp .Sh EXIT STATUS
750 030916b5 2018-07-12 stsp .Ex -std tog
751 030916b5 2018-07-12 stsp .Sh SEE ALSO
752 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
753 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
754 56b9a4ca 2019-06-21 stsp .Xr re_format 7
755 030916b5 2018-07-12 stsp .Sh AUTHORS
756 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
757 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
758 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
759 60c73080 2022-07-05 thomas .An Mark Jamsek Aq Mt mark@jamsek.dev
760 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
761 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
762 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
763 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
