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.
108 Prompt for a search pattern and start searching for matching commits.
109 The search pattern is an extended regular expression which is matched
110 against a commit's author name, committer name, and log message.
111 Regular expression syntax is documented in
114 Find the next commit which matches the current search pattern.
116 Find the previous commit which matches the current search pattern.
118 Reload the log view with new commits found in the repository.
126 Start traversing history at the specified
128 The expected argument is the name of a branch or a SHA1 hash which corresponds
130 If this option is not specified, default to the work tree's current branch
131 if invoked in a work tree, or to the repository's HEAD reference.
132 .It Fl r Ar repository-path
133 Use the repository at the specified path.
134 If not specified, assume the repository is located at or above the current
137 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
138 Display the differences between two objects in the repository.
141 argument is a SHA1 hash which corresponds to the object.
142 Both objects must be of the same type (blobs, trees, or commits).
145 is omitted, use the current working directory.
155 .It Cm Page-down, Space, Ctrl+f
156 Scroll down one page.
157 .It Cm Page-up, Ctrl+b
160 Reduce the amount of diff context lines.
162 Increase the amount of diff context lines.
164 If the diff view was opened via the log view, move to the previous (younger)
167 If the diff view was opened via the log view, move to the next (older) commit.
169 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
170 Display line-by-line history of a file at the specified path.
176 .It Cm Down-arrow, j, Page-down, Space
177 Move the selection cursor down.
178 .It Cm Up-arrow, k, Page-up
179 Move the selection cursor up.
183 view for the currently selected line's commit.
187 view with the version of the file as found in the currently
188 selected line's commit.
192 view with the version of the file as found in the parent commit of the
193 currently selected line's commit.
197 view with the previously blamed commit.
199 Prompt for a search pattern and start searching for matching line.
200 The search pattern is an extended regular expression.
201 Regular expression syntax is documented in
204 Find the next line which matches the current search pattern.
206 Find the previous line which matches the current search pattern.
214 Start traversing history at the specified
216 The expected argument is the name of a branch or a SHA1 hash which corresponds
218 .It Fl r Ar repository-path
219 Use the repository at the specified path.
220 If not specified, assume the repository is located at or above the current
223 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
224 Display the repository tree.
227 is omitted, assume the repository is located in the current working directory.
233 .It Cm Down-arrow, j, Page-down
234 Move the selection cursor down.
235 .It Cm Up-arrow, k, Page-up
236 Move the selection cursor up.
238 Enter the currently selected directory, or switch to the
240 view for the currently selected file.
244 view for the currently selected tree entry.
246 Move back to the parent directory.
248 Show object IDs for all objects displayed in the
252 Prompt for a search pattern and start searching for matching tree entries.
253 The search pattern is an extended regular expression which is matched
254 against the tree entry's name.
255 Regular expression syntax is documented in
258 Find the next tree entry which matches the current search pattern.
260 Find the previous tree entry which matches the current search pattern.
268 Start traversing history at the specified
270 The expected argument is the name of a branch or a SHA1 hash which corresponds
278 .Xr git-repository 5 ,
281 .An Stefan Sperling Aq Mt stsp@openbsd.org
282 .An joshua stein Aq Mt jcs@openbsd.org