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).
97 Go to line N in the view (default: last line).
99 Go to line N in the view (default: first line).
102 Global options must precede the command name, and are as follows:
103 .Bl -tag -width tenletters
105 Display usage information.
107 Display program version and exit immediately.
113 .Bl -tag -width blame
118 .Op Fl r Ar repository-path
121 Display history of a repository.
124 is specified, show only commits which modified this path.
125 If invoked in a work tree, the
127 is interpreted relative to the current working directory,
128 and the work tree's path prefix is implicitly prepended.
129 Otherwise, the path is interpreted relative to the repository root.
131 This command is also executed if no explicit command is specified.
135 are as follows (N denotes optional prefixed count modifier):
137 .It Cm Down-arrow, j, >, Full stop, Ctrl-n
138 Move the selection cursor down N lines (default: 1).
139 .It Cm Up-arrow, k, <, Comma, Ctrl-p
140 Move the selection cursor up N lines (default: 1).
141 .It Cm Right-arrow, l
142 Scroll log message field to the right N increments (default: 1).
144 Log message moves left on the screen.
146 Scroll log message field to the left N increments (default: 1).
148 Log message moves right on the screen.
150 Scroll log message field to the rightmost position.
152 Scroll log message field to the leftmost position.
153 .It Cm Page-down, Space, Ctrl+f, f
154 Move the selection cursor down N pages (default: 1).
155 .It Cm Page-up, Ctrl+b, b
156 Move the selection cursor up N pages (default: 1).
158 Move the selection cursor down N half pages (default: 1).
160 Move the selection cursor up N half pages (default: 1).
162 Move the cursor to the newest commit.
164 Move the cursor to the oldest commit.
165 This will traverse all commits on the current branch which may take
166 a long time depending on the number of commits in branch history.
167 If needed, this operation can be cancelled with
174 view showing file changes made in the currently selected commit.
178 view showing the tree for the currently selected commit.
180 Show log entries for the parent directory of the currently selected path.
181 However when an active search is in progress or when additional commits
184 aborts the running operation.
186 Prompt for a search pattern and start searching for matching commits.
187 The search pattern is an extended regular expression which is matched
188 against a commit's author name, committer name, log message, and
190 Regular expression syntax is documented in
193 Find the Nth next commit which matches the current search pattern (default: 1).
195 Searching continues until either a match is found or
201 Find the Nth previous commit which matches the current search pattern
204 Searching continues until either a match is found or
212 view with new commits found in the repository.
216 view and toggle display of merged commits.
219 option determines whether merged commits are displayed initially.
223 view listing all references in the repository.
224 This can then be used to open a new
226 view for arbitrary branches and tags.
228 Toggle between showing the author and the committer name.
236 Display individual commits which were merged into the current branch
240 shows the linear history of the current branch only.
243 key binding can be used to toggle display of merged commits at run-time.
245 Start traversing history at the specified
247 The expected argument is the name of a branch or a commit ID SHA1 hash.
248 An abbreviated hash argument will be expanded to a full SHA1 hash
249 automatically, provided the abbreviation is unique.
250 If this option is not specified, default to the work tree's current branch
251 if invoked in a work tree, or to the repository's HEAD reference.
252 .It Fl r Ar repository-path
253 Use the repository at the specified path.
254 If not specified, assume the repository is located at or above the current
256 If this directory is a
258 work tree, use the repository path associated with this work tree.
264 .Op Fl r Ar repository-path
268 Display the differences between two objects in the repository.
269 Treat each of the two arguments as a reference, a tag name, or an object
270 ID SHA1 hash, and display differences between the corresponding objects.
271 Both objects must be of the same type (blobs, trees, or commits).
272 An abbreviated hash argument will be expanded to a full SHA1 hash
273 automatically, provided the abbreviation is unique.
277 are as follows (N denotes optional prefixed count modifier):
280 Toggle treatment of file contents as ASCII text even if binary data was
282 .It Cm Down-arrow, j, Ctrl-n
283 Scroll down N lines (default: 1).
284 .It Cm Up-arrow, k, Ctrl-p
285 Scroll up N lines (default: 1).
286 .It Cm Right-arrow, l
287 Scroll view to the right N increments (default: 1).
289 Diff output moves left on the screen.
291 Scroll view to the left N increments (default: 1).
293 Diff output moves right on the screen.
295 Scroll view to the rightmost position.
297 Scroll view left to the start of the line.
298 .It Cm Page-down, Space, Ctrl+f, f
299 Scroll down N pages (default: 1).
300 .It Cm Page-up, Ctrl+b, b
301 Scroll up N pages (default: 1).
303 Scroll down N half pages (default: 1).
305 Scroll up N half pages (default: 1).
307 Scroll to the top of the view.
309 Scroll to the bottom of the view.
311 Navigate to the Nth previous file in the diff (default: 1).
313 Navigate to the Nth next file in the diff (default: 1).
315 Navigate to the Nth previous hunk in the diff (default: 1).
317 Navigate to the Nth next hunk in the diff (default: 1).
319 Reduce diff context by N lines (default: 1).
321 Increase diff context by N lines (default: 1).
325 view was opened via the
327 view, move to the Nth previous (younger) commit.
328 If the diff was opened via the
330 view, move to the Nth previous line and load the corresponding commit
332 .It Cm >, Full stop, J
335 view was opened via the
337 view, move to the Nth next (older) commit.
338 If the diff was opened via the
340 view, move to the Nth next line and load the corresponding commit (default: 1).
342 Prompt for a search pattern and start searching for matching lines.
343 The search pattern is an extended regular expression.
344 Regular expression syntax is documented in
347 Find the Nth next line which matches the current search pattern (default: 1).
349 Find the Nth previous line which matches the current search pattern
352 Toggle display of whitespace-only changes.
354 Change the diff algorithm.
355 Supported diff algorithms are Myers (quick and dirty) and
356 Patience (slow and tidy).
357 This is a global setting which also affects the
367 Treat file contents as ASCII text even if binary data is detected.
369 Set the number of context lines shown in the diff.
370 By default, 3 lines of context are shown.
371 .It Fl r Ar repository-path
372 Use the repository at the specified path.
373 If not specified, assume the repository is located at or above the current
375 If this directory is a
377 work tree, use the repository path associated with this work tree.
379 Ignore whitespace-only changes.
384 .Op Fl r Ar repository-path
387 Display line-by-line history of a file at the specified path.
391 are as follows (N denotes optional prefixed count modifier):
393 .It Cm Down-arrow, j, Ctrl-n
394 Move the selection cursor down N pages (default: 1).
395 .It Cm Up-arrow, k, Ctrl-p
396 Move the selection cursor up N pages (default: 1).
397 .It Cm Right-arrow, l
398 Scroll view to the right N increments (default: 1).
400 File output moves left on the screen.
402 Scroll view to the left N increments (default: 1).
404 File output moves right on the screen.
406 Scroll view to the rightmost position.
408 Scroll view left to the start of the line.
409 .It Cm Page-down, Space, Ctrl+f, f
410 Move the selection cursor down N pages (default: 1).
411 .It Cm Page-up, Ctrl+b, b
412 Move the selection cursor up N pages (default: 1).
414 Move the selection cursor down N half pages (default: 1).
416 Move the selection cursor up N half pages (default: 1).
418 Move the selection cursor to the first line of the file.
420 Move the selection cursor to the last line of the file.
424 view for the currently selected line's commit.
428 view with the version of the file as found in the currently
429 selected line's commit.
433 view with the version of the file as found in the parent commit of the
434 currently selected line's commit.
438 view with the previously blamed commit.
442 view for the currently selected annotated line.
444 Prompt for a search pattern and start searching for matching lines.
445 The search pattern is an extended regular expression.
446 Regular expression syntax is documented in
449 Find the Nth next line which matches the current search pattern (default: 1).
451 Find the Nth previous line which matches the current search pattern
454 Change the diff algorithm.
455 Supported diff algorithms are Myers (quick and dirty) and
456 Patience (slow and tidy).
457 This is a global setting which also affects the
467 Start traversing history at the specified
469 The expected argument is the name of a branch or a commit ID SHA1 hash.
470 An abbreviated hash argument will be expanded to a full SHA1 hash
471 automatically, provided the abbreviation is unique.
472 .It Fl r Ar repository-path
473 Use the repository at the specified path.
474 If not specified, assume the repository is located at or above the current
476 If this directory is a
478 work tree, use the repository path associated with this work tree.
483 .Op Fl r Ar repository-path
486 Display the repository tree.
489 is specified, show tree entries at this path.
491 Displayed tree entries may carry one of the following trailing annotations:
492 .Bl -column YXZ description
493 .It @ Ta entry is a symbolic link
494 .It / Ta entry is a directory
495 .It * Ta entry is an executable file
496 .It $ Ta entry is a Git submodule
499 Symbolic link entries are also annotated with the target path of the link.
503 are as follows (N denotes optional prefixed count modifier):
505 .It Cm Down-arrow, j, Ctrl-n
506 Move the selection cursor down N lines (default: 1).
507 .It Cm Up-arrow, k, Ctrl-p
508 Move the selection cursor up N lines (default: 1).
509 .It Cm Page-down, Space, Ctrl+f, f
510 Move the selection cursor down N pages (default: 1).
511 .It Cm Page-up, Ctrl+b, b
512 Move the selection cursor up N pages (default: 1).
514 Move the selection cursor down N half pages (default: 1).
516 Move the selection cursor up N half pages (default: 1).
518 Move the selection cursor to the first entry.
520 Move the selection cursor to the last entry.
522 Enter the currently selected directory, or switch to the
524 view for the currently selected file.
528 view for the currently selected tree entry.
532 view listing all references in the repository.
533 This can then be used to open a new
535 view for arbitrary branches and tags.
537 Move back to the Nth parent directory (default: 1).
539 Show object IDs for all objects displayed in the
543 Prompt for a search pattern and start searching for matching tree entries.
544 The search pattern is an extended regular expression which is matched
545 against the tree entry's name.
546 Regular expression syntax is documented in
549 Find the Nth next tree entry which matches the current search pattern
552 Find the Nth previous tree entry which matches the current search pattern
561 Start traversing history at the specified
563 The expected argument is the name of a branch or a commit ID SHA1 hash.
564 An abbreviated hash argument will be expanded to a full SHA1 hash
565 automatically, provided the abbreviation is unique.
566 .It Fl r Ar repository-path
567 Use the repository at the specified path.
568 If not specified, assume the repository is located at or above the current
570 If this directory is a
572 work tree, use the repository path associated with this work tree.
574 .It Cm ref Op Fl r Ar repository-path
575 Display references in the repository.
579 are as follows (N denotes optional prefixed count modifier):
581 .It Cm Down-arrow, j, Ctrl-n
582 Move the selection cursor down N lines (default: 1).
583 .It Cm Up-arrow, k, Ctrl-p
584 Move the selection cursor up N lines (default: 1).
585 .It Cm Page-down, Space, Ctrl+f, f
586 Move the selection cursor down N pages (default: 1).
587 .It Cm Page-up, Ctrl+b, b
588 Move the selection cursor up N pages (default: 1).
590 Move the selection cursor down N half pages (default: 1).
592 Move the selection cursor up N half pages (default: 1).
594 Move the selection cursor to the first reference.
596 Move the selection cursor to the last reference.
600 view which begins traversing history at the commit resolved via the
601 currently selected reference.
605 view showing the tree resolved via the currently selected reference.
607 Show object IDs for all non-symbolic references displayed in the
611 Show last modified date of each displayed reference.
613 Toggle display order of references between sort by name and sort by timestamp.
615 Prompt for a search pattern and start searching for matching references.
616 The search pattern is an extended regular expression which is matched
617 against absolute reference names.
618 Regular expression syntax is documented in
621 Find the Nth next reference which matches the current search pattern
624 Find the Nth previous reference which matches the current search pattern
627 Reload the list of references displayed by the
636 .It Fl r Ar repository-path
637 Use the repository at the specified path.
638 If not specified, assume the repository is located at or above the current
640 If this directory is a
642 work tree, use the repository path associated with this work tree.
646 .Bl -tag -width TOG_VIEW_SPLIT_MODE
647 .It Ev TOG_DIFF_ALGORITHM
648 Determines the default diff algorithm used by
650 Supported diff algorithms are Myers (quick and dirty) and
651 Patience (slow and tidy).
653 .Ev TOG_DIFF_ALGORITHM
658 If unset, the Myers diff algorithm will be used by default.
659 .It Ev TOG_VIEW_SPLIT_MODE
660 Determines the default layout of split-screen views.
666 will use horizontal split by default.
667 Otherwise, vertical split will be used.
670 key can be used to switch between vertical and horizontal split layout
674 shows colorized output if this variable is set to a non-empty value.
675 The default color scheme can be modified by setting the environment
676 variables documented below.
677 The colors available in color schemes are
687 which maps to the terminal's default foreground color.
688 .It Ev TOG_COLOR_DIFF_MINUS
689 The color used to mark up removed lines in diffs.
690 If not set, the default value
693 .It Ev TOG_COLOR_DIFF_PLUS
694 The color used to mark up added lines in diffs.
695 If not set, the default value
698 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
699 The color used to mark up chunk header lines in diffs.
700 If not set, the default value
703 .It Ev TOG_COLOR_DIFF_META
704 The color used to mark up meta data in diffs.
705 If not set, the default value
708 .It Ev TOG_COLOR_TREE_SUBMODULE
709 The color used to mark up submodule tree entries.
710 If not set, the default value
713 .It Ev TOG_COLOR_TREE_SYMLINK
714 The color used to mark up symbolic link tree entries.
715 If not set, the default value
718 .It Ev TOG_COLOR_TREE_DIRECTORY
719 The color used to mark up directory tree entries.
720 If not set, the default value
723 .It Ev TOG_COLOR_TREE_EXECUTABLE
724 The color used to mark up executable file tree entries.
725 If not set, the default value
728 .It Ev TOG_COLOR_COMMIT
729 The color used to mark up commit IDs.
730 If not set, the default value
733 .It Ev TOG_COLOR_AUTHOR
734 The color used to mark up author information.
735 If not set, the default value
738 .It Ev TOG_COLOR_DATE
739 The color used to mark up date information.
740 If not set, the default value
743 .It Ev TOG_COLOR_REFS_HEADS
744 The color used to mark up references in the
747 If not set, the default value
750 .It Ev TOG_COLOR_REFS_TAGS
751 The color used to mark up references in the
754 If not set, the default value
757 .It Ev TOG_COLOR_REFS_REMOTES
758 The color used to mark up references in the
761 If not set, the default value
764 .It Ev TOG_COLOR_REFS_BACKUP
765 The color used to mark up references in the
768 If not set, the default value
776 .Xr git-repository 5 ,
779 .An Christian Weisgerber Aq Mt naddy@openbsd.org
780 .An Josh Rickmar Aq Mt jrick@zettaport.com
781 .An Joshua Stein Aq Mt jcs@openbsd.org
782 .An Mark Jamsek Aq Mt mark@jamsek.dev
783 .An Martin Pieuchot Aq Mt mpi@openbsd.org
784 .An Omar Polo Aq Mt op@openbsd.org
785 .An Stefan Sperling Aq Mt stsp@openbsd.org
786 .An Klemens Nanni Aq Mt kn@openbsd.org
