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 Global options must precede the command name, and are as follows:
71 .Bl -tag -width tenletters
73 Display usage information.
75 Display program version and exit immediately.
78 The global key bindings are:
81 Display run-time help.
82 Key bindings for the focussed view will be displayed.
83 Pressing this again inside the help view will toggle the display of
91 Quit the view which is in focus.
93 Switch focus between views.
95 Toggle fullscreen mode for a split-screen view.
97 will automatically use vertical split-screen views if the size of the
98 terminal window is sufficiently large.
100 Switch the current split-screen layout, and render all active views in
102 The split-screen layout can be either vertical or horizontal.
103 If the terminal is not wide enough when switching to a vertical split,
104 views will render in fullscreen.
106 When in a split-screen view, decrease the size of the focussed split
107 N increments (default: 1).
109 When in a split-screen view, increase the size of the focussed split
110 N increments (default: 1).
112 Go to line N in the view (default: last line).
114 Go to line N in the view (default: first line).
120 .Bl -tag -width blame
125 .Op Fl r Ar repository-path
128 Display history of a repository.
131 is specified, show only commits which modified this path.
132 If invoked in a work tree, the
134 is interpreted relative to the current working directory,
135 and the work tree's path prefix is implicitly prepended.
136 Otherwise, the path is interpreted relative to the repository root.
138 This command is also executed if no explicit command is specified.
142 are as follows (N denotes optional prefixed count modifier):
144 .It Cm Down-arrow, j, >, Full stop, Ctrl-n
145 Move the selection cursor down N lines (default: 1).
146 .It Cm Up-arrow, k, <, Comma, Ctrl-p
147 Move the selection cursor up N lines (default: 1).
148 .It Cm Right-arrow, l
149 Scroll log message field to the right N increments (default: 1).
151 Log message moves left on the screen.
153 Scroll log message field to the left N increments (default: 1).
155 Log message moves right on the screen.
157 Scroll log message field to the rightmost position.
159 Scroll log message field to the leftmost position.
160 .It Cm Page-down, Space, Ctrl+f, f
161 Move the selection cursor down N pages (default: 1).
162 .It Cm Page-up, Ctrl+b, b
163 Move the selection cursor up N pages (default: 1).
165 Move the selection cursor down N half pages (default: 1).
167 Move the selection cursor up N half pages (default: 1).
169 Move the cursor to the newest commit.
171 Move the cursor to the oldest commit.
172 This will traverse all commits on the current branch which may take
173 a long time depending on the number of commits in branch history.
174 If needed, this operation can be cancelled with
181 view showing file changes made in the currently selected commit.
185 view showing the tree for the currently selected commit.
187 Show log entries for the parent directory of the currently selected path.
188 However when an active search is in progress or when additional commits
191 aborts the running operation.
193 Prompt for a search pattern and start searching for matching commits.
194 The search pattern is an extended regular expression which is matched
195 against a commit's author name, committer name, log message, and
197 Regular expression syntax is documented in
200 Prompt for a pattern and limit the log view's list of commits to those
201 which match the pattern.
202 If no pattern is specified, i.e. the
204 prompt is immediately closed with the Enter key, then the pattern is
206 Until the pattern is cleared, the limited list of commits replaces the
207 full list of commits for all operations supported by the log view.
208 For example, a search started with
210 will search the limited list of commits, rather than searching all commits.
211 The pattern is an extended regular expression which is matched
212 against a commit's author name, committer name, log message, and
214 Regular expression syntax is documented in
217 Find the Nth next commit which matches the current search pattern (default: 1).
219 Searching continues until either a match is found or
225 Find the Nth previous commit which matches the current search pattern
228 Searching continues until either a match is found or
236 view with new commits found in the repository.
240 view and toggle display of merged commits.
243 option determines whether merged commits are displayed initially.
247 view listing all references in the repository.
248 This can then be used to open a new
250 view for arbitrary branches and tags.
252 Toggle between showing the author and the committer name.
260 Display individual commits which were merged into the current branch
264 shows the linear history of the current branch only.
267 key binding can be used to toggle display of merged commits at run-time.
269 Start traversing history at the specified
271 The expected argument is the name of a branch or a commit ID SHA1 hash.
272 An abbreviated hash argument will be expanded to a full SHA1 hash
273 automatically, provided the abbreviation is unique.
274 If this option is not specified, default to the work tree's current branch
275 if invoked in a work tree, or to the repository's HEAD reference.
276 .It Fl r Ar repository-path
277 Use the repository at the specified path.
278 If not specified, assume the repository is located at or above the current
280 If this directory is a
282 work tree, use the repository path associated with this work tree.
288 .Op Fl r Ar repository-path
292 Display the differences between two objects in the repository.
293 Treat each of the two arguments as a reference, a tag name, or an object
294 ID SHA1 hash, and display differences between the corresponding objects.
295 Both objects must be of the same type (blobs, trees, or commits).
296 An abbreviated hash argument will be expanded to a full SHA1 hash
297 automatically, provided the abbreviation is unique.
301 are as follows (N denotes optional prefixed count modifier):
304 Toggle treatment of file contents as ASCII text even if binary data was
306 .It Cm Down-arrow, j, Ctrl-n
307 Scroll down N lines (default: 1).
308 .It Cm Up-arrow, k, Ctrl-p
309 Scroll up N lines (default: 1).
310 .It Cm Right-arrow, l
311 Scroll view to the right N increments (default: 1).
313 Diff output moves left on the screen.
315 Scroll view to the left N increments (default: 1).
317 Diff output moves right on the screen.
319 Scroll view to the rightmost position.
321 Scroll view left to the start of the line.
322 .It Cm Page-down, Space, Ctrl+f, f
323 Scroll down N pages (default: 1).
324 .It Cm Page-up, Ctrl+b, b
325 Scroll up N pages (default: 1).
327 Scroll down N half pages (default: 1).
329 Scroll up N half pages (default: 1).
331 Scroll to the top of the view.
333 Scroll to the bottom of the view.
335 Navigate to the Nth previous file in the diff (default: 1).
337 Navigate to the Nth next file in the diff (default: 1).
339 Navigate to the Nth previous hunk in the diff (default: 1).
341 Navigate to the Nth next hunk in the diff (default: 1).
343 Reduce diff context by N lines (default: 1).
345 Increase diff context by N lines (default: 1).
349 view was opened via the
351 view, move to the Nth previous (younger) commit.
352 If the diff was opened via the
354 view, move to the Nth previous line and load the corresponding commit
356 .It Cm >, Full stop, J
359 view was opened via the
361 view, move to the Nth next (older) commit.
362 If the diff was opened via the
364 view, move to the Nth next line and load the corresponding commit (default: 1).
366 Prompt for a search pattern and start searching for matching lines.
367 The search pattern is an extended regular expression.
368 Regular expression syntax is documented in
371 Find the Nth next line which matches the current search pattern (default: 1).
373 Find the Nth previous line which matches the current search pattern
376 Toggle display of whitespace-only changes.
378 Change the diff algorithm.
379 Supported diff algorithms are Myers (quick and dirty) and
380 Patience (slow and tidy).
381 This is a global setting which also affects the
391 Treat file contents as ASCII text even if binary data is detected.
393 Set the number of context lines shown in the diff.
394 By default, 3 lines of context are shown.
395 .It Fl r Ar repository-path
396 Use the repository at the specified path.
397 If not specified, assume the repository is located at or above the current
399 If this directory is a
401 work tree, use the repository path associated with this work tree.
403 Ignore whitespace-only changes.
408 .Op Fl r Ar repository-path
411 Display line-by-line history of a file at the specified path.
415 are as follows (N denotes optional prefixed count modifier):
417 .It Cm Down-arrow, j, Ctrl-n
418 Move the selection cursor down N pages (default: 1).
419 .It Cm Up-arrow, k, Ctrl-p
420 Move the selection cursor up N pages (default: 1).
421 .It Cm Right-arrow, l
422 Scroll view to the right N increments (default: 1).
424 File output moves left on the screen.
426 Scroll view to the left N increments (default: 1).
428 File output moves right on the screen.
430 Scroll view to the rightmost position.
432 Scroll view left to the start of the line.
433 .It Cm Page-down, Space, Ctrl+f, f
434 Move the selection cursor down N pages (default: 1).
435 .It Cm Page-up, Ctrl+b, b
436 Move the selection cursor up N pages (default: 1).
438 Move the selection cursor down N half pages (default: 1).
440 Move the selection cursor up N half pages (default: 1).
442 Move the selection cursor to the first line of the file.
444 Move the selection cursor to the last line of the file.
448 view for the currently selected line's commit.
452 view with the version of the file as found in the currently
453 selected line's commit.
457 view with the version of the file as found in the parent commit of the
458 currently selected line's commit.
462 view with the previously blamed commit.
466 view for the currently selected annotated line.
468 Prompt for a search pattern and start searching for matching lines.
469 The search pattern is an extended regular expression.
470 Regular expression syntax is documented in
473 Find the Nth next line which matches the current search pattern (default: 1).
475 Find the Nth previous line which matches the current search pattern
478 Change the diff algorithm.
479 Supported diff algorithms are Myers (quick and dirty) and
480 Patience (slow and tidy).
481 This is a global setting which also affects the
491 Start traversing history at the specified
493 The expected argument is the name of a branch or a commit ID SHA1 hash.
494 An abbreviated hash argument will be expanded to a full SHA1 hash
495 automatically, provided the abbreviation is unique.
496 .It Fl r Ar repository-path
497 Use the repository at the specified path.
498 If not specified, assume the repository is located at or above the current
500 If this directory is a
502 work tree, use the repository path associated with this work tree.
507 .Op Fl r Ar repository-path
510 Display the repository tree.
513 is specified, show tree entries at this path.
515 Displayed tree entries may carry one of the following trailing annotations:
516 .Bl -column YXZ description
517 .It @ Ta entry is a symbolic link
518 .It / Ta entry is a directory
519 .It * Ta entry is an executable file
520 .It $ Ta entry is a Git submodule
523 Symbolic link entries are also annotated with the target path of the link.
527 are as follows (N denotes optional prefixed count modifier):
529 .It Cm Down-arrow, j, Ctrl-n
530 Move the selection cursor down N lines (default: 1).
531 .It Cm Up-arrow, k, Ctrl-p
532 Move the selection cursor up N lines (default: 1).
533 .It Cm Page-down, Space, Ctrl+f, f
534 Move the selection cursor down N pages (default: 1).
535 .It Cm Page-up, Ctrl+b, b
536 Move the selection cursor up N pages (default: 1).
538 Move the selection cursor down N half pages (default: 1).
540 Move the selection cursor up N half pages (default: 1).
542 Move the selection cursor to the first entry.
544 Move the selection cursor to the last entry.
546 Enter the currently selected directory, or switch to the
548 view for the currently selected file.
552 view for the currently selected tree entry.
556 view listing all references in the repository.
557 This can then be used to open a new
559 view for arbitrary branches and tags.
561 Move back to the Nth parent directory (default: 1).
563 Show object IDs for all objects displayed in the
567 Prompt for a search pattern and start searching for matching tree entries.
568 The search pattern is an extended regular expression which is matched
569 against the tree entry's name.
570 Regular expression syntax is documented in
573 Find the Nth next tree entry which matches the current search pattern
576 Find the Nth previous tree entry which matches the current search pattern
585 Start traversing history at the specified
587 The expected argument is the name of a branch or a commit ID SHA1 hash.
588 An abbreviated hash argument will be expanded to a full SHA1 hash
589 automatically, provided the abbreviation is unique.
590 .It Fl r Ar repository-path
591 Use the repository at the specified path.
592 If not specified, assume the repository is located at or above the current
594 If this directory is a
596 work tree, use the repository path associated with this work tree.
598 .It Cm ref Op Fl r Ar repository-path
599 Display references in the repository.
603 are as follows (N denotes optional prefixed count modifier):
605 .It Cm Down-arrow, j, Ctrl-n
606 Move the selection cursor down N lines (default: 1).
607 .It Cm Up-arrow, k, Ctrl-p
608 Move the selection cursor up N lines (default: 1).
609 .It Cm Page-down, Space, Ctrl+f, f
610 Move the selection cursor down N pages (default: 1).
611 .It Cm Page-up, Ctrl+b, b
612 Move the selection cursor up N pages (default: 1).
614 Move the selection cursor down N half pages (default: 1).
616 Move the selection cursor up N half pages (default: 1).
618 Move the selection cursor to the first reference.
620 Move the selection cursor to the last reference.
624 view which begins traversing history at the commit resolved via the
625 currently selected reference.
629 view showing the tree resolved via the currently selected reference.
631 Show object IDs for all non-symbolic references displayed in the
635 Show last modified date of each displayed reference.
637 Toggle display order of references between sort by name and sort by timestamp.
639 Prompt for a search pattern and start searching for matching references.
640 The search pattern is an extended regular expression which is matched
641 against absolute reference names.
642 Regular expression syntax is documented in
645 Find the Nth next reference which matches the current search pattern
648 Find the Nth previous reference which matches the current search pattern
651 Reload the list of references displayed by the
660 .It Fl r Ar repository-path
661 Use the repository at the specified path.
662 If not specified, assume the repository is located at or above the current
664 If this directory is a
666 work tree, use the repository path associated with this work tree.
670 .Bl -tag -width TOG_VIEW_SPLIT_MODE
671 .It Ev TOG_DIFF_ALGORITHM
672 Determines the default diff algorithm used by
674 Supported diff algorithms are Myers (quick and dirty) and
675 Patience (slow and tidy).
677 .Ev TOG_DIFF_ALGORITHM
682 If unset, the Myers diff algorithm will be used by default.
683 .It Ev TOG_VIEW_SPLIT_MODE
684 Determines the default layout of split-screen views.
690 will use horizontal split by default.
691 Otherwise, vertical split will be used.
694 key can be used to switch between vertical and horizontal split layout
698 shows colorized output if this variable is set to a non-empty value.
699 The default color scheme can be modified by setting the environment
700 variables documented below.
701 The colors available in color schemes are
711 which maps to the terminal's default foreground color.
712 .It Ev TOG_COLOR_DIFF_MINUS
713 The color used to mark up removed lines in diffs.
714 If not set, the default value
717 .It Ev TOG_COLOR_DIFF_PLUS
718 The color used to mark up added lines in diffs.
719 If not set, the default value
722 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
723 The color used to mark up chunk header lines in diffs.
724 If not set, the default value
727 .It Ev TOG_COLOR_DIFF_META
728 The color used to mark up meta data in diffs.
729 If not set, the default value
732 .It Ev TOG_COLOR_TREE_SUBMODULE
733 The color used to mark up submodule tree entries.
734 If not set, the default value
737 .It Ev TOG_COLOR_TREE_SYMLINK
738 The color used to mark up symbolic link tree entries.
739 If not set, the default value
742 .It Ev TOG_COLOR_TREE_DIRECTORY
743 The color used to mark up directory tree entries.
744 If not set, the default value
747 .It Ev TOG_COLOR_TREE_EXECUTABLE
748 The color used to mark up executable file tree entries.
749 If not set, the default value
752 .It Ev TOG_COLOR_COMMIT
753 The color used to mark up commit IDs.
754 If not set, the default value
757 .It Ev TOG_COLOR_AUTHOR
758 The color used to mark up author information.
759 If not set, the default value
762 .It Ev TOG_COLOR_DATE
763 The color used to mark up date information.
764 If not set, the default value
767 .It Ev TOG_COLOR_REFS_HEADS
768 The color used to mark up references in the
771 If not set, the default value
774 .It Ev TOG_COLOR_REFS_TAGS
775 The color used to mark up references in the
778 If not set, the default value
781 .It Ev TOG_COLOR_REFS_REMOTES
782 The color used to mark up references in the
785 If not set, the default value
788 .It Ev TOG_COLOR_REFS_BACKUP
789 The color used to mark up references in the
792 If not set, the default value
800 .Xr git-repository 5 ,
803 .An Christian Weisgerber Aq Mt naddy@openbsd.org
804 .An Josh Rickmar Aq Mt jrick@zettaport.com
805 .An Joshua Stein Aq Mt jcs@openbsd.org
806 .An Mark Jamsek Aq Mt mark@jamsek.dev
807 .An Martin Pieuchot Aq Mt mpi@openbsd.org
808 .An Omar Polo Aq Mt op@openbsd.org
809 .An Stefan Sperling Aq Mt stsp@openbsd.org
810 .An Klemens Nanni Aq Mt kn@openbsd.org
