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,
107 unless an active search is in progress in which case
111 Prompt for a search pattern and start searching for matching commits.
112 The search pattern is an extended regular expression which is matched
113 against a commit's author name, committer name, log message, and
115 Regular expression syntax is documented in
118 Find the next commit which matches the current search pattern.
119 Searching continues until either a match is found or the
123 Find the previous commit which matches the current search pattern.
124 Searching continues until either a match is found or the
128 Reload the log view with new commits found in the repository.
136 Start traversing history at the specified
138 The expected argument is the name of a branch or a commit ID SHA1 hash.
139 An abbreviated hash argument will be expanded to a full SHA1 hash
140 automatically, provided the abbreviation is unique.
141 If this option is not specified, default to the work tree's current branch
142 if invoked in a work tree, or to the repository's HEAD reference.
143 .It Fl r Ar repository-path
144 Use the repository at the specified path.
145 If not specified, assume the repository is located at or above the current
148 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
149 Display the differences between two objects in the repository.
152 argument is an object ID SHA1 hash.
153 An abbreviated hash argument will be expanded to a full SHA1 hash
154 automatically, provided the abbreviation is unique.
155 Both objects must be of the same type (blobs, trees, or commits).
158 is omitted, use the current working directory.
168 .It Cm Page-down, Space, Ctrl+f
169 Scroll down one page.
170 .It Cm Page-up, Ctrl+b
173 Reduce the amount of diff context lines.
175 Increase the amount of diff context lines.
177 If the diff view was opened via the log view, move to the previous (younger)
180 If the diff view was opened via the log view, move to the next (older) commit.
182 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
183 Display line-by-line history of a file at the specified path.
189 .It Cm Down-arrow, j, Page-down, Space
190 Move the selection cursor down.
191 .It Cm Up-arrow, k, Page-up
192 Move the selection cursor up.
196 view for the currently selected line's commit.
200 view with the version of the file as found in the currently
201 selected line's commit.
205 view with the version of the file as found in the parent commit of the
206 currently selected line's commit.
210 view with the previously blamed commit.
212 Prompt for a search pattern and start searching for matching line.
213 The search pattern is an extended regular expression.
214 Regular expression syntax is documented in
217 Find the next line which matches the current search pattern.
219 Find the previous line which matches the current search pattern.
227 Start traversing history at the specified
229 The expected argument is the name of a branch or a commit ID SHA1 hash.
230 An abbreviated hash argument will be expanded to a full SHA1 hash
231 automatically, provided the abbreviation is unique.
232 .It Fl r Ar repository-path
233 Use the repository at the specified path.
234 If not specified, assume the repository is located at or above the current
237 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
238 Display the repository tree.
241 is omitted, assume the repository is located in the current working directory.
247 .It Cm Down-arrow, j, Page-down
248 Move the selection cursor down.
249 .It Cm Up-arrow, k, Page-up
250 Move the selection cursor up.
252 Enter the currently selected directory, or switch to the
254 view for the currently selected file.
258 view for the currently selected tree entry.
260 Move back to the parent directory.
262 Show object IDs for all objects displayed in the
266 Prompt for a search pattern and start searching for matching tree entries.
267 The search pattern is an extended regular expression which is matched
268 against the tree entry's name.
269 Regular expression syntax is documented in
272 Find the next tree entry which matches the current search pattern.
274 Find the previous tree entry which matches the current search pattern.
282 Start traversing history at the specified
284 The expected argument is the name of a branch or a commit ID SHA1 hash.
285 An abbreviated hash argument will be expanded to a full SHA1 hash
286 automatically, provided the abbreviation is unique.
293 .Xr git-repository 5 ,
296 .An Stefan Sperling Aq Mt stsp@openbsd.org
297 .An joshua stein Aq Mt jcs@openbsd.org
