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.
35 An arbitrary number of views may be opened simultaneously by
36 navigating the repository with
38 Sometimes, if one view is opened from another view, the child view
39 is linked to its parent view and both views will keep their data
41 The supported views are:
44 Displays commits in the repository's history.
45 This view is displayed initially if no
49 Displays changes made in a particular commit.
51 Displays the line-by-line history of a file.
53 Displays the tree corresponding to a particular commit.
57 provides global and command-specific key bindings and options.
58 The global key bindings are:
64 Quit the view which is in focus.
66 Switch focus to the next view.
67 Cycles through all open views.
69 Switch focus to the previous view.
70 Cycles through all open views.
73 Global options must precede the command name, and are as follows:
74 .Bl -tag -width tenletters
76 Display usage information.
83 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
84 Display history of a repository.
87 is specified, show only commits which modified this path.
89 This command is also executed if no explicit command is specified.
95 .It Cm Down-arrow, j, ], Page-down
96 Move the selection cursor down.
97 .It Cm Up-arrow, k, [, Page-up
98 Move the selection cursor up.
102 view showing file changes made in the currently selected commit.
103 The diff view is linked to the log view so either view will be
104 updated when the other switches to a different commit.
108 view showing the tree for the currently selected commit.
116 Start traversing history at the specified
118 The expected argument is the name of a branch or a SHA1 hash which corresponds
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.
139 .It Cm Down-arrow, j, Page-down, Space
141 .It Cm Up-arrow, k, Page-up
144 Switch to the previous commit in parent
147 Switch to the next commit in parent
150 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
151 Display line-by-line history of a file at the specified path.
157 .It Cm Down-arrow, j, Page-down, Space
158 Move the selection cursor down.
159 .It Cm Up-arrow, k, Page-up
160 Move the selection cursor up.
164 view for the currently selected line's commit.
168 view for the version of the file in the currently selected line's commit.
172 view for the version of the file in the currently selected line's commit's
177 view back to the previously blamed commit.
185 Start traversing history at the specified
187 The expected argument is the name of a branch or a SHA1 hash which corresponds
189 .It Fl r Ar repository-path
190 Use the repository at the specified path.
191 If not specified, assume the repository is located at or above the current
194 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
195 Display the repository tree.
198 is omitted, assume the repository is located in the current working directory.
204 .It Cm Down-arrow, j, Page-down
205 Move the selection cursor down.
206 .It Cm Up-arrow, k, Page-up
207 Move the selection cursor up.
209 Enter the currently selected directory, or switch to the
211 view for the currently selected file.
215 view for the currently selected tree entry.
217 Move back to the parent directory.
219 Show the object IDs for all objects displayed in the
229 Start traversing history at the specified
231 The expected argument is the name of a branch or a SHA1 hash which corresponds
240 .An Stefan Sperling Aq Mt stsp@openbsd.org