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
169 .It Cm diff Oo Fl r Ar repository-path Oc Ar object1 object2
170 Display the differences between two objects in the repository.
173 argument is an object ID SHA1 hash.
174 An abbreviated hash argument will be expanded to a full SHA1 hash
175 automatically, provided the abbreviation is unique.
176 Both objects must be of the same type (blobs, trees, or commits).
186 .It Cm Page-down, Space, Ctrl+f
187 Scroll down one page.
188 .It Cm Page-up, Ctrl+b
191 Reduce the amount of diff context lines.
193 Increase the amount of diff context lines.
195 If the diff view was opened via the log view, move to the previous (younger)
198 If the diff view was opened via the log view, move to the next (older) commit.
200 Prompt for a search pattern and start searching for matching line.
201 The search pattern is an extended regular expression.
202 Regular expression syntax is documented in
205 Find the next line which matches the current search pattern.
207 Find the previous line which matches the current search pattern.
214 .It Fl r Ar repository-path
215 Use the repository at the specified path.
216 If not specified, assume the repository is located at or above the current
219 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
220 Display line-by-line history of a file at the specified path.
227 Move the selection cursor down.
229 Move the selection cursor up.
230 .It Cm Page-down, Space, Ctrl+f
231 Move the selection cursor down one page.
232 .It Cm Page-up, Ctrl+b
233 Move the selection cursor up one page.
237 view for the currently selected line's commit.
241 view with the version of the file as found in the currently
242 selected line's commit.
246 view with the version of the file as found in the parent commit of the
247 currently selected line's commit.
251 view with the previously blamed commit.
253 Prompt for a search pattern and start searching for matching line.
254 The search pattern is an extended regular expression.
255 Regular expression syntax is documented in
258 Find the next line which matches the current search pattern.
260 Find the previous line which matches the current search pattern.
268 Start traversing history at the specified
270 The expected argument is the name of a branch or a commit ID SHA1 hash.
271 An abbreviated hash argument will be expanded to a full SHA1 hash
272 automatically, provided the abbreviation is unique.
273 .It Fl r Ar repository-path
274 Use the repository at the specified path.
275 If not specified, assume the repository is located at or above the current
278 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
279 Display the repository tree.
282 is specified, show tree entries at this path.
284 Displayed tree entries may carry one of the following trailing annotations:
285 .Bl -column YXZ description
286 .It @ Ta entry is a symbolic link
287 .It / Ta entry is a directory
288 .It * Ta entry is an executable file
289 .It $ Ta entry is a Git submodule
297 Move the selection cursor down.
299 Move the selection cursor up.
300 .It Cm Page-down, Ctrl+f
301 Move the selection cursor down one page.
302 .It Cm Page-up, Ctrl+b
303 Move the selection cursor up one page.
305 Enter the currently selected directory, or switch to the
307 view for the currently selected file.
311 view for the currently selected tree entry.
313 Move back to the parent directory.
315 Show object IDs for all objects displayed in the
319 Prompt for a search pattern and start searching for matching tree entries.
320 The search pattern is an extended regular expression which is matched
321 against the tree entry's name.
322 Regular expression syntax is documented in
325 Find the next tree entry which matches the current search pattern.
327 Find the previous tree entry which matches the current search pattern.
335 Start traversing history at the specified
337 The expected argument is the name of a branch or a commit ID SHA1 hash.
338 An abbreviated hash argument will be expanded to a full SHA1 hash
339 automatically, provided the abbreviation is unique.
340 .It Fl r Ar repository-path
341 Use the repository at the specified path.
342 If not specified, assume the repository is located at or above the current
344 If this directory is a
346 work tree, use the repository path associated with this work tree.
350 .Bl -tag -width TOG_COLORS
353 shows colorized output if this variable is set to a non-empty value.
354 The default color scheme can be modified by setting the environment
355 variables documented below.
356 The colors available in color schemes are
366 which maps to the terminal's default foreground color.
367 .It Ev TOG_COLOR_DIFF_MINUS
368 The color used to mark up removed lines in diffs.
369 If not set, the default value
372 .It Ev TOG_COLOR_DIFF_PLUS
373 The color used to mark up added lines in diffs.
374 If not set, the default value
377 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
378 The color used to mark up chunk header lines in diffs.
379 If not set, the default value
382 .It Ev TOG_COLOR_DIFF_META
383 The color used to mark up meta data in diffs.
384 If not set, the default value
387 .It Ev TOG_COLOR_TREE_SUBMODULE
388 The color used to mark up sobmodules tree entries.
389 If not set, the default value
392 .It Ev TOG_COLOR_TREE_SYMLINK
393 The color used to mark up symbolic link tree entries.
394 If not set, the default value
397 .It Ev TOG_COLOR_TREE_DIRECTORY
398 The color used to mark up directory tree entries.
399 If not set, the default value
402 .It Ev TOG_COLOR_TREE_EXECUTABLE
403 The color used to mark up executable file tree entries.
404 If not set, the default value
407 .It Ev TOG_COLOR_COMMIT
408 The color used to mark up commit IDs.
409 If not set, the default value
412 .It Ev TOG_COLOR_AUTHOR
413 The color used to mark up author information.
414 If not set, the default value
417 .It Ev TOG_COLOR_DATE
418 The color used to mark up date information.
419 If not set, the default value
427 .Xr git-repository 5 ,
430 .An Stefan Sperling Aq Mt stsp@openbsd.org
431 .An Joshua Stein Aq Mt jcs@openbsd.org