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.
77 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
78 Display history of a repository.
81 is specified, show only commits which modified this path.
83 This command is also executed if no explicit command is specified.
89 .It Cm Down-arrow, j, >, Full stop
90 Move the selection cursor down.
91 .It Cm Up-arrow, k, <, Comma
92 Move the selection cursor up.
93 .It Cm Page-down, Ctrl-f
94 Move the selection cursor down one page.
95 .It Cm Page-up, Ctrl-b
96 Move the selection cursor up one page.
100 view showing file changes made in the currently selected commit.
104 view showing the tree for the currently selected commit.
106 Show log entries for the parent directory of the currently selected path.
114 Start traversing history at the specified
116 The expected argument is the name of a branch or a SHA1 hash which corresponds
118 If this option is not specified, default to the work tree's current branch
119 if invoked in a work tree, or to the repository's HEAD reference.
120 .It Fl r Ar repository-path
121 Use the repository at the specified path.
122 If not specified, assume the repository is located at or above the current
125 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
126 Display the differences between two objects in the repository.
129 argument is a SHA1 hash which corresponds to the object.
130 Both objects must be of the same type (blobs, trees, or commits).
133 is omitted, use the current working directory.
143 .It Cm Page-down, Space, Ctrl+f
144 Scroll down one page.
145 .It Cm Page-up, Ctrl+b
148 Reduce the amount of diff context lines.
150 Increase the amount of diff context lines.
152 If the diff view was opened via the log view, move to the previous (younger)
155 If the diff view was opened via the log view, move to the next (older) commit.
157 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
158 Display line-by-line history of a file at the specified path.
164 .It Cm Down-arrow, j, Page-down, Space
165 Move the selection cursor down.
166 .It Cm Up-arrow, k, Page-up
167 Move the selection cursor up.
171 view for the currently selected line's commit.
175 view with the version of the file as found in the currently
176 selected line's commit.
180 view with the version of the file as found in the parent commit of the
181 currently selected line's commit.
185 view with the previously blamed commit.
193 Start traversing history at the specified
195 The expected argument is the name of a branch or a SHA1 hash which corresponds
197 .It Fl r Ar repository-path
198 Use the repository at the specified path.
199 If not specified, assume the repository is located at or above the current
202 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
203 Display the repository tree.
206 is omitted, assume the repository is located in the current working directory.
212 .It Cm Down-arrow, j, Page-down
213 Move the selection cursor down.
214 .It Cm Up-arrow, k, Page-up
215 Move the selection cursor up.
217 Enter the currently selected directory, or switch to the
219 view for the currently selected file.
223 view for the currently selected tree entry.
225 Move back to the parent directory.
227 Show object IDs for all objects displayed in the
237 Start traversing history at the specified
239 The expected argument is the name of a branch or a SHA1 hash which corresponds
248 .An Stefan Sperling Aq Mt stsp@openbsd.org
249 .An joshua stein Aq Mt jcs@openbsd.org