1 .\"
2 .\" Copyright (c) 2018 Stefan Sperling
3 .\"
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.
7 .\"
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.
15 .\"
16 .Dd $Mdocdate$
17 .Dt TOG 1
18 .Os
19 .Sh NAME
20 .Nm tog
21 .Nd git repository browser
22 .Sh SYNOPSIS
23 .Nm
24 .Ar command
25 .Op Fl h
26 .Op Ar arg ...
27 .Sh DESCRIPTION
28 .Nm
29 is an interactive read-only browser for git repositories.
30 This repository format is described in
31 .Xr git-repository 5 .
32 .Pp
33 .Nm
34 supports several types of views which display repository data:
35 .Bl -tag -width Ds
36 .It Log view
37 Displays commits in the repository's history.
38 This view is displayed initially if no
39 .Ar command
40 is specified.
41 .It Diff view
42 Displays changes made in a particular commit.
43 .It Blame view
44 Displays the line-by-line history of a file.
45 .It Tree view
46 Displays the tree corresponding to a particular commit.
47 .El
48 .Pp
49 .Nm
50 provides global and command-specific key bindings and options.
51 The global key bindings are:
52 .Bl -tag -width Ds
53 .It Cm Q
54 Quit
55 .Nm .
56 .It Cm q
57 Quit the view which is in focus.
58 .It Cm Tab
59 Switch focus between views.
60 .It Cm f
61 Toggle fullscreen mode for a split-screen view.
62 .Nm
63 will automatically use split-screen views if the size of the terminal
64 window is sufficiently large.
65 .El
66 .Pp
67 Global options must precede the command name, and are as follows:
68 .Bl -tag -width tenletters
69 .It Fl h
70 Display usage information.
71 .El
72 .Pp
73 The commands for
74 .Nm
75 are as follows:
76 .Bl -tag -width blame
77 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
78 Display history of a repository.
79 If a
80 .Ar path
81 is specified, show only commits which modified this path.
82 .Pp
83 This command is also executed if no explicit command is specified.
84 .Pp
85 The key bindings for
86 .Cm tog log
87 are as follows:
88 .Bl -tag -width Ds
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.
97 .It Cm Enter, Space
98 Open a
99 .Cm diff
100 view showing file changes made in the currently selected commit.
101 .It Cm t
102 Open a
103 .Cm tree
104 view showing the tree for the currently selected commit.
105 .It Cm Backspace
106 Show log entries for the parent directory of the currently selected path.
107 .It Cm /
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, log message, and
111 commit ID SHA1 hash.
112 Regular expression syntax is documented in
113 .Xr re_format 7 .
114 .It Cm n
115 Find the next commit which matches the current search pattern.
116 .It Cm N
117 Find the previous commit which matches the current search pattern.
118 .It Cm Ctrl+l
119 Reload the log view with new commits found in the repository.
120 .El
121 .Pp
122 The options for
123 .Cm tog log
124 are as follows:
125 .Bl -tag -width Ds
126 .It Fl c Ar commit
127 Start traversing history at the specified
128 .Ar commit .
129 The expected argument is the name of a branch or a commit ID SHA1 hash.
130 An abbreviated hash argument will be expanded to a full SHA1 hash
131 automatically, provided the abbreviation is unique.
132 If this option is not specified, default to the work tree's current branch
133 if invoked in a work tree, or to the repository's HEAD reference.
134 .It Fl r Ar repository-path
135 Use the repository at the specified path.
136 If not specified, assume the repository is located at or above the current
137 working directory.
138 .El
139 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
140 Display the differences between two objects in the repository.
141 Each
142 .Ar object
143 argument is an object ID SHA1 hash.
144 An abbreviated hash argument will be expanded to a full SHA1 hash
145 automatically, provided the abbreviation is unique.
146 Both objects must be of the same type (blobs, trees, or commits).
147 If the
148 .Ar repository path
149 is omitted, use the current working directory.
150 .Pp
151 The key bindings for
152 .Cm tog diff
153 are as follows:
154 .Bl -tag -width Ds
155 .It Cm Down-arrow, j
156 Scroll down.
157 .It Cm Up-arrow, k
158 Scroll up.
159 .It Cm Page-down, Space, Ctrl+f
160 Scroll down one page.
161 .It Cm Page-up, Ctrl+b
162 Scroll up one page.
163 .It Cm [
164 Reduce the amount of diff context lines.
165 .It Cm ]
166 Increase the amount of diff context lines.
167 .It Cm <, Comma
168 If the diff view was opened via the log view, move to the previous (younger)
169 commit.
170 .It Cm >, Full stop
171 If the diff view was opened via the log view, move to the next (older) commit.
172 .El
173 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
174 Display line-by-line history of a file at the specified path.
175 .Pp
176 The key bindings for
177 .Cm tog blame
178 are as follows:
179 .Bl -tag -width Ds
180 .It Cm Down-arrow, j, Page-down, Space
181 Move the selection cursor down.
182 .It Cm Up-arrow, k, Page-up
183 Move the selection cursor up.
184 .It Cm Enter
185 Open a
186 .Cm diff
187 view for the currently selected line's commit.
188 .It Cm b
189 Reload the
190 .Cm blame
191 view with the version of the file as found in the currently
192 selected line's commit.
193 .It Cm p
194 Reload the
195 .Cm blame
196 view with the version of the file as found in the parent commit of the
197 currently selected line's commit.
198 .It Cm B
199 Reload the
200 .Cm blame
201 view with the previously blamed commit.
202 .It Cm /
203 Prompt for a search pattern and start searching for matching line.
204 The search pattern is an extended regular expression.
205 Regular expression syntax is documented in
206 .Xr re_format 7 .
207 .It Cm n
208 Find the next line which matches the current search pattern.
209 .It Cm N
210 Find the previous line which matches the current search pattern.
211 .El
212 .Pp
213 The options for
214 .Cm tog blame
215 are as follows:
216 .Bl -tag -width Ds
217 .It Fl c Ar commit
218 Start traversing history at the specified
219 .Ar commit .
220 The expected argument is the name of a branch or a commit ID SHA1 hash.
221 An abbreviated hash argument will be expanded to a full SHA1 hash
222 automatically, provided the abbreviation is unique.
223 .It Fl r Ar repository-path
224 Use the repository at the specified path.
225 If not specified, assume the repository is located at or above the current
226 working directory.
227 .El
228 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
229 Display the repository tree.
230 If the
231 .Ar repository path
232 is omitted, assume the repository is located in the current working directory.
233 .Pp
234 The key bindings for
235 .Cm tog tree
236 are as follows:
237 .Bl -tag -width Ds
238 .It Cm Down-arrow, j, Page-down
239 Move the selection cursor down.
240 .It Cm Up-arrow, k, Page-up
241 Move the selection cursor up.
242 .It Cm Enter
243 Enter the currently selected directory, or switch to the
244 .Cm blame
245 view for the currently selected file.
246 .It Cm l
247 Open a
248 .Cm log
249 view for the currently selected tree entry.
250 .It Cm Backspace
251 Move back to the parent directory.
252 .It Cm i
253 Show object IDs for all objects displayed in the
254 .Cm tree
255 view.
256 .It Cm /
257 Prompt for a search pattern and start searching for matching tree entries.
258 The search pattern is an extended regular expression which is matched
259 against the tree entry's name.
260 Regular expression syntax is documented in
261 .Xr re_format 7 .
262 .It Cm n
263 Find the next tree entry which matches the current search pattern.
264 .It Cm N
265 Find the previous tree entry which matches the current search pattern.
266 .El
267 .Pp
268 The options for
269 .Cm tog tree
270 are as follows:
271 .Bl -tag -width Ds
272 .It Fl c Ar commit
273 Start traversing history at the specified
274 .Ar commit .
275 The expected argument is the name of a branch or a commit ID SHA1 hash.
276 An abbreviated hash argument will be expanded to a full SHA1 hash
277 automatically, provided the abbreviation is unique.
278 .El
279 .El
280 .Sh EXIT STATUS
281 .Ex -std tog
282 .Sh SEE ALSO
283 .Xr got 1 ,
284 .Xr git-repository 5 ,
285 .Xr re_format 7
286 .Sh AUTHORS
287 .An Stefan Sperling Aq Mt stsp@openbsd.org
288 .An joshua stein Aq Mt jcs@openbsd.org