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 .Op Ar command
25 .Op Fl h
26 .Op Ar arg ...
27 .Pp
28 .Nm
29 .Ar path
30 .El
31 .Sh DESCRIPTION
32 .Nm
33 is an interactive read-only browser for Git repositories.
34 This repository format is described in
35 .Xr git-repository 5 .
36 .Pp
37 .Nm
38 supports several types of views which display repository data:
39 .Bl -tag -width Ds
40 .It Log view
41 Displays commits in the repository's history.
42 This view is displayed initially if no
43 .Ar command
44 is specified, or if just a
45 .Ar path
46 is specified.
47 .It Diff view
48 Displays changes made in a particular commit.
49 .It Blame view
50 Displays the line-by-line history of a file.
51 .It Tree view
52 Displays the tree corresponding to a particular commit.
53 .El
54 .Pp
55 .Nm
56 provides global and command-specific key bindings and options.
57 The global key bindings are:
58 .Bl -tag -width Ds
59 .It Cm Q
60 Quit
61 .Nm .
62 .It Cm q
63 Quit the view which is in focus.
64 .It Cm Tab
65 Switch focus between views.
66 .It Cm f
67 Toggle fullscreen mode for a split-screen view.
68 .Nm
69 will automatically use split-screen views if the size of the terminal
70 window is sufficiently large.
71 .El
72 .Pp
73 Global options must precede the command name, and are as follows:
74 .Bl -tag -width tenletters
75 .It Fl h
76 Display usage information.
77 .It Fl V, -version
78 Display program version and exit immediately.
79 .El
80 .Pp
81 The commands for
82 .Nm
83 are as follows:
84 .Bl -tag -width blame
85 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
86 Display history of a repository.
87 If a
88 .Ar path
89 is specified, show only commits which modified this path.
90 If invoked in a work tree, the
91 .Ar path
92 is interpreted relative to the current working directory,
93 and the work tree's path prefix is implicitly prepended.
94 Otherwise, the path is interpreted relative to the repository root.
95 .Pp
96 This command is also executed if no explicit command is specified.
97 .Pp
98 The key bindings for
99 .Cm tog log
100 are as follows:
101 .Bl -tag -width Ds
102 .It Cm Down-arrow, j, >, Full stop
103 Move the selection cursor down.
104 .It Cm Up-arrow, k, <, Comma
105 Move the selection cursor up.
106 .It Cm Page-down, Ctrl+f
107 Move the selection cursor down one page.
108 .It Cm Page-up, Ctrl+b
109 Move the selection cursor up one page.
110 .It Cm Enter, Space
111 Open a
112 .Cm diff
113 view showing file changes made in the currently selected commit.
114 .It Cm t
115 Open a
116 .Cm tree
117 view showing the tree for the currently selected commit.
118 .It Cm Backspace
119 Show log entries for the parent directory of the currently selected path,
120 unless an active search is in progress in which case
121 .Cm Backspace
122 aborts the search.
123 .It Cm /
124 Prompt for a search pattern and start searching for matching commits.
125 The search pattern is an extended regular expression which is matched
126 against a commit's author name, committer name, log message, and
127 commit ID SHA1 hash.
128 Regular expression syntax is documented in
129 .Xr re_format 7 .
130 .It Cm n
131 Find the next commit which matches the current search pattern.
132 Searching continues until either a match is found or the
133 .Cm Backspace
134 key is pressed.
135 .It Cm N
136 Find the previous commit which matches the current search pattern.
137 Searching continues until either a match is found or the
138 .Cm Backspace
139 key is pressed.
140 .It Cm Ctrl+l
141 Reload the log view with new commits found in the repository.
142 .It Cm B
143 Reload the log view and toggle display of merged commits.
144 The
145 .Fl b
146 option determines whether merged commits are displayed initially.
147 .El
148 .Pp
149 The options for
150 .Cm tog log
151 are as follows:
152 .Bl -tag -width Ds
153 .It Fl b
154 Display individual commits which were merged into the current branch
155 from other branches.
156 By default,
157 .Cm tog log
158 shows the linear history of the current branch only.
159 The
160 .Cm B
161 key binding can be used to toggle display of merged commits at run-time.
162 .It Fl c Ar commit
163 Start traversing history at the specified
164 .Ar commit .
165 The expected argument is the name of a branch or a commit ID SHA1 hash.
166 An abbreviated hash argument will be expanded to a full SHA1 hash
167 automatically, provided the abbreviation is unique.
168 If this option is not specified, default to the work tree's current branch
169 if invoked in a work tree, or to the repository's HEAD reference.
170 .It Fl r Ar repository-path
171 Use the repository at the specified path.
172 If not specified, assume the repository is located at or above the current
173 working directory.
174 If this directory is a
175 .Xr got 1
176 work tree, use the repository path associated with this work tree.
177 .El
178 .It Cm diff Oo Fl r Ar repository-path Oc Ar object1 object2
179 Display the differences between two objects in the repository.
180 Each
181 .Ar object
182 argument is an object ID SHA1 hash.
183 An abbreviated hash argument will be expanded to a full SHA1 hash
184 automatically, provided the abbreviation is unique.
185 Both objects must be of the same type (blobs, trees, or commits).
186 .Pp
187 The key bindings for
188 .Cm tog diff
189 are as follows:
190 .Bl -tag -width Ds
191 .It Cm Down-arrow, j
192 Scroll down.
193 .It Cm Up-arrow, k
194 Scroll up.
195 .It Cm Page-down, Space, Ctrl+f
196 Scroll down one page.
197 .It Cm Page-up, Ctrl+b
198 Scroll up one page.
199 .It Cm \&[
200 Reduce the amount of diff context lines.
201 .It Cm \&]
202 Increase the amount of diff context lines.
203 .It Cm <, Comma
204 If the diff view was opened via the log view, move to the previous (younger)
205 commit.
206 .It Cm >, Full stop
207 If the diff view was opened via the log view, move to the next (older) commit.
208 .It Cm /
209 Prompt for a search pattern and start searching for matching line.
210 The search pattern is an extended regular expression.
211 Regular expression syntax is documented in
212 .Xr re_format 7 .
213 .It Cm n
214 Find the next line which matches the current search pattern.
215 .It Cm N
216 Find the previous line which matches the current search pattern.
217 .El
218 .Pp
219 The options for
220 .Cm tog diff
221 are as follows:
222 .Bl -tag -width Ds
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 If this directory is a
228 .Xr got 1
229 work tree, use the repository path associated with this work tree.
230 .El
231 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
232 Display line-by-line history of a file at the specified path.
233 .Pp
234 The key bindings for
235 .Cm tog blame
236 are as follows:
237 .Bl -tag -width Ds
238 .It Cm Down-arrow, j
239 Move the selection cursor down.
240 .It Cm Up-arrow, k
241 Move the selection cursor up.
242 .It Cm Page-down, Space, Ctrl+f
243 Move the selection cursor down one page.
244 .It Cm Page-up, Ctrl+b
245 Move the selection cursor up one page.
246 .It Cm Enter
247 Open a
248 .Cm diff
249 view for the currently selected line's commit.
250 .It Cm b
251 Reload the
252 .Cm blame
253 view with the version of the file as found in the currently
254 selected line's commit.
255 .It Cm p
256 Reload the
257 .Cm blame
258 view with the version of the file as found in the parent commit of the
259 currently selected line's commit.
260 .It Cm B
261 Reload the
262 .Cm blame
263 view with the previously blamed commit.
264 .It Cm /
265 Prompt for a search pattern and start searching for matching line.
266 The search pattern is an extended regular expression.
267 Regular expression syntax is documented in
268 .Xr re_format 7 .
269 .It Cm n
270 Find the next line which matches the current search pattern.
271 .It Cm N
272 Find the previous line which matches the current search pattern.
273 .El
274 .Pp
275 The options for
276 .Cm tog blame
277 are as follows:
278 .Bl -tag -width Ds
279 .It Fl c Ar commit
280 Start traversing history at the specified
281 .Ar commit .
282 The expected argument is the name of a branch or a commit ID SHA1 hash.
283 An abbreviated hash argument will be expanded to a full SHA1 hash
284 automatically, provided the abbreviation is unique.
285 .It Fl r Ar repository-path
286 Use the repository at the specified path.
287 If not specified, assume the repository is located at or above the current
288 working directory.
289 If this directory is a
290 .Xr got 1
291 work tree, use the repository path associated with this work tree.
292 .El
293 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
294 Display the repository tree.
295 If a
296 .Ar path
297 is specified, show tree entries at this path.
298 .Pp
299 Displayed tree entries may carry one of the following trailing annotations:
300 .Bl -column YXZ description
301 .It @ Ta entry is a symbolic link
302 .It / Ta entry is a directory
303 .It * Ta entry is an executable file
304 .It $ Ta entry is a Git submodule
305 .El
306 .Pp
307 The key bindings for
308 .Cm tog tree
309 are as follows:
310 .Bl -tag -width Ds
311 .It Cm Down-arrow, j
312 Move the selection cursor down.
313 .It Cm Up-arrow, k
314 Move the selection cursor up.
315 .It Cm Page-down, Ctrl+f
316 Move the selection cursor down one page.
317 .It Cm Page-up, Ctrl+b
318 Move the selection cursor up one page.
319 .It Cm Enter
320 Enter the currently selected directory, or switch to the
321 .Cm blame
322 view for the currently selected file.
323 .It Cm l
324 Open a
325 .Cm log
326 view for the currently selected tree entry.
327 .It Cm Backspace
328 Move back to the parent directory.
329 .It Cm i
330 Show object IDs for all objects displayed in the
331 .Cm tree
332 view.
333 .It Cm /
334 Prompt for a search pattern and start searching for matching tree entries.
335 The search pattern is an extended regular expression which is matched
336 against the tree entry's name.
337 Regular expression syntax is documented in
338 .Xr re_format 7 .
339 .It Cm n
340 Find the next tree entry which matches the current search pattern.
341 .It Cm N
342 Find the previous tree entry which matches the current search pattern.
343 .El
344 .Pp
345 The options for
346 .Cm tog tree
347 are as follows:
348 .Bl -tag -width Ds
349 .It Fl c Ar commit
350 Start traversing history at the specified
351 .Ar commit .
352 The expected argument is the name of a branch or a commit ID SHA1 hash.
353 An abbreviated hash argument will be expanded to a full SHA1 hash
354 automatically, provided the abbreviation is unique.
355 .It Fl r Ar repository-path
356 Use the repository at the specified path.
357 If not specified, assume the repository is located at or above the current
358 working directory.
359 If this directory is a
360 .Xr got 1
361 work tree, use the repository path associated with this work tree.
362 .El
363 .El
364 .Sh ENVIRONMENT
365 .Bl -tag -width TOG_COLORS
366 .It Ev TOG_COLORS
367 .Nm
368 shows colorized output if this variable is set to a non-empty value.
369 The default color scheme can be modified by setting the environment
370 variables documented below.
371 The colors available in color schemes are
372 .Dq black ,
373 .Dq red ,
374 .Dq green ,
375 .Dq yellow ,
376 .Dq blue ,
377 .Dq megenta ,
378 .Dq cyan ,
379 and
380 .Dq default
381 which maps to the terminal's default foreground color.
382 .It Ev TOG_COLOR_DIFF_MINUS
383 The color used to mark up removed lines in diffs.
384 If not set, the default value
385 .Dq magenta
386 is used.
387 .It Ev TOG_COLOR_DIFF_PLUS
388 The color used to mark up added lines in diffs.
389 If not set, the default value
390 .Dq cyan
391 is used.
392 .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
393 The color used to mark up chunk header lines in diffs.
394 If not set, the default value
395 .Dq yellow
396 is used.
397 .It Ev TOG_COLOR_DIFF_META
398 The color used to mark up meta data in diffs.
399 If not set, the default value
400 .Dq green
401 is used.
402 .It Ev TOG_COLOR_TREE_SUBMODULE
403 The color used to mark up sobmodules tree entries.
404 If not set, the default value
405 .Dq magenta
406 is used.
407 .It Ev TOG_COLOR_TREE_SYMLINK
408 The color used to mark up symbolic link tree entries.
409 If not set, the default value
410 .Dq magenta
411 is used.
412 .It Ev TOG_COLOR_TREE_DIRECTORY
413 The color used to mark up directory tree entries.
414 If not set, the default value
415 .Dq cyan
416 is used.
417 .It Ev TOG_COLOR_TREE_EXECUTABLE
418 The color used to mark up executable file tree entries.
419 If not set, the default value
420 .Dq green
421 is used.
422 .It Ev TOG_COLOR_COMMIT
423 The color used to mark up commit IDs.
424 If not set, the default value
425 .Dq green
426 is used.
427 .It Ev TOG_COLOR_AUTHOR
428 The color used to mark up author information.
429 If not set, the default value
430 .Dq cyan
431 is used.
432 .It Ev TOG_COLOR_DATE
433 The color used to mark up date information.
434 If not set, the default value
435 .Dq yellow
436 is used.
437 .El
438 .Sh EXIT STATUS
439 .Ex -std tog
440 .Sh SEE ALSO
441 .Xr got 1 ,
442 .Xr git-repository 5 ,
443 .Xr re_format 7
444 .Sh AUTHORS
445 .An Stefan Sperling Aq Mt stsp@openbsd.org
446 .An Joshua Stein Aq Mt jcs@openbsd.org