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