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.
114 view showing file changes made in the currently selected commit.
118 view showing the tree for the currently selected commit.
120 Show log entries for the parent directory of the currently selected path,
121 unless an active search is in progress in which case
125 Prompt for a search pattern and start searching for matching commits.
126 The search pattern is an extended regular expression which is matched
127 against a commit's author name, committer name, log message, and
129 Regular expression syntax is documented in
132 Find the next commit which matches the current search pattern.
133 Searching continues until either a match is found or the
137 Find the previous commit which matches the current search pattern.
138 Searching continues until either a match is found or the
144 view with new commits found in the repository.
148 view and toggle display of merged commits.
151 option determines whether merged commits are displayed initially.
155 view listing all references in the repository.
156 This can then be used to open a new
158 view for arbitrary branches and tags.
166 Display individual commits which were merged into the current branch
170 shows the linear history of the current branch only.
173 key binding can be used to toggle display of merged commits at run-time.
175 Start traversing history at the specified
177 The expected argument is the name of a branch or a commit ID SHA1 hash.
178 An abbreviated hash argument will be expanded to a full SHA1 hash
179 automatically, provided the abbreviation is unique.
180 If this option is not specified, default to the work tree's current branch
181 if invoked in a work tree, or to the repository's HEAD reference.
182 .It Fl r Ar repository-path
183 Use the repository at the specified path.
184 If not specified, assume the repository is located at or above the current
186 If this directory is a
188 work tree, use the repository path associated with this work tree.
190 .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
191 Display the differences between two objects in the repository.
192 Treat each of the two arguments as a reference, a tag name, or an object
193 ID SHA1 hash, and display differences between the corresponding objects.
194 Both objects must be of the same type (blobs, trees, or commits).
195 An abbreviated hash argument will be expanded to a full SHA1 hash
196 automatically, provided the abbreviation is unique.
203 Toggle treatment of file contents as ASCII text even if binary data was
209 .It Cm Page-down, Space, Ctrl+f
210 Scroll down one page.
211 .It Cm Page-up, Ctrl+b
214 Reduce the amount of diff context lines.
216 Increase the amount of diff context lines.
220 view was opened via the
222 view, move to the previous (younger) commit.
226 view was opened via the
228 view, move to the next (older) commit.
230 Prompt for a search pattern and start searching for matching lines.
231 The search pattern is an extended regular expression.
232 Regular expression syntax is documented in
235 Find the next line which matches the current search pattern.
237 Find the previous line which matches the current search pattern.
239 Toggle display of whitespace-only changes.
247 Treat file contents as ASCII text even if binary data is detected.
249 Set the number of context lines shown in the diff.
250 By default, 3 lines of context are shown.
251 .It Fl r Ar repository-path
252 Use the repository at the specified path.
253 If not specified, assume the repository is located at or above the current
255 If this directory is a
257 work tree, use the repository path associated with this work tree.
259 Ignore whitespace-only changes.
261 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
262 Display line-by-line history of a file at the specified path.
269 Move the selection cursor down.
271 Move the selection cursor up.
272 .It Cm Page-down, Space, Ctrl+f
273 Move the selection cursor down one page.
274 .It Cm Page-up, Ctrl+b
275 Move the selection cursor up one page.
279 view for the currently selected line's commit.
283 view with the version of the file as found in the currently
284 selected line's commit.
288 view with the version of the file as found in the parent commit of the
289 currently selected line's commit.
293 view with the previously blamed commit.
295 Prompt for a search pattern and start searching for matching lines.
296 The search pattern is an extended regular expression.
297 Regular expression syntax is documented in
300 Find the next line which matches the current search pattern.
302 Find the previous line which matches the current search pattern.
310 Start traversing history at the specified
312 The expected argument is the name of a branch or a commit ID SHA1 hash.
313 An abbreviated hash argument will be expanded to a full SHA1 hash
314 automatically, provided the abbreviation is unique.
315 .It Fl r Ar repository-path
316 Use the repository at the specified path.
317 If not specified, assume the repository is located at or above the current
319 If this directory is a
321 work tree, use the repository path associated with this work tree.
323 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
324 Display the repository tree.
327 is specified, show tree entries at this path.
329 Displayed tree entries may carry one of the following trailing annotations:
330 .Bl -column YXZ description
331 .It @ Ta entry is a symbolic link
332 .It / Ta entry is a directory
333 .It * Ta entry is an executable file
334 .It $ Ta entry is a Git submodule
337 Symbolic link entries are also annotated with the target path of the link.
344 Move the selection cursor down.
346 Move the selection cursor up.
347 .It Cm Page-down, Ctrl+f
348 Move the selection cursor down one page.
349 .It Cm Page-up, Ctrl+b
350 Move the selection cursor up one page.
352 Enter the currently selected directory, or switch to the
354 view for the currently selected file.
358 view for the currently selected tree entry.
362 view listing all references in the repository.
363 This can then be used to open a new
365 view for arbitrary branches and tags.
367 Move back to the parent directory.
369 Show object IDs for all objects displayed in the
373 Prompt for a search pattern and start searching for matching tree entries.
374 The search pattern is an extended regular expression which is matched
375 against the tree entry's name.
376 Regular expression syntax is documented in
379 Find the next tree entry which matches the current search pattern.
381 Find the previous tree entry which matches the current search pattern.
389 Start traversing history at the specified
391 The expected argument is the name of a branch or a commit ID SHA1 hash.
392 An abbreviated hash argument will be expanded to a full SHA1 hash
393 automatically, provided the abbreviation is unique.
394 .It Fl r Ar repository-path
395 Use the repository at the specified path.
396 If not specified, assume the repository is located at or above the current
398 If this directory is a
400 work tree, use the repository path associated with this work tree.
402 .It Cm ref Oo Fl r Ar repository-path Oc
403 Display references in the repository.
410 Move the selection cursor down.
412 Move the selection cursor up.
413 .It Cm Page-down, Ctrl+f
414 Move the selection cursor down one page.
415 .It Cm Page-up, Ctrl+b
416 Move the selection cursor up one page.
420 view which begins traversing history at the commit resolved via the
421 currently selected reference.
425 view showing the tree resolved via the currently selected reference.
427 Show object IDs for all non-symbolic references displayed in the
431 Prompt for a search pattern and start searching for matching references.
432 The search pattern is an extended regular expression which is matched
433 against absolute reference names.
434 Regular expression syntax is documented in
437 Find the next reference which matches the current search pattern.
439 Find the previous reference which matches the current search pattern.
441 Reload the list of references displayed by the
450 .It Fl r Ar repository-path
451 Use the repository at the specified path.
452 If not specified, assume the repository is located at or above the current
454 If this directory is a
456 work tree, use the repository path associated with this work tree.
460 .Bl -tag -width TOG_COLORS
463 shows colorized output if this variable is set to a non-empty value.
464 The default color scheme can be modified by setting the environment
465 variables documented below.
466 The colors available in color schemes are
476 which maps to the terminal's default foreground color.
477 .It Ev TOG_COLOR_DIFF_MINUS
478 The color used to mark up removed lines in diffs.
479 If not set, the default value
482 .It Ev TOG_COLOR_DIFF_PLUS
483 The color used to mark up added lines in diffs.
484 If not set, the default value
487 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
488 The color used to mark up chunk header lines in diffs.
489 If not set, the default value
492 .It Ev TOG_COLOR_DIFF_META
493 The color used to mark up meta data in diffs.
494 If not set, the default value
497 .It Ev TOG_COLOR_TREE_SUBMODULE
498 The color used to mark up sobmodules tree entries.
499 If not set, the default value
502 .It Ev TOG_COLOR_TREE_SYMLINK
503 The color used to mark up symbolic link tree entries.
504 If not set, the default value
507 .It Ev TOG_COLOR_TREE_DIRECTORY
508 The color used to mark up directory tree entries.
509 If not set, the default value
512 .It Ev TOG_COLOR_TREE_EXECUTABLE
513 The color used to mark up executable file tree entries.
514 If not set, the default value
517 .It Ev TOG_COLOR_COMMIT
518 The color used to mark up commit IDs.
519 If not set, the default value
522 .It Ev TOG_COLOR_AUTHOR
523 The color used to mark up author information.
524 If not set, the default value
527 .It Ev TOG_COLOR_DATE
528 The color used to mark up date information.
529 If not set, the default value
532 .It Ev TOG_COLOR_REFS_HEADS
533 The color used to mark up references in the
536 If not set, the default value
539 .It Ev TOG_COLOR_REFS_TAGS
540 The color used to mark up references in the
543 If not set, the default value
546 .It Ev TOG_COLOR_REFS_REMOTES
547 The color used to mark up references in the
550 If not set, the default value
558 .Xr git-repository 5 ,
561 .An Stefan Sperling Aq Mt stsp@openbsd.org
562 .An Joshua Stein Aq Mt jcs@openbsd.org
