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
29 is an interactive read-only browser for Git repositories.
30 This repository format is described in
31 .Xr git-repository 5 .
34 supports several types of views which display repository data:
37 Displays commits in the repository's history.
38 This view is displayed initially if no
42 Displays changes made in a particular commit.
44 Displays the line-by-line history of a file.
46 Displays the tree corresponding to a particular commit.
50 provides global and command-specific key bindings and options.
51 The global key bindings are:
57 Quit the view which is in focus.
59 Switch focus between views.
61 Toggle fullscreen mode for a split-screen view.
63 will automatically use split-screen views if the size of the terminal
64 window is sufficiently large.
67 Global options must precede the command name, and are as follows:
68 .Bl -tag -width tenletters
70 Display usage information.
72 Display program version and exit immediately.
79 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
80 Display history of a repository.
83 is specified, show only commits which modified this path.
84 If invoked in a work tree, the
86 is interpreted relative to the current working directory,
87 and the work tree's path prefix is implicitly prepended.
88 Otherwise, the path is interpreted relative to the repository root.
90 This command is also executed if no explicit command is specified.
96 .It Cm Down-arrow, j, >, Full stop
97 Move the selection cursor down.
98 .It Cm Up-arrow, k, <, Comma
99 Move the selection cursor up.
100 .It Cm Page-down, Ctrl+f
101 Move the selection cursor down one page.
102 .It Cm Page-up, Ctrl+b
103 Move the selection cursor up one page.
107 view showing file changes made in the currently selected commit.
111 view showing the tree for the currently selected commit.
113 Show log entries for the parent directory of the currently selected path,
114 unless an active search is in progress in which case
118 Prompt for a search pattern and start searching for matching commits.
119 The search pattern is an extended regular expression which is matched
120 against a commit's author name, committer name, log message, and
122 Regular expression syntax is documented in
125 Find the next commit which matches the current search pattern.
126 Searching continues until either a match is found or the
130 Find the previous commit which matches the current search pattern.
131 Searching continues until either a match is found or the
135 Reload the log view with new commits found in the repository.
137 Reload the log view and toggle display of merged commits.
140 option determines whether merged commits are displayed initially.
148 Display individual commits which were merged into the current branch
152 shows the linear history of the current branch only.
155 key binding can be used to toggle display of merged commits at run-time.
157 Start traversing history at the specified
159 The expected argument is the name of a branch or a commit ID SHA1 hash.
160 An abbreviated hash argument will be expanded to a full SHA1 hash
161 automatically, provided the abbreviation is unique.
162 If this option is not specified, default to the work tree's current branch
163 if invoked in a work tree, or to the repository's HEAD reference.
164 .It Fl r Ar repository-path
165 Use the repository at the specified path.
166 If not specified, assume the repository is located at or above the current
168 If this directory is a
170 work tree, use the repository path associated with this work tree.
172 .It Cm diff Oo Fl r Ar repository-path Oc Ar object1 object2
173 Display the differences between two objects in the repository.
176 argument is an object ID SHA1 hash.
177 An abbreviated hash argument will be expanded to a full SHA1 hash
178 automatically, provided the abbreviation is unique.
179 Both objects must be of the same type (blobs, trees, or commits).
189 .It Cm Page-down, Space, Ctrl+f
190 Scroll down one page.
191 .It Cm Page-up, Ctrl+b
194 Reduce the amount of diff context lines.
196 Increase the amount of diff context lines.
198 If the diff view was opened via the log view, move to the previous (younger)
201 If the diff view was opened via the log view, move to the next (older) commit.
203 Prompt for a search pattern and start searching for matching line.
204 The search pattern is an extended regular expression.
205 Regular expression syntax is documented in
208 Find the next line which matches the current search pattern.
210 Find the previous line which matches the current search pattern.
217 .It Fl r Ar repository-path
218 Use the repository at the specified path.
219 If not specified, assume the repository is located at or above the current
221 If this directory is a
223 work tree, use the repository path associated with this work tree.
225 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
226 Display line-by-line history of a file at the specified path.
233 Move the selection cursor down.
235 Move the selection cursor up.
236 .It Cm Page-down, Space, Ctrl+f
237 Move the selection cursor down one page.
238 .It Cm Page-up, Ctrl+b
239 Move the selection cursor up one page.
243 view for the currently selected line's commit.
247 view with the version of the file as found in the currently
248 selected line's commit.
252 view with the version of the file as found in the parent commit of the
253 currently selected line's commit.
257 view with the previously blamed commit.
259 Prompt for a search pattern and start searching for matching line.
260 The search pattern is an extended regular expression.
261 Regular expression syntax is documented in
264 Find the next line which matches the current search pattern.
266 Find the previous line which matches the current search pattern.
274 Start traversing history at the specified
276 The expected argument is the name of a branch or a commit ID SHA1 hash.
277 An abbreviated hash argument will be expanded to a full SHA1 hash
278 automatically, provided the abbreviation is unique.
279 .It Fl r Ar repository-path
280 Use the repository at the specified path.
281 If not specified, assume the repository is located at or above the current
283 If this directory is a
285 work tree, use the repository path associated with this work tree.
287 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
288 Display the repository tree.
291 is specified, show tree entries at this path.
293 Displayed tree entries may carry one of the following trailing annotations:
294 .Bl -column YXZ description
295 .It @ Ta entry is a symbolic link
296 .It / Ta entry is a directory
297 .It * Ta entry is an executable file
298 .It $ Ta entry is a Git submodule
306 Move the selection cursor down.
308 Move the selection cursor up.
309 .It Cm Page-down, Ctrl+f
310 Move the selection cursor down one page.
311 .It Cm Page-up, Ctrl+b
312 Move the selection cursor up one page.
314 Enter the currently selected directory, or switch to the
316 view for the currently selected file.
320 view for the currently selected tree entry.
322 Move back to the parent directory.
324 Show object IDs for all objects displayed in the
328 Prompt for a search pattern and start searching for matching tree entries.
329 The search pattern is an extended regular expression which is matched
330 against the tree entry's name.
331 Regular expression syntax is documented in
334 Find the next tree entry which matches the current search pattern.
336 Find the previous tree entry which matches the current search pattern.
344 Start traversing history at the specified
346 The expected argument is the name of a branch or a commit ID SHA1 hash.
347 An abbreviated hash argument will be expanded to a full SHA1 hash
348 automatically, provided the abbreviation is unique.
349 .It Fl r Ar repository-path
350 Use the repository at the specified path.
351 If not specified, assume the repository is located at or above the current
353 If this directory is a
355 work tree, use the repository path associated with this work tree.
359 .Bl -tag -width TOG_COLORS
362 shows colorized output if this variable is set to a non-empty value.
363 The default color scheme can be modified by setting the environment
364 variables documented below.
365 The colors available in color schemes are
375 which maps to the terminal's default foreground color.
376 .It Ev TOG_COLOR_DIFF_MINUS
377 The color used to mark up removed lines in diffs.
378 If not set, the default value
381 .It Ev TOG_COLOR_DIFF_PLUS
382 The color used to mark up added lines in diffs.
383 If not set, the default value
386 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
387 The color used to mark up chunk header lines in diffs.
388 If not set, the default value
391 .It Ev TOG_COLOR_DIFF_META
392 The color used to mark up meta data in diffs.
393 If not set, the default value
396 .It Ev TOG_COLOR_TREE_SUBMODULE
397 The color used to mark up sobmodules tree entries.
398 If not set, the default value
401 .It Ev TOG_COLOR_TREE_SYMLINK
402 The color used to mark up symbolic link tree entries.
403 If not set, the default value
406 .It Ev TOG_COLOR_TREE_DIRECTORY
407 The color used to mark up directory tree entries.
408 If not set, the default value
411 .It Ev TOG_COLOR_TREE_EXECUTABLE
412 The color used to mark up executable file tree entries.
413 If not set, the default value
416 .It Ev TOG_COLOR_COMMIT
417 The color used to mark up commit IDs.
418 If not set, the default value
421 .It Ev TOG_COLOR_AUTHOR
422 The color used to mark up author information.
423 If not set, the default value
426 .It Ev TOG_COLOR_DATE
427 The color used to mark up date information.
428 If not set, the default value
436 .Xr git-repository 5 ,
439 .An Stefan Sperling Aq Mt stsp@openbsd.org
440 .An Joshua Stein Aq Mt jcs@openbsd.org