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 The global key bindings are:
64 Quit the view which is in focus.
66 Switch focus between views.
68 Toggle fullscreen mode for a split-screen view.
70 will automatically use split-screen views if the size of the terminal
71 window is sufficiently large.
74 Global options must precede the command name, and are as follows:
75 .Bl -tag -width tenletters
77 Display usage information.
79 Display program version and exit immediately.
86 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
87 Display history of a repository.
90 is specified, show only commits which modified this path.
91 If invoked in a work tree, the
93 is interpreted relative to the current working directory,
94 and the work tree's path prefix is implicitly prepended.
95 Otherwise, the path is interpreted relative to the repository root.
97 This command is also executed if no explicit command is specified.
103 .It Cm Down-arrow, j, >, Full stop
104 Move the selection cursor down.
105 .It Cm Up-arrow, k, <, Comma
106 Move the selection cursor up.
107 .It Cm Page-down, Ctrl+f
108 Move the selection cursor down one page.
109 .It Cm Page-up, Ctrl+b
110 Move the selection cursor up one page.
112 Move the cursor to the newest commit.
114 Move the cursor to the oldest commit.
115 This will traverse all commits on the current branch which may take
116 a long time depending on the number of commits in branch history.
117 If needed this operation can be cancelled with
122 view showing file changes made in the currently selected commit.
126 view showing the tree for the currently selected commit.
128 Show log entries for the parent directory of the currently selected path.
129 However when an active search is in progress or when additional commits
132 aborts the running operation.
134 Prompt for a search pattern and start searching for matching commits.
135 The search pattern is an extended regular expression which is matched
136 against a commit's author name, committer name, log message, and
138 Regular expression syntax is documented in
141 Find the next commit which matches the current search pattern.
142 Searching continues until either a match is found or the
146 Find the previous commit which matches the current search pattern.
147 Searching continues until either a match is found or the
153 view with new commits found in the repository.
157 view and toggle display of merged commits.
160 option determines whether merged commits are displayed initially.
164 view listing all references in the repository.
165 This can then be used to open a new
167 view for arbitrary branches and tags.
175 Display individual commits which were merged into the current branch
179 shows the linear history of the current branch only.
182 key binding can be used to toggle display of merged commits at run-time.
184 Start traversing history at the specified
186 The expected argument is the name of a branch or a commit ID SHA1 hash.
187 An abbreviated hash argument will be expanded to a full SHA1 hash
188 automatically, provided the abbreviation is unique.
189 If this option is not specified, default to the work tree's current branch
190 if invoked in a work tree, or to the repository's HEAD reference.
191 .It Fl r Ar repository-path
192 Use the repository at the specified path.
193 If not specified, assume the repository is located at or above the current
195 If this directory is a
197 work tree, use the repository path associated with this work tree.
199 .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
200 Display the differences between two objects in the repository.
201 Treat each of the two arguments as a reference, a tag name, or an object
202 ID SHA1 hash, and display differences between the corresponding objects.
203 Both objects must be of the same type (blobs, trees, or commits).
204 An abbreviated hash argument will be expanded to a full SHA1 hash
205 automatically, provided the abbreviation is unique.
212 Toggle treatment of file contents as ASCII text even if binary data was
218 .It Cm Page-down, Space, Ctrl+f
219 Scroll down one page.
220 .It Cm Page-up, Ctrl+b
223 Scroll to the top of the view.
225 Scroll to the bottom of the view.
227 Reduce the amount of diff context lines.
229 Increase the amount of diff context lines.
233 view was opened via the
235 view, move to the previous (younger) commit.
239 view was opened via the
241 view, move to the next (older) commit.
243 Prompt for a search pattern and start searching for matching lines.
244 The search pattern is an extended regular expression.
245 Regular expression syntax is documented in
248 Find the next line which matches the current search pattern.
250 Find the previous line which matches the current search pattern.
252 Toggle display of whitespace-only changes.
260 Treat file contents as ASCII text even if binary data is detected.
262 Set the number of context lines shown in the diff.
263 By default, 3 lines of context are shown.
264 .It Fl r Ar repository-path
265 Use the repository at the specified path.
266 If not specified, assume the repository is located at or above the current
268 If this directory is a
270 work tree, use the repository path associated with this work tree.
272 Ignore whitespace-only changes.
274 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
275 Display line-by-line history of a file at the specified path.
282 Move the selection cursor down.
284 Move the selection cursor up.
285 .It Cm Page-down, Space, Ctrl+f
286 Move the selection cursor down one page.
287 .It Cm Page-up, Ctrl+b
288 Move the selection cursor up one page.
292 view for the currently selected line's commit.
296 view with the version of the file as found in the currently
297 selected line's commit.
301 view with the version of the file as found in the parent commit of the
302 currently selected line's commit.
306 view with the previously blamed commit.
308 Prompt for a search pattern and start searching for matching lines.
309 The search pattern is an extended regular expression.
310 Regular expression syntax is documented in
313 Find the next line which matches the current search pattern.
315 Find the previous line which matches the current search pattern.
323 Start traversing history at the specified
325 The expected argument is the name of a branch or a commit ID SHA1 hash.
326 An abbreviated hash argument will be expanded to a full SHA1 hash
327 automatically, provided the abbreviation is unique.
328 .It Fl r Ar repository-path
329 Use the repository at the specified path.
330 If not specified, assume the repository is located at or above the current
332 If this directory is a
334 work tree, use the repository path associated with this work tree.
336 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
337 Display the repository tree.
340 is specified, show tree entries at this path.
342 Displayed tree entries may carry one of the following trailing annotations:
343 .Bl -column YXZ description
344 .It @ Ta entry is a symbolic link
345 .It / Ta entry is a directory
346 .It * Ta entry is an executable file
347 .It $ Ta entry is a Git submodule
350 Symbolic link entries are also annotated with the target path of the link.
357 Move the selection cursor down.
359 Move the selection cursor up.
360 .It Cm Page-down, Ctrl+f
361 Move the selection cursor down one page.
362 .It Cm Page-up, Ctrl+b
363 Move the selection cursor up one page.
365 Enter the currently selected directory, or switch to the
367 view for the currently selected file.
371 view for the currently selected tree entry.
375 view listing all references in the repository.
376 This can then be used to open a new
378 view for arbitrary branches and tags.
380 Move back to the parent directory.
382 Show object IDs for all objects displayed in the
386 Prompt for a search pattern and start searching for matching tree entries.
387 The search pattern is an extended regular expression which is matched
388 against the tree entry's name.
389 Regular expression syntax is documented in
392 Find the next tree entry which matches the current search pattern.
394 Find the previous tree entry which matches the current search pattern.
402 Start traversing history at the specified
404 The expected argument is the name of a branch or a commit ID SHA1 hash.
405 An abbreviated hash argument will be expanded to a full SHA1 hash
406 automatically, provided the abbreviation is unique.
407 .It Fl r Ar repository-path
408 Use the repository at the specified path.
409 If not specified, assume the repository is located at or above the current
411 If this directory is a
413 work tree, use the repository path associated with this work tree.
415 .It Cm ref Oo Fl r Ar repository-path Oc
416 Display references in the repository.
423 Move the selection cursor down.
425 Move the selection cursor up.
426 .It Cm Page-down, Ctrl+f
427 Move the selection cursor down one page.
428 .It Cm Page-up, Ctrl+b
429 Move the selection cursor up one page.
433 view which begins traversing history at the commit resolved via the
434 currently selected reference.
438 view showing the tree resolved via the currently selected reference.
440 Show object IDs for all non-symbolic references displayed in the
444 Prompt for a search pattern and start searching for matching references.
445 The search pattern is an extended regular expression which is matched
446 against absolute reference names.
447 Regular expression syntax is documented in
450 Find the next reference which matches the current search pattern.
452 Find the previous reference which matches the current search pattern.
454 Reload the list of references displayed by the
463 .It Fl r Ar repository-path
464 Use the repository at the specified path.
465 If not specified, assume the repository is located at or above the current
467 If this directory is a
469 work tree, use the repository path associated with this work tree.
473 .Bl -tag -width TOG_COLORS
476 shows colorized output if this variable is set to a non-empty value.
477 The default color scheme can be modified by setting the environment
478 variables documented below.
479 The colors available in color schemes are
489 which maps to the terminal's default foreground color.
490 .It Ev TOG_COLOR_DIFF_MINUS
491 The color used to mark up removed lines in diffs.
492 If not set, the default value
495 .It Ev TOG_COLOR_DIFF_PLUS
496 The color used to mark up added lines in diffs.
497 If not set, the default value
500 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
501 The color used to mark up chunk header lines in diffs.
502 If not set, the default value
505 .It Ev TOG_COLOR_DIFF_META
506 The color used to mark up meta data in diffs.
507 If not set, the default value
510 .It Ev TOG_COLOR_TREE_SUBMODULE
511 The color used to mark up submodule tree entries.
512 If not set, the default value
515 .It Ev TOG_COLOR_TREE_SYMLINK
516 The color used to mark up symbolic link tree entries.
517 If not set, the default value
520 .It Ev TOG_COLOR_TREE_DIRECTORY
521 The color used to mark up directory tree entries.
522 If not set, the default value
525 .It Ev TOG_COLOR_TREE_EXECUTABLE
526 The color used to mark up executable file tree entries.
527 If not set, the default value
530 .It Ev TOG_COLOR_COMMIT
531 The color used to mark up commit IDs.
532 If not set, the default value
535 .It Ev TOG_COLOR_AUTHOR
536 The color used to mark up author information.
537 If not set, the default value
540 .It Ev TOG_COLOR_DATE
541 The color used to mark up date information.
542 If not set, the default value
545 .It Ev TOG_COLOR_REFS_HEADS
546 The color used to mark up references in the
549 If not set, the default value
552 .It Ev TOG_COLOR_REFS_TAGS
553 The color used to mark up references in the
556 If not set, the default value
559 .It Ev TOG_COLOR_REFS_REMOTES
560 The color used to mark up references in the
563 If not set, the default value
571 .Xr git-repository 5 ,
574 .An Stefan Sperling Aq Mt stsp@openbsd.org
575 .An Joshua Stein Aq Mt jcs@openbsd.org
