2 .\" Copyright (c) 2018 Stefan Sperling
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd Git repository browser
32 is an interactive read-only browser for Git repositories.
33 This repository format is described in
34 .Xr git-repository 5 .
37 supports several types of views which display repository data:
40 Displays commits in the repository's history.
41 This view is displayed initially if no
43 is specified, or if just a
47 Displays changes made in a particular commit.
49 Displays the line-by-line history of a file.
51 Displays the tree corresponding to a particular commit.
53 Displays references in the repository.
57 provides global and command-specific key bindings and options.
58 Some command-specific key bindings may be prefixed with an integer, which is
59 denoted by N in the descriptions below, and is used as a modifier to the
60 operation as indicated.
62 will echo digits to the screen when count modifiers are entered, and complete
63 the sequence upon input of the first non-numeric character.
64 Count modifiers can be aborted by entering an unmapped key.
65 Once a compound command is executed, the operation can be cancelled with
70 The global key bindings are:
76 Quit the view which is in focus.
78 Switch focus between views.
80 Toggle fullscreen mode for a split-screen view.
82 will automatically use vertical split-screen views if the size of the
83 terminal window is sufficiently large.
85 Switch the current split-screen layout, and render all active views in
87 The split-screen layout can be either vertical or horizontal.
88 If the terminal is not wide enough when switching to a vertical split,
89 views will render in fullscreen.
91 When in a split-screen view, decrease the size of the focussed split
92 N increments (default: 1).
94 When in a split-screen view, increase the size of the focussed split
95 N increments (default: 1).
98 Global options must precede the command name, and are as follows:
99 .Bl -tag -width tenletters
101 Display usage information.
103 Display program version and exit immediately.
109 .Bl -tag -width blame
110 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
111 Display history of a repository.
114 is specified, show only commits which modified this path.
115 If invoked in a work tree, the
117 is interpreted relative to the current working directory,
118 and the work tree's path prefix is implicitly prepended.
119 Otherwise, the path is interpreted relative to the repository root.
121 This command is also executed if no explicit command is specified.
125 are as follows (N denotes optional prefixed count modifier):
127 .It Cm Down-arrow, j, >, Full stop, Ctrl-n
128 Move the selection cursor down N lines (default: 1).
129 .It Cm Up-arrow, k, <, Comma, Ctrl-p
130 Move the selection cursor up N lines (default: 1).
131 .It Cm Right-arrow, l
132 Scroll log message field to the right N increments (default: 1).
134 Log message moves left on the screen.
136 Scroll log message field to the left N increments (default: 1).
138 Log message moves right on the screen.
140 Scroll log message field to the rightmost position.
142 Scroll log message field to the leftmost position.
143 .It Cm Page-down, Space, Ctrl+f, f
144 Move the selection cursor down N pages (default: 1).
145 .It Cm Page-up, Ctrl+b, b
146 Move the selection cursor up N pages (default: 1).
148 Move the selection cursor down N half pages (default: 1).
150 Move the selection cursor up N half pages (default: 1).
152 Move the cursor to the newest commit.
154 Move the cursor to the oldest commit.
155 This will traverse all commits on the current branch which may take
156 a long time depending on the number of commits in branch history.
157 If needed, this operation can be cancelled with
164 view showing file changes made in the currently selected commit.
168 view showing the tree for the currently selected commit.
170 Show log entries for the parent directory of the currently selected path.
171 However when an active search is in progress or when additional commits
174 aborts the running operation.
176 Prompt for a search pattern and start searching for matching commits.
177 The search pattern is an extended regular expression which is matched
178 against a commit's author name, committer name, log message, and
180 Regular expression syntax is documented in
183 Find the Nth next commit which matches the current search pattern (default: 1).
185 Searching continues until either a match is found or
191 Find the Nth previous commit which matches the current search pattern
194 Searching continues until either a match is found or
202 view with new commits found in the repository.
206 view and toggle display of merged commits.
209 option determines whether merged commits are displayed initially.
213 view listing all references in the repository.
214 This can then be used to open a new
216 view for arbitrary branches and tags.
218 Toggle between showing the author and the committer name.
226 Display individual commits which were merged into the current branch
230 shows the linear history of the current branch only.
233 key binding can be used to toggle display of merged commits at run-time.
235 Start traversing history at the specified
237 The expected argument is the name of a branch or a commit ID SHA1 hash.
238 An abbreviated hash argument will be expanded to a full SHA1 hash
239 automatically, provided the abbreviation is unique.
240 If this option is not specified, default to the work tree's current branch
241 if invoked in a work tree, or to the repository's HEAD reference.
242 .It Fl r Ar repository-path
243 Use the repository at the specified path.
244 If not specified, assume the repository is located at or above the current
246 If this directory is a
248 work tree, use the repository path associated with this work tree.
250 .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
251 Display the differences between two objects in the repository.
252 Treat each of the two arguments as a reference, a tag name, or an object
253 ID SHA1 hash, and display differences between the corresponding objects.
254 Both objects must be of the same type (blobs, trees, or commits).
255 An abbreviated hash argument will be expanded to a full SHA1 hash
256 automatically, provided the abbreviation is unique.
260 are as follows (N denotes optional prefixed count modifier):
263 Toggle treatment of file contents as ASCII text even if binary data was
265 .It Cm Down-arrow, j, Ctrl-n
266 Scroll down N lines (default: 1).
267 .It Cm Up-arrow, k, Ctrl-p
268 Scroll up N lines (default: 1).
269 .It Cm Right-arrow, l
270 Scroll view to the right N increments (default: 1).
272 Diff output moves left on the screen.
274 Scroll view to the left N increments (default: 1).
276 Diff output moves right on the screen.
278 Scroll view to the rightmost position.
280 Scroll view left to the start of the line.
281 .It Cm Page-down, Space, Ctrl+f, f
282 Scroll down N pages (default: 1).
283 .It Cm Page-up, Ctrl+b, b
284 Scroll up N pages (default: 1).
286 Scroll down N half pages (default: 1).
288 Scroll up N half pages (default: 1).
290 Scroll to the top of the view.
292 Scroll to the bottom of the view.
294 Reduce diff context by N lines (default: 1).
296 Increase diff context by N lines (default: 1).
300 view was opened via the
302 view, move to the Nth previous (younger) commit.
303 If the diff was opened via the
305 view, move to the Nth previous line and load the corresponding commit
307 .It Cm >, Full stop, J
310 view was opened via the
312 view, move to the Nth next (older) commit.
313 If the diff was opened via the
315 view, move to the Nth next line and load the corresponding commit (default: 1).
317 Prompt for a search pattern and start searching for matching lines.
318 The search pattern is an extended regular expression.
319 Regular expression syntax is documented in
322 Find the Nth next line which matches the current search pattern (default: 1).
324 Find the Nth previous line which matches the current search pattern
327 Toggle display of whitespace-only changes.
329 Change the diff algorithm.
330 Supported diff algorithms are Myers (quick and dirty) and
331 Patience (slow and tidy).
332 This is a global setting which also affects the
342 Treat file contents as ASCII text even if binary data is detected.
344 Set the number of context lines shown in the diff.
345 By default, 3 lines of context are shown.
346 .It Fl r Ar repository-path
347 Use the repository at the specified path.
348 If not specified, assume the repository is located at or above the current
350 If this directory is a
352 work tree, use the repository path associated with this work tree.
354 Ignore whitespace-only changes.
356 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
357 Display line-by-line history of a file at the specified path.
361 are as follows (N denotes optional prefixed count modifier):
363 .It Cm Down-arrow, j, Ctrl-n
364 Move the selection cursor down N pages (default: 1).
365 .It Cm Up-arrow, k, Ctrl-p
366 Move the selection cursor up N pages (default: 1).
367 .It Cm Right-arrow, l
368 Scroll view to the right N increments (default: 1).
370 File output moves left on the screen.
372 Scroll view to the left N increments (default: 1).
374 File output moves right on the screen.
376 Scroll view to the rightmost position.
378 Scroll view left to the start of the line.
379 .It Cm Page-down, Space, Ctrl+f, f
380 Move the selection cursor down N pages (default: 1).
381 .It Cm Page-up, Ctrl+b, b
382 Move the selection cursor up N pages (default: 1).
384 Move the selection cursor down N half pages (default: 1).
386 Move the selection cursor up N half pages (default: 1).
388 Move the selection cursor to the first line of the file.
390 Move the selection cursor to the last line of the file.
394 view for the currently selected line's commit.
398 view with the version of the file as found in the currently
399 selected line's commit.
403 view with the version of the file as found in the parent commit of the
404 currently selected line's commit.
408 view with the previously blamed commit.
412 view for the currently selected annotated line.
414 Prompt for a search pattern and start searching for matching lines.
415 The search pattern is an extended regular expression.
416 Regular expression syntax is documented in
419 Find the Nth next line which matches the current search pattern (default: 1).
421 Find the Nth previous line which matches the current search pattern
424 Change the diff algorithm.
425 Supported diff algorithms are Myers (quick and dirty) and
426 Patience (slow and tidy).
427 This is a global setting which also affects the
437 Start traversing history at the specified
439 The expected argument is the name of a branch or a commit ID SHA1 hash.
440 An abbreviated hash argument will be expanded to a full SHA1 hash
441 automatically, provided the abbreviation is unique.
442 .It Fl r Ar repository-path
443 Use the repository at the specified path.
444 If not specified, assume the repository is located at or above the current
446 If this directory is a
448 work tree, use the repository path associated with this work tree.
450 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
451 Display the repository tree.
454 is specified, show tree entries at this path.
456 Displayed tree entries may carry one of the following trailing annotations:
457 .Bl -column YXZ description
458 .It @ Ta entry is a symbolic link
459 .It / Ta entry is a directory
460 .It * Ta entry is an executable file
461 .It $ Ta entry is a Git submodule
464 Symbolic link entries are also annotated with the target path of the link.
468 are as follows (N denotes optional prefixed count modifier):
470 .It Cm Down-arrow, j, Ctrl-n
471 Move the selection cursor down N lines (default: 1).
472 .It Cm Up-arrow, k, Ctrl-p
473 Move the selection cursor up N lines (default: 1).
474 .It Cm Page-down, Space, Ctrl+f, f
475 Move the selection cursor down N pages (default: 1).
476 .It Cm Page-up, Ctrl+b, b
477 Move the selection cursor up N pages (default: 1).
479 Move the selection cursor down N half pages (default: 1).
481 Move the selection cursor up N half pages (default: 1).
483 Move the selection cursor to the first entry.
485 Move the selection cursor to the last entry.
487 Enter the currently selected directory, or switch to the
489 view for the currently selected file.
493 view for the currently selected tree entry.
497 view listing all references in the repository.
498 This can then be used to open a new
500 view for arbitrary branches and tags.
502 Move back to the Nth parent directory (default: 1).
504 Show object IDs for all objects displayed in the
508 Prompt for a search pattern and start searching for matching tree entries.
509 The search pattern is an extended regular expression which is matched
510 against the tree entry's name.
511 Regular expression syntax is documented in
514 Find the Nth next tree entry which matches the current search pattern
517 Find the Nth previous tree entry which matches the current search pattern
526 Start traversing history at the specified
528 The expected argument is the name of a branch or a commit ID SHA1 hash.
529 An abbreviated hash argument will be expanded to a full SHA1 hash
530 automatically, provided the abbreviation is unique.
531 .It Fl r Ar repository-path
532 Use the repository at the specified path.
533 If not specified, assume the repository is located at or above the current
535 If this directory is a
537 work tree, use the repository path associated with this work tree.
539 .It Cm ref Oo Fl r Ar repository-path Oc
540 Display references in the repository.
544 are as follows (N denotes optional prefixed count modifier):
546 .It Cm Down-arrow, j, Ctrl-n
547 Move the selection cursor down N lines (default: 1).
548 .It Cm Up-arrow, k, Ctrl-p
549 Move the selection cursor up N lines (default: 1).
550 .It Cm Page-down, Space, Ctrl+f, f
551 Move the selection cursor down N pages (default: 1).
552 .It Cm Page-up, Ctrl+b, b
553 Move the selection cursor up N pages (default: 1).
555 Move the selection cursor down N half pages (default: 1).
557 Move the selection cursor up N half pages (default: 1).
559 Move the selection cursor to the first reference.
561 Move the selection cursor to the last reference.
565 view which begins traversing history at the commit resolved via the
566 currently selected reference.
570 view showing the tree resolved via the currently selected reference.
572 Show object IDs for all non-symbolic references displayed in the
576 Show last modified date of each displayed reference.
578 Toggle display order of references between sort by name and sort by timestamp.
580 Prompt for a search pattern and start searching for matching references.
581 The search pattern is an extended regular expression which is matched
582 against absolute reference names.
583 Regular expression syntax is documented in
586 Find the Nth next reference which matches the current search pattern
589 Find the Nth previous reference which matches the current search pattern
592 Reload the list of references displayed by the
601 .It Fl r Ar repository-path
602 Use the repository at the specified path.
603 If not specified, assume the repository is located at or above the current
605 If this directory is a
607 work tree, use the repository path associated with this work tree.
611 .Bl -tag -width TOG_VIEW_SPLIT_MODE
612 .It Ev TOG_DIFF_ALGORITHM
613 Determines the default diff algorithm used by
615 Supported diff algorithms are Myers (quick and dirty) and
616 Patience (slow and tidy).
618 .Ev TOG_DIFF_ALGORITHM
623 If unset, the Myers diff algorithm will be used by default.
624 .It Ev TOG_VIEW_SPLIT_MODE
625 Determines the default layout of split-screen views.
631 will use horizontal split by default.
632 Otherwise, vertical split will be used.
635 key can be used to switch between vertical and horizontal split layout
639 shows colorized output if this variable is set to a non-empty value.
640 The default color scheme can be modified by setting the environment
641 variables documented below.
642 The colors available in color schemes are
652 which maps to the terminal's default foreground color.
653 .It Ev TOG_COLOR_DIFF_MINUS
654 The color used to mark up removed lines in diffs.
655 If not set, the default value
658 .It Ev TOG_COLOR_DIFF_PLUS
659 The color used to mark up added lines in diffs.
660 If not set, the default value
663 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
664 The color used to mark up chunk header lines in diffs.
665 If not set, the default value
668 .It Ev TOG_COLOR_DIFF_META
669 The color used to mark up meta data in diffs.
670 If not set, the default value
673 .It Ev TOG_COLOR_TREE_SUBMODULE
674 The color used to mark up submodule tree entries.
675 If not set, the default value
678 .It Ev TOG_COLOR_TREE_SYMLINK
679 The color used to mark up symbolic link tree entries.
680 If not set, the default value
683 .It Ev TOG_COLOR_TREE_DIRECTORY
684 The color used to mark up directory tree entries.
685 If not set, the default value
688 .It Ev TOG_COLOR_TREE_EXECUTABLE
689 The color used to mark up executable file tree entries.
690 If not set, the default value
693 .It Ev TOG_COLOR_COMMIT
694 The color used to mark up commit IDs.
695 If not set, the default value
698 .It Ev TOG_COLOR_AUTHOR
699 The color used to mark up author information.
700 If not set, the default value
703 .It Ev TOG_COLOR_DATE
704 The color used to mark up date information.
705 If not set, the default value
708 .It Ev TOG_COLOR_REFS_HEADS
709 The color used to mark up references in the
712 If not set, the default value
715 .It Ev TOG_COLOR_REFS_TAGS
716 The color used to mark up references in the
719 If not set, the default value
722 .It Ev TOG_COLOR_REFS_REMOTES
723 The color used to mark up references in the
726 If not set, the default value
729 .It Ev TOG_COLOR_REFS_BACKUP
730 The color used to mark up references in the
733 If not set, the default value
741 .Xr git-repository 5 ,
744 .An Christian Weisgerber Aq Mt naddy@openbsd.org
745 .An Josh Rickmar Aq Mt jrick@zettaport.com
746 .An Joshua Stein Aq Mt jcs@openbsd.org
747 .An Mark Jamsek Aq Mt mark@jamsek.dev
748 .An Martin Pieuchot Aq Mt mpi@openbsd.org
749 .An Omar Polo Aq Mt op@openbsd.org
750 .An Stefan Sperling Aq Mt stsp@openbsd.org
751 .An Klemens Nanni Aq Mt kn@openbsd.org
