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.
64 Global options must precede the command name, and are as follows:
65 .Bl -tag -width tenletters
67 Display usage information.
74 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
75 Display history of a repository.
78 is specified, show only commits which modified this path.
80 This command is also executed if no explicit command is specified.
86 .It Cm Down-arrow, j, Page-down, >, Full stop
87 Move the selection cursor down.
88 .It Cm Up-arrow, k, Page-up, <, Comma
89 Move the selection cursor up.
93 view showing file changes made in the currently selected commit.
97 view showing the tree for the currently selected commit.
99 Show log entries for the parent directory of the currently selected path.
107 Start traversing history at the specified
109 The expected argument is the name of a branch or a SHA1 hash which corresponds
111 .It Fl r Ar repository-path
112 Use the repository at the specified path.
113 If not specified, assume the repository is located at or above the current
116 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
117 Display the differences between two objects in the repository.
120 argument is a SHA1 hash which corresponds to the object.
121 Both objects must be of the same type (blobs, trees, or commits).
124 is omitted, use the current working directory.
130 .It Cm Down-arrow, j, Page-down, Space
132 .It Cm Up-arrow, k, Page-up
135 Reduce the amount of diff context lines.
137 Increase the amount of diff context lines.
139 If the diff view was opened via the log view, move to the previous (younger)
142 If the diff view was opened via the log view, move to the next (older) commit.
144 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
145 Display line-by-line history of a file at the specified path.
151 .It Cm Down-arrow, j, Page-down, Space
152 Move the selection cursor down.
153 .It Cm Up-arrow, k, Page-up
154 Move the selection cursor up.
158 view for the currently selected line's commit.
162 view with the version of the file as found in the currently
163 selected line's commit.
167 view with the version of the file as found in the parent commit of the
168 currently selected line's commit.
172 view with the previously blamed commit.
180 Start traversing history at the specified
182 The expected argument is the name of a branch or a SHA1 hash which corresponds
184 .It Fl r Ar repository-path
185 Use the repository at the specified path.
186 If not specified, assume the repository is located at or above the current
189 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
190 Display the repository tree.
193 is omitted, assume the repository is located in the current working directory.
199 .It Cm Down-arrow, j, Page-down
200 Move the selection cursor down.
201 .It Cm Up-arrow, k, Page-up
202 Move the selection cursor up.
204 Enter the currently selected directory, or switch to the
206 view for the currently selected file.
210 view for the currently selected tree entry.
212 Move back to the parent directory.
214 Show object IDs for all objects displayed in the
224 Start traversing history at the specified
226 The expected argument is the name of a branch or a SHA1 hash which corresponds
235 .An Stefan Sperling Aq Mt stsp@openbsd.org