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 to the next view. Cycles through all views.
61 Switch focus to the previous view. Cycles through all views.
63 Toggle fullscreen mode for the view which is in focus.
66 Global options must precede the command name, and are as follows:
67 .Bl -tag -width tenletters
69 Display usage information.
76 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
77 Display history of a repository.
80 is specified, show only commits which modified this path.
82 This command is also executed if no explicit command is specified.
88 .It Cm Down-arrow, j, ], Page-down
89 Move the selection cursor down.
90 .It Cm Up-arrow, k, [, Page-up
91 Move the selection cursor up.
95 view showing file changes made in the currently selected commit.
99 view showing the tree for the currently selected commit.
101 Show log entries for the parent directory of the currently selected path.
109 Start traversing history at the specified
111 The expected argument is the name of a branch or a SHA1 hash which corresponds
113 .It Fl r Ar repository-path
114 Use the repository at the specified path.
115 If not specified, assume the repository is located at or above the current
118 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
119 Display the differences between two objects in the repository.
122 argument is a SHA1 hash which corresponds to the object.
123 Both objects must be of the same type (blobs, trees, or commits).
126 is omitted, use the current working directory.
132 .It Cm Down-arrow, j, Page-down, Space
134 .It Cm Up-arrow, k, Page-up
137 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
138 Display line-by-line history of a file at the specified path.
144 .It Cm Down-arrow, j, Page-down, Space
145 Move the selection cursor down.
146 .It Cm Up-arrow, k, Page-up
147 Move the selection cursor up.
151 view for the currently selected line's commit.
155 view for the version of the file in the currently selected line's commit.
159 view for the version of the file in the currently selected line's commit's
164 view back to the previously blamed commit.
172 Start traversing history at the specified
174 The expected argument is the name of a branch or a SHA1 hash which corresponds
176 .It Fl r Ar repository-path
177 Use the repository at the specified path.
178 If not specified, assume the repository is located at or above the current
181 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
182 Display the repository tree.
185 is omitted, assume the repository is located in the current working directory.
191 .It Cm Down-arrow, j, Page-down
192 Move the selection cursor down.
193 .It Cm Up-arrow, k, Page-up
194 Move the selection cursor up.
196 Enter the currently selected directory, or switch to the
198 view for the currently selected file.
202 view for the currently selected tree entry.
204 Move back to the parent directory.
206 Show the object IDs for all objects displayed in the
216 Start traversing history at the specified
218 The expected argument is the name of a branch or a SHA1 hash which corresponds
227 .An Stefan Sperling Aq Mt stsp@openbsd.org