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
33 is an interactive read-only browser for Git repositories.
34 This repository format is described in
35 .Xr git-repository 5 .
38 supports several types of views which display repository data:
41 Displays commits in the repository's history.
42 This view is displayed initially if no
44 is specified, or if just a
48 Displays changes made in a particular commit.
50 Displays the line-by-line history of a file.
52 Displays the tree corresponding to a particular commit.
56 provides global and command-specific key bindings and options.
57 The global key bindings are:
63 Quit the view which is in focus.
65 Switch focus between views.
67 Toggle fullscreen mode for a split-screen view.
69 will automatically use split-screen views if the size of the terminal
70 window is sufficiently large.
73 Global options must precede the command name, and are as follows:
74 .Bl -tag -width tenletters
76 Display usage information.
78 Display program version and exit immediately.
85 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
86 Display history of a repository.
89 is specified, show only commits which modified this path.
90 If invoked in a work tree, the
92 is interpreted relative to the current working directory,
93 and the work tree's path prefix is implicitly prepended.
94 Otherwise, the path is interpreted relative to the repository root.
96 This command is also executed if no explicit command is specified.
102 .It Cm Down-arrow, j, >, Full stop
103 Move the selection cursor down.
104 .It Cm Up-arrow, k, <, Comma
105 Move the selection cursor up.
106 .It Cm Page-down, Ctrl+f
107 Move the selection cursor down one page.
108 .It Cm Page-up, Ctrl+b
109 Move the selection cursor up one page.
113 view showing file changes made in the currently selected commit.
117 view showing the tree for the currently selected commit.
119 Show log entries for the parent directory of the currently selected path,
120 unless an active search is in progress in which case
124 Prompt for a search pattern and start searching for matching commits.
125 The search pattern is an extended regular expression which is matched
126 against a commit's author name, committer name, log message, and
128 Regular expression syntax is documented in
131 Find the next commit which matches the current search pattern.
132 Searching continues until either a match is found or the
136 Find the previous commit which matches the current search pattern.
137 Searching continues until either a match is found or the
141 Reload the log view with new commits found in the repository.
143 Reload the log view and toggle display of merged commits.
146 option determines whether merged commits are displayed initially.
154 Display individual commits which were merged into the current branch
158 shows the linear history of the current branch only.
161 key binding can be used to toggle display of merged commits at run-time.
163 Start traversing history at the specified
165 The expected argument is the name of a branch or a commit ID SHA1 hash.
166 An abbreviated hash argument will be expanded to a full SHA1 hash
167 automatically, provided the abbreviation is unique.
168 If this option is not specified, default to the work tree's current branch
169 if invoked in a work tree, or to the repository's HEAD reference.
170 .It Fl r Ar repository-path
171 Use the repository at the specified path.
172 If not specified, assume the repository is located at or above the current
174 If this directory is a
176 work tree, use the repository path associated with this work tree.
178 .It Cm diff Oo Fl a Oc Oo Fl r Ar repository-path Oc Ar object1 object2
179 Display the differences between two objects in the repository.
180 Treat each of the two arguments as a reference, a tag name, or an object
181 ID SHA1 hash, and display differences between the corresponding objects.
182 Both objects must be of the same type (blobs, trees, or commits).
183 An abbreviated hash argument will be expanded to a full SHA1 hash
184 automatically, provided the abbreviation is unique.
191 Toggle treatment of file contents as ASCII text even if binary data was
197 .It Cm Page-down, Space, Ctrl+f
198 Scroll down one page.
199 .It Cm Page-up, Ctrl+b
202 Reduce the amount of diff context lines.
204 Increase the amount of diff context lines.
206 If the diff view was opened via the log view, move to the previous (younger)
209 If the diff view was opened via the log view, move to the next (older) commit.
211 Prompt for a search pattern and start searching for matching lines.
212 The search pattern is an extended regular expression.
213 Regular expression syntax is documented in
216 Find the next line which matches the current search pattern.
218 Find the previous line which matches the current search pattern.
220 Toggle display of whitespace-only changes.
228 Treat file contents as ASCII text even if binary data is detected.
230 Set the number of context lines shown in the diff.
231 By default, 3 lines of context are shown.
232 .It Fl r Ar repository-path
233 Use the repository at the specified path.
234 If not specified, assume the repository is located at or above the current
236 If this directory is a
238 work tree, use the repository path associated with this work tree.
240 Ignore whitespace-only changes.
242 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
243 Display line-by-line history of a file at the specified path.
250 Move the selection cursor down.
252 Move the selection cursor up.
253 .It Cm Page-down, Space, Ctrl+f
254 Move the selection cursor down one page.
255 .It Cm Page-up, Ctrl+b
256 Move the selection cursor up one page.
260 view for the currently selected line's commit.
264 view with the version of the file as found in the currently
265 selected line's commit.
269 view with the version of the file as found in the parent commit of the
270 currently selected line's commit.
274 view with the previously blamed commit.
276 Prompt for a search pattern and start searching for matching lines.
277 The search pattern is an extended regular expression.
278 Regular expression syntax is documented in
281 Find the next line which matches the current search pattern.
283 Find the previous line which matches the current search pattern.
291 Start traversing history at the specified
293 The expected argument is the name of a branch or a commit ID SHA1 hash.
294 An abbreviated hash argument will be expanded to a full SHA1 hash
295 automatically, provided the abbreviation is unique.
296 .It Fl r Ar repository-path
297 Use the repository at the specified path.
298 If not specified, assume the repository is located at or above the current
300 If this directory is a
302 work tree, use the repository path associated with this work tree.
304 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
305 Display the repository tree.
308 is specified, show tree entries at this path.
310 Displayed tree entries may carry one of the following trailing annotations:
311 .Bl -column YXZ description
312 .It @ Ta entry is a symbolic link
313 .It / Ta entry is a directory
314 .It * Ta entry is an executable file
315 .It $ Ta entry is a Git submodule
318 Symbolic link entries are also annotated with the target path of the link.
325 Move the selection cursor down.
327 Move the selection cursor up.
328 .It Cm Page-down, Ctrl+f
329 Move the selection cursor down one page.
330 .It Cm Page-up, Ctrl+b
331 Move the selection cursor up one page.
333 Enter the currently selected directory, or switch to the
335 view for the currently selected file.
339 view for the currently selected tree entry.
341 Move back to the parent directory.
343 Show object IDs for all objects displayed in the
347 Prompt for a search pattern and start searching for matching tree entries.
348 The search pattern is an extended regular expression which is matched
349 against the tree entry's name.
350 Regular expression syntax is documented in
353 Find the next tree entry which matches the current search pattern.
355 Find the previous tree entry which matches the current search pattern.
363 Start traversing history at the specified
365 The expected argument is the name of a branch or a commit ID SHA1 hash.
366 An abbreviated hash argument will be expanded to a full SHA1 hash
367 automatically, provided the abbreviation is unique.
368 .It Fl r Ar repository-path
369 Use the repository at the specified path.
370 If not specified, assume the repository is located at or above the current
372 If this directory is a
374 work tree, use the repository path associated with this work tree.
378 .Bl -tag -width TOG_COLORS
381 shows colorized output if this variable is set to a non-empty value.
382 The default color scheme can be modified by setting the environment
383 variables documented below.
384 The colors available in color schemes are
394 which maps to the terminal's default foreground color.
395 .It Ev TOG_COLOR_DIFF_MINUS
396 The color used to mark up removed lines in diffs.
397 If not set, the default value
400 .It Ev TOG_COLOR_DIFF_PLUS
401 The color used to mark up added lines in diffs.
402 If not set, the default value
405 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
406 The color used to mark up chunk header lines in diffs.
407 If not set, the default value
410 .It Ev TOG_COLOR_DIFF_META
411 The color used to mark up meta data in diffs.
412 If not set, the default value
415 .It Ev TOG_COLOR_TREE_SUBMODULE
416 The color used to mark up sobmodules tree entries.
417 If not set, the default value
420 .It Ev TOG_COLOR_TREE_SYMLINK
421 The color used to mark up symbolic link tree entries.
422 If not set, the default value
425 .It Ev TOG_COLOR_TREE_DIRECTORY
426 The color used to mark up directory tree entries.
427 If not set, the default value
430 .It Ev TOG_COLOR_TREE_EXECUTABLE
431 The color used to mark up executable file tree entries.
432 If not set, the default value
435 .It Ev TOG_COLOR_COMMIT
436 The color used to mark up commit IDs.
437 If not set, the default value
440 .It Ev TOG_COLOR_AUTHOR
441 The color used to mark up author information.
442 If not set, the default value
445 .It Ev TOG_COLOR_DATE
446 The color used to mark up date information.
447 If not set, the default value
455 .Xr git-repository 5 ,
458 .An Stefan Sperling Aq Mt stsp@openbsd.org
459 .An Joshua Stein Aq Mt jcs@openbsd.org
