Blame


1 030916b5 2018-07-12 stsp .\"
2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
3 030916b5 2018-07-12 stsp .\"
4 030916b5 2018-07-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 030916b5 2018-07-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 030916b5 2018-07-12 stsp .\" copyright notice and this permission notice appear in all copies.
7 030916b5 2018-07-12 stsp .\"
8 030916b5 2018-07-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 030916b5 2018-07-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 030916b5 2018-07-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 030916b5 2018-07-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 030916b5 2018-07-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 030916b5 2018-07-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 030916b5 2018-07-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 030916b5 2018-07-12 stsp .\"
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
17 030916b5 2018-07-12 stsp .Dt TOG 1
18 030916b5 2018-07-12 stsp .Os
19 030916b5 2018-07-12 stsp .Sh NAME
20 030916b5 2018-07-12 stsp .Nm tog
21 aee2a8bd 2019-08-05 stsp .Nd Git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
23 030916b5 2018-07-12 stsp .Nm
24 ee85c5e8 2020-02-29 stsp .Op Ar command
25 030916b5 2018-07-12 stsp .Op Fl h
26 030916b5 2018-07-12 stsp .Op Ar arg ...
27 ee85c5e8 2020-02-29 stsp .Pp
28 ee85c5e8 2020-02-29 stsp .Nm
29 ee85c5e8 2020-02-29 stsp .Ar path
30 030916b5 2018-07-12 stsp .Sh DESCRIPTION
31 030916b5 2018-07-12 stsp .Nm
32 aee2a8bd 2019-08-05 stsp is an interactive read-only browser for Git repositories.
33 030916b5 2018-07-12 stsp This repository format is described in
34 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
35 030916b5 2018-07-12 stsp .Pp
36 030916b5 2018-07-12 stsp .Nm
37 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
38 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
39 9419758a 2019-03-27 stsp .It Log view
40 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
41 87aa0e98 2018-08-18 stsp This view is displayed initially if no
42 87aa0e98 2018-08-18 stsp .Ar command
43 ee85c5e8 2020-02-29 stsp is specified, or if just a
44 ee85c5e8 2020-02-29 stsp .Ar path
45 87aa0e98 2018-08-18 stsp is specified.
46 9419758a 2019-03-27 stsp .It Diff view
47 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
48 9419758a 2019-03-27 stsp .It Blame view
49 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
50 9419758a 2019-03-27 stsp .It Tree view
51 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
52 38cb327b 2020-11-24 stsp .It Ref view
53 38cb327b 2020-11-24 stsp Displays references in the repository.
54 87aa0e98 2018-08-18 stsp .El
55 87aa0e98 2018-08-18 stsp .Pp
56 87aa0e98 2018-08-18 stsp .Nm
57 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
58 87aa0e98 2018-08-18 stsp The global key bindings are:
59 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
60 87aa0e98 2018-08-18 stsp .It Cm Q
61 87aa0e98 2018-08-18 stsp Quit
62 87aa0e98 2018-08-18 stsp .Nm .
63 87aa0e98 2018-08-18 stsp .It Cm q
64 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
65 87aa0e98 2018-08-18 stsp .It Cm Tab
66 c0d30c23 2018-10-07 stsp Switch focus between views.
67 0cf4efb1 2018-09-29 stsp .It Cm f
68 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
69 e9b3576f 2019-03-27 stsp .Nm
70 e9b3576f 2019-03-27 stsp will automatically use split-screen views if the size of the terminal
71 e9b3576f 2019-03-27 stsp window is sufficiently large.
72 87aa0e98 2018-08-18 stsp .El
73 87aa0e98 2018-08-18 stsp .Pp
74 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
75 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
76 030916b5 2018-07-12 stsp .It Fl h
77 030916b5 2018-07-12 stsp Display usage information.
78 1795b260 2021-04-02 kn .It Fl V , -version
79 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
80 030916b5 2018-07-12 stsp .El
81 030916b5 2018-07-12 stsp .Pp
82 030916b5 2018-07-12 stsp The commands for
83 030916b5 2018-07-12 stsp .Nm
84 030916b5 2018-07-12 stsp are as follows:
85 030916b5 2018-07-12 stsp .Bl -tag -width blame
86 b672a97a 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
87 030916b5 2018-07-12 stsp Display history of a repository.
88 ecb28ae0 2018-07-16 stsp If a
89 ecb28ae0 2018-07-16 stsp .Ar path
90 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
91 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
92 dc990cbf 2020-02-22 stsp .Ar path
93 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
94 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
95 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
96 030916b5 2018-07-12 stsp .Pp
97 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
98 030916b5 2018-07-12 stsp .Pp
99 030916b5 2018-07-12 stsp The key bindings for
100 030916b5 2018-07-12 stsp .Cm tog log
101 030916b5 2018-07-12 stsp are as follows:
102 030916b5 2018-07-12 stsp .Bl -tag -width Ds
103 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, >, Full stop, Ctrl-n
104 030916b5 2018-07-12 stsp Move the selection cursor down.
105 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, <, Comma, Ctrl-p
106 030916b5 2018-07-12 stsp Move the selection cursor up.
107 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
108 f7443f66 2022-06-16 mark Scroll log message field to the right.
109 f7443f66 2022-06-16 mark Log message moves left on the screen.
110 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
111 f7443f66 2022-06-16 mark Scroll log message field to the left.
112 f7443f66 2022-06-16 mark Log message moves right on the screen.
113 145b6838 2022-06-16 stsp .It Cm $
114 145b6838 2022-06-16 stsp Scroll log message field to the rightmost position.
115 145b6838 2022-06-16 stsp .It Cm 0
116 145b6838 2022-06-16 stsp Scroll log message field to the leftmost position.
117 83cc4199 2022-06-13 stsp .It Cm Page-down, Ctrl+f
118 a60a9dc4 2019-05-13 jcs Move the selection cursor down one page.
119 83cc4199 2022-06-13 stsp .It Cm Page-up, Ctrl+b
120 a60a9dc4 2019-05-13 jcs Move the selection cursor up one page.
121 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
122 83cc4199 2022-06-13 stsp Move the selection cursor down one half page.
123 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
124 83cc4199 2022-06-13 stsp Move the selection cursor up one half page.
125 27890b18 2021-08-30 stsp .It Cm Home, g
126 912a3f79 2021-08-30 j Move the cursor to the newest commit.
127 912a3f79 2021-08-30 j .It Cm End, G
128 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
129 1dd93b2a 2021-08-30 stsp This will traverse all commits on the current branch which may take
130 1dd93b2a 2021-08-30 stsp a long time depending on the number of commits in branch history.
131 e38d4cde 2022-03-21 naddy If needed, this operation can be cancelled with
132 9ebbe6e1 2021-08-30 stsp .Cm Backspace .
133 e350feed 2019-05-12 stsp .It Cm Enter, Space
134 c0d30c23 2018-10-07 stsp Open a
135 030916b5 2018-07-12 stsp .Cm diff
136 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
137 030916b5 2018-07-12 stsp .It Cm t
138 a60a9dc4 2019-05-13 jcs Open a
139 030916b5 2018-07-12 stsp .Cm tree
140 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
141 5036bf37 2018-09-24 stsp .It Cm Backspace
142 26f0cb24 2021-08-30 j Show log entries for the parent directory of the currently selected path.
143 26f0cb24 2021-08-30 j However when an active search is in progress or when additional commits
144 26f0cb24 2021-08-30 j are loaded,
145 678cbce5 2019-07-28 stsp .Cm Backspace
146 26f0cb24 2021-08-30 j aborts the running operation.
147 60493ae3 2019-06-20 stsp .It Cm /
148 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
149 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
150 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
151 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
152 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
153 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
154 60493ae3 2019-06-20 stsp .It Cm n
155 60493ae3 2019-06-20 stsp Find the next commit which matches the current search pattern.
156 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
157 678cbce5 2019-07-28 stsp .Cm Backspace
158 678cbce5 2019-07-28 stsp key is pressed.
159 b1bf1435 2019-06-21 stsp .It Cm N
160 b1bf1435 2019-06-21 stsp Find the previous commit which matches the current search pattern.
161 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
162 678cbce5 2019-07-28 stsp .Cm Backspace
163 678cbce5 2019-07-28 stsp key is pressed.
164 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
165 01ca22b1 2020-12-07 stsp Reload the
166 01ca22b1 2020-12-07 stsp .Cm log
167 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
168 b672a97a 2020-01-27 stsp .It Cm B
169 01ca22b1 2020-12-07 stsp Reload the
170 01ca22b1 2020-12-07 stsp .Cm log
171 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
172 b672a97a 2020-01-27 stsp The
173 b672a97a 2020-01-27 stsp .Fl b
174 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
175 38cb327b 2020-11-24 stsp .It Cm r
176 38cb327b 2020-11-24 stsp Open a
177 38cb327b 2020-11-24 stsp .Cm ref
178 38cb327b 2020-11-24 stsp view listing all references in the repository.
179 38cb327b 2020-11-24 stsp This can then be used to open a new
180 38cb327b 2020-11-24 stsp .Cm log
181 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
182 030916b5 2018-07-12 stsp .El
183 030916b5 2018-07-12 stsp .Pp
184 030916b5 2018-07-12 stsp The options for
185 030916b5 2018-07-12 stsp .Cm tog log
186 030916b5 2018-07-12 stsp are as follows:
187 030916b5 2018-07-12 stsp .Bl -tag -width Ds
188 b672a97a 2020-01-27 stsp .It Fl b
189 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
190 1137e0ae 2020-01-27 stsp from other branches.
191 b672a97a 2020-01-27 stsp By default,
192 b672a97a 2020-01-27 stsp .Cm tog log
193 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
194 b672a97a 2020-01-27 stsp The
195 b672a97a 2020-01-27 stsp .Cm B
196 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
197 030916b5 2018-07-12 stsp .It Fl c Ar commit
198 030916b5 2018-07-12 stsp Start traversing history at the specified
199 030916b5 2018-07-12 stsp .Ar commit .
200 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
201 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
202 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
203 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
204 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
205 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
206 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
207 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
208 ecb28ae0 2018-07-16 stsp working directory.
209 212b39d1 2020-02-24 naddy If this directory is a
210 212b39d1 2020-02-24 naddy .Xr got 1
211 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
212 030916b5 2018-07-12 stsp .El
213 21920d7e 2020-12-07 stsp .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl w Oc Ar object1 Ar object2
214 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
215 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
216 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
217 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
218 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
219 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
220 030916b5 2018-07-12 stsp .Pp
221 030916b5 2018-07-12 stsp The key bindings for
222 030916b5 2018-07-12 stsp .Cm tog diff
223 030916b5 2018-07-12 stsp are as follows:
224 030916b5 2018-07-12 stsp .Bl -tag -width Ds
225 64453f7e 2020-11-21 stsp .It Cm a
226 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
227 64453f7e 2020-11-21 stsp detected.
228 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
229 030916b5 2018-07-12 stsp Scroll down.
230 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
231 030916b5 2018-07-12 stsp Scroll up.
232 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
233 f7443f66 2022-06-16 mark Scroll view to the right.
234 f7443f66 2022-06-16 mark Diff output moves left on the screen.
235 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
236 f7443f66 2022-06-16 mark Scroll view to the left.
237 f7443f66 2022-06-16 mark Diff output moves right on the screen.
238 145b6838 2022-06-16 stsp .It Cm $
239 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
240 145b6838 2022-06-16 stsp .It Cm 0
241 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
242 83cc4199 2022-06-13 stsp .It Cm Page-down, Space, Ctrl+f
243 a60a9dc4 2019-05-13 jcs Scroll down one page.
244 83cc4199 2022-06-13 stsp .It Cm Page-up, Ctrl+b
245 a60a9dc4 2019-05-13 jcs Scroll up one page.
246 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
247 83cc4199 2022-06-13 stsp Scroll down one half page.
248 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
249 83cc4199 2022-06-13 stsp Scroll up one half page.
250 00f6361c 2021-08-30 naddy .It Cm Home, g
251 912a3f79 2021-08-30 j Scroll to the top of the view.
252 912a3f79 2021-08-30 j .It Cm End, G
253 912a3f79 2021-08-30 j Scroll to the bottom of the view.
254 dfc23429 2019-08-11 stsp .It Cm \&[
255 48ae06ee 2018-10-18 stsp Reduce the amount of diff context lines.
256 dfc23429 2019-08-11 stsp .It Cm \&]
257 48ae06ee 2018-10-18 stsp Increase the amount of diff context lines.
258 15a087fe 2019-02-21 stsp .It Cm <, Comma
259 01ca22b1 2020-12-07 stsp If the
260 01ca22b1 2020-12-07 stsp .Cm diff
261 01ca22b1 2020-12-07 stsp view was opened via the
262 01ca22b1 2020-12-07 stsp .Cm log
263 01ca22b1 2020-12-07 stsp view, move to the previous (younger) commit.
264 15a087fe 2019-02-21 stsp .It Cm >, Full stop
265 01ca22b1 2020-12-07 stsp If the
266 01ca22b1 2020-12-07 stsp .Cm diff
267 01ca22b1 2020-12-07 stsp view was opened via the
268 01ca22b1 2020-12-07 stsp .Cm log
269 01ca22b1 2020-12-07 stsp view, move to the next (older) commit.
270 66dc9065 2020-02-15 stsp .It Cm /
271 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
272 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
273 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
274 66dc9065 2020-02-15 stsp .Xr re_format 7 .
275 66dc9065 2020-02-15 stsp .It Cm n
276 66dc9065 2020-02-15 stsp Find the next line which matches the current search pattern.
277 66dc9065 2020-02-15 stsp .It Cm N
278 66dc9065 2020-02-15 stsp Find the previous line which matches the current search pattern.
279 3dbaef42 2020-11-24 stsp .It Cm w
280 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
281 030916b5 2018-07-12 stsp .El
282 09b5bff8 2020-02-23 naddy .Pp
283 09b5bff8 2020-02-23 naddy The options for
284 09b5bff8 2020-02-23 naddy .Cm tog diff
285 09b5bff8 2020-02-23 naddy are as follows:
286 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
287 64453f7e 2020-11-21 stsp .It Fl a
288 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
289 3dbaef42 2020-11-24 stsp .It Fl C Ar number
290 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
291 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
292 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
293 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
294 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
295 09b5bff8 2020-02-23 naddy working directory.
296 212b39d1 2020-02-24 naddy If this directory is a
297 212b39d1 2020-02-24 naddy .Xr got 1
298 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
299 3dbaef42 2020-11-24 stsp .It Fl w
300 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
301 09b5bff8 2020-02-23 naddy .El
302 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
303 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
304 030916b5 2018-07-12 stsp .Pp
305 030916b5 2018-07-12 stsp The key bindings for
306 030916b5 2018-07-12 stsp .Cm tog blame
307 030916b5 2018-07-12 stsp are as follows:
308 030916b5 2018-07-12 stsp .Bl -tag -width Ds
309 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
310 030916b5 2018-07-12 stsp Move the selection cursor down.
311 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
312 030916b5 2018-07-12 stsp Move the selection cursor up.
313 145b6838 2022-06-16 stsp .It Cm Right-arrow, l
314 f7443f66 2022-06-16 mark Scroll view to the right.
315 f7443f66 2022-06-16 mark File output moves left on the screen.
316 145b6838 2022-06-16 stsp .It Cm Left-arrow, h
317 f7443f66 2022-06-16 mark Scroll view to the left.
318 f7443f66 2022-06-16 mark File output moves right on the screen.
319 145b6838 2022-06-16 stsp .It Cm $
320 145b6838 2022-06-16 stsp Scroll view to the rightmost position.
321 145b6838 2022-06-16 stsp .It Cm 0
322 145b6838 2022-06-16 stsp Scroll view left to the start of the line.
323 83cc4199 2022-06-13 stsp .It Cm Page-down, Space, Ctrl+f
324 ea025d1d 2020-02-22 naddy Move the selection cursor down one page.
325 83cc4199 2022-06-13 stsp .It Cm Page-up, Ctrl+b
326 ea025d1d 2020-02-22 naddy Move the selection cursor up one page.
327 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
328 83cc4199 2022-06-13 stsp Move the selection cursor down one half page.
329 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
330 83cc4199 2022-06-13 stsp Move the selection cursor up one half page.
331 4deef56f 2021-09-02 naddy .It Cm Home, g
332 4deef56f 2021-09-02 naddy Move the selection cursor to the first line of the file.
333 4deef56f 2021-09-02 naddy .It Cm End, G
334 4deef56f 2021-09-02 naddy Move the selection cursor to the last line of the file.
335 030916b5 2018-07-12 stsp .It Cm Enter
336 c0d30c23 2018-10-07 stsp Open a
337 030916b5 2018-07-12 stsp .Cm diff
338 030916b5 2018-07-12 stsp view for the currently selected line's commit.
339 030916b5 2018-07-12 stsp .It Cm b
340 c0d30c23 2018-10-07 stsp Reload the
341 030916b5 2018-07-12 stsp .Cm blame
342 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
343 c0d30c23 2018-10-07 stsp selected line's commit.
344 7a2921f9 2018-07-12 stsp .It Cm p
345 c0d30c23 2018-10-07 stsp Reload the
346 7a2921f9 2018-07-12 stsp .Cm blame
347 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
348 c0d30c23 2018-10-07 stsp currently selected line's commit.
349 030916b5 2018-07-12 stsp .It Cm B
350 c0d30c23 2018-10-07 stsp Reload the
351 030916b5 2018-07-12 stsp .Cm blame
352 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
353 6c4c42e0 2019-06-24 stsp .It Cm /
354 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
355 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
356 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
357 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
358 6c4c42e0 2019-06-24 stsp .It Cm n
359 6c4c42e0 2019-06-24 stsp Find the next line which matches the current search pattern.
360 6c4c42e0 2019-06-24 stsp .It Cm N
361 6c4c42e0 2019-06-24 stsp Find the previous line which matches the current search pattern.
362 030916b5 2018-07-12 stsp .El
363 030916b5 2018-07-12 stsp .Pp
364 030916b5 2018-07-12 stsp The options for
365 030916b5 2018-07-12 stsp .Cm tog blame
366 030916b5 2018-07-12 stsp are as follows:
367 030916b5 2018-07-12 stsp .Bl -tag -width Ds
368 030916b5 2018-07-12 stsp .It Fl c Ar commit
369 030916b5 2018-07-12 stsp Start traversing history at the specified
370 030916b5 2018-07-12 stsp .Ar commit .
371 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
372 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
373 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
374 69069811 2018-08-02 stsp .It Fl r Ar repository-path
375 69069811 2018-08-02 stsp Use the repository at the specified path.
376 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
377 69069811 2018-08-02 stsp working directory.
378 212b39d1 2020-02-24 naddy If this directory is a
379 212b39d1 2020-02-24 naddy .Xr got 1
380 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
381 030916b5 2018-07-12 stsp .El
382 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
383 030916b5 2018-07-12 stsp Display the repository tree.
384 55cccc34 2020-02-20 stsp If a
385 55cccc34 2020-02-20 stsp .Ar path
386 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
387 030916b5 2018-07-12 stsp .Pp
388 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
389 848d6979 2019-08-12 stsp .Bl -column YXZ description
390 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
391 848d6979 2019-08-12 stsp .It / Ta entry is a directory
392 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
393 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
394 848d6979 2019-08-12 stsp .El
395 0d6c6ee3 2020-05-20 stsp .Pp
396 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
397 848d6979 2019-08-12 stsp .Pp
398 030916b5 2018-07-12 stsp The key bindings for
399 030916b5 2018-07-12 stsp .Cm tog tree
400 030916b5 2018-07-12 stsp are as follows:
401 030916b5 2018-07-12 stsp .Bl -tag -width Ds
402 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
403 030916b5 2018-07-12 stsp Move the selection cursor down.
404 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
405 030916b5 2018-07-12 stsp Move the selection cursor up.
406 83cc4199 2022-06-13 stsp .It Cm Page-down, Ctrl+f
407 ea025d1d 2020-02-22 naddy Move the selection cursor down one page.
408 83cc4199 2022-06-13 stsp .It Cm Page-up, Ctrl+b
409 ea025d1d 2020-02-22 naddy Move the selection cursor up one page.
410 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
411 83cc4199 2022-06-13 stsp Move the selection cursor down one half page.
412 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
413 83cc4199 2022-06-13 stsp Move the selection cursor up one half page.
414 e4526bf5 2021-09-03 naddy .It Cm Home, g
415 e4526bf5 2021-09-03 naddy Move the selection cursor to the first entry.
416 e4526bf5 2021-09-03 naddy .It Cm End, G
417 e4526bf5 2021-09-03 naddy Move the selection cursor to the last entry.
418 030916b5 2018-07-12 stsp .It Cm Enter
419 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
420 030916b5 2018-07-12 stsp .Cm blame
421 030916b5 2018-07-12 stsp view for the currently selected file.
422 69efd4c4 2018-07-18 stsp .It Cm l
423 c0d30c23 2018-10-07 stsp Open a
424 69efd4c4 2018-07-18 stsp .Cm log
425 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
426 152c1c93 2020-11-29 stsp .It Cm r
427 152c1c93 2020-11-29 stsp Open a
428 152c1c93 2020-11-29 stsp .Cm ref
429 152c1c93 2020-11-29 stsp view listing all references in the repository.
430 152c1c93 2020-11-29 stsp This can then be used to open a new
431 152c1c93 2020-11-29 stsp .Cm tree
432 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
433 7837eeac 2018-09-24 stsp .It Cm Backspace
434 030916b5 2018-07-12 stsp Move back to the parent directory.
435 030916b5 2018-07-12 stsp .It Cm i
436 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
437 030916b5 2018-07-12 stsp .Cm tree
438 030916b5 2018-07-12 stsp view.
439 4eec20aa 2019-06-22 stsp .It Cm /
440 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
441 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
442 4eec20aa 2019-06-22 stsp against the tree entry's name.
443 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
444 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
445 4eec20aa 2019-06-22 stsp .It Cm n
446 4eec20aa 2019-06-22 stsp Find the next tree entry which matches the current search pattern.
447 4eec20aa 2019-06-22 stsp .It Cm N
448 4eec20aa 2019-06-22 stsp Find the previous tree entry which matches the current search pattern.
449 030916b5 2018-07-12 stsp .El
450 030916b5 2018-07-12 stsp .Pp
451 030916b5 2018-07-12 stsp The options for
452 030916b5 2018-07-12 stsp .Cm tog tree
453 030916b5 2018-07-12 stsp are as follows:
454 030916b5 2018-07-12 stsp .Bl -tag -width Ds
455 030916b5 2018-07-12 stsp .It Fl c Ar commit
456 030916b5 2018-07-12 stsp Start traversing history at the specified
457 030916b5 2018-07-12 stsp .Ar commit .
458 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
459 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
460 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
461 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
462 38cb327b 2020-11-24 stsp Use the repository at the specified path.
463 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
464 38cb327b 2020-11-24 stsp working directory.
465 38cb327b 2020-11-24 stsp If this directory is a
466 38cb327b 2020-11-24 stsp .Xr got 1
467 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
468 38cb327b 2020-11-24 stsp .El
469 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
470 38cb327b 2020-11-24 stsp Display references in the repository.
471 38cb327b 2020-11-24 stsp .Pp
472 38cb327b 2020-11-24 stsp The key bindings for
473 38cb327b 2020-11-24 stsp .Cm tog ref
474 38cb327b 2020-11-24 stsp are as follows:
475 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
476 02ffd0d5 2021-10-17 stsp .It Cm Down-arrow, j, Ctrl-n
477 38cb327b 2020-11-24 stsp Move the selection cursor down.
478 02ffd0d5 2021-10-17 stsp .It Cm Up-arrow, k, Ctrl-p
479 38cb327b 2020-11-24 stsp Move the selection cursor up.
480 83cc4199 2022-06-13 stsp .It Cm Page-down, Ctrl+f
481 38cb327b 2020-11-24 stsp Move the selection cursor down one page.
482 83cc4199 2022-06-13 stsp .It Cm Page-up, Ctrl+b
483 38cb327b 2020-11-24 stsp Move the selection cursor up one page.
484 33c3719a 2022-06-15 stsp .It Cm Ctrl+d, d
485 83cc4199 2022-06-13 stsp Move the selection cursor down one half page.
486 33c3719a 2022-06-15 stsp .It Cm Ctrl+u, u
487 83cc4199 2022-06-13 stsp Move the selection cursor up one half page.
488 e4526bf5 2021-09-03 naddy .It Cm Home, g
489 e4526bf5 2021-09-03 naddy Move the selection cursor to the first reference.
490 e4526bf5 2021-09-03 naddy .It Cm End, G
491 e4526bf5 2021-09-03 naddy Move the selection cursor to the last reference.
492 38cb327b 2020-11-24 stsp .It Cm Enter
493 01ca22b1 2020-12-07 stsp Open a
494 01ca22b1 2020-12-07 stsp .Cm log
495 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
496 38cb327b 2020-11-24 stsp currently selected reference.
497 c42c9805 2020-11-24 stsp .It Cm t
498 c42c9805 2020-11-24 stsp Open a
499 c42c9805 2020-11-24 stsp .Cm tree
500 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
501 38cb327b 2020-11-24 stsp .It Cm i
502 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
503 38cb327b 2020-11-24 stsp .Cm ref
504 38cb327b 2020-11-24 stsp view.
505 b4996bee 2022-06-16 stsp .It Cm m
506 b4996bee 2022-06-16 stsp Show last modified date of each displayed reference.
507 07a065fe 2021-11-20 stsp .It Cm o
508 7f66531d 2021-11-16 stsp Toggle display order of references between sort by name and sort by timestamp.
509 38cb327b 2020-11-24 stsp .It Cm /
510 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
511 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
512 38cb327b 2020-11-24 stsp against absolute reference names.
513 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
514 38cb327b 2020-11-24 stsp .Xr re_format 7 .
515 38cb327b 2020-11-24 stsp .It Cm n
516 38cb327b 2020-11-24 stsp Find the next reference which matches the current search pattern.
517 38cb327b 2020-11-24 stsp .It Cm N
518 38cb327b 2020-11-24 stsp Find the previous reference which matches the current search pattern.
519 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
520 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
521 38cb327b 2020-11-24 stsp .Cm ref
522 38cb327b 2020-11-24 stsp view.
523 38cb327b 2020-11-24 stsp .El
524 38cb327b 2020-11-24 stsp .Pp
525 38cb327b 2020-11-24 stsp The options for
526 38cb327b 2020-11-24 stsp .Cm tog ref
527 38cb327b 2020-11-24 stsp are as follows:
528 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
529 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
530 74283ab8 2020-02-07 stsp Use the repository at the specified path.
531 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
532 74283ab8 2020-02-07 stsp working directory.
533 74283ab8 2020-02-07 stsp If this directory is a
534 74283ab8 2020-02-07 stsp .Xr got 1
535 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
536 030916b5 2018-07-12 stsp .El
537 030916b5 2018-07-12 stsp .El
538 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
539 6d17833f 2019-11-08 stsp .Bl -tag -width TOG_COLORS
540 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
541 6d17833f 2019-11-08 stsp .Nm
542 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
543 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
544 6d17833f 2019-11-08 stsp variables documented below.
545 6d17833f 2019-11-08 stsp The colors available in color schemes are
546 6d17833f 2019-11-08 stsp .Dq black ,
547 6d17833f 2019-11-08 stsp .Dq red ,
548 6d17833f 2019-11-08 stsp .Dq green ,
549 6d17833f 2019-11-08 stsp .Dq yellow ,
550 6d17833f 2019-11-08 stsp .Dq blue ,
551 93a300b2 2021-08-26 stsp .Dq magenta ,
552 1d7fe5cd 2019-11-08 stsp .Dq cyan ,
553 6d17833f 2019-11-08 stsp and
554 1d7fe5cd 2019-11-08 stsp .Dq default
555 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
556 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
557 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
558 6d17833f 2019-11-08 stsp If not set, the default value
559 6d17833f 2019-11-08 stsp .Dq magenta
560 6d17833f 2019-11-08 stsp is used.
561 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
562 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
563 6d17833f 2019-11-08 stsp If not set, the default value
564 6d17833f 2019-11-08 stsp .Dq cyan
565 6d17833f 2019-11-08 stsp is used.
566 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
567 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
568 6d17833f 2019-11-08 stsp If not set, the default value
569 6d17833f 2019-11-08 stsp .Dq yellow
570 6d17833f 2019-11-08 stsp is used.
571 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
572 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
573 c0b01bdb 2019-11-08 stsp If not set, the default value
574 c0b01bdb 2019-11-08 stsp .Dq green
575 c0b01bdb 2019-11-08 stsp is used.
576 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
577 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
578 c0b01bdb 2019-11-08 stsp If not set, the default value
579 c0b01bdb 2019-11-08 stsp .Dq magenta
580 c0b01bdb 2019-11-08 stsp is used.
581 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
582 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
583 c0b01bdb 2019-11-08 stsp If not set, the default value
584 91b8c405 2020-01-25 stsp .Dq magenta
585 c0b01bdb 2019-11-08 stsp is used.
586 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
587 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
588 6d17833f 2019-11-08 stsp If not set, the default value
589 91b8c405 2020-01-25 stsp .Dq cyan
590 c0b01bdb 2019-11-08 stsp is used.
591 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
592 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
593 c0b01bdb 2019-11-08 stsp If not set, the default value
594 6d17833f 2019-11-08 stsp .Dq green
595 6d17833f 2019-11-08 stsp is used.
596 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
597 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
598 11b20872 2019-11-08 stsp If not set, the default value
599 11b20872 2019-11-08 stsp .Dq green
600 11b20872 2019-11-08 stsp is used.
601 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
602 11b20872 2019-11-08 stsp The color used to mark up author information.
603 11b20872 2019-11-08 stsp If not set, the default value
604 11b20872 2019-11-08 stsp .Dq cyan
605 11b20872 2019-11-08 stsp is used.
606 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
607 11b20872 2019-11-08 stsp The color used to mark up date information.
608 11b20872 2019-11-08 stsp If not set, the default value
609 11b20872 2019-11-08 stsp .Dq yellow
610 11b20872 2019-11-08 stsp is used.
611 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
612 38cb327b 2020-11-24 stsp The color used to mark up references in the
613 38cb327b 2020-11-24 stsp .Dq refs/heads/
614 38cb327b 2020-11-24 stsp namespace.
615 38cb327b 2020-11-24 stsp If not set, the default value
616 38cb327b 2020-11-24 stsp .Dq green
617 38cb327b 2020-11-24 stsp is used.
618 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
619 38cb327b 2020-11-24 stsp The color used to mark up references in the
620 38cb327b 2020-11-24 stsp .Dq refs/tags/
621 38cb327b 2020-11-24 stsp namespace.
622 38cb327b 2020-11-24 stsp If not set, the default value
623 38cb327b 2020-11-24 stsp .Dq magenta
624 38cb327b 2020-11-24 stsp is used.
625 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
626 38cb327b 2020-11-24 stsp The color used to mark up references in the
627 38cb327b 2020-11-24 stsp .Dq refs/remotes/
628 38cb327b 2020-11-24 stsp namespace.
629 38cb327b 2020-11-24 stsp If not set, the default value
630 38cb327b 2020-11-24 stsp .Dq yellow
631 38cb327b 2020-11-24 stsp is used.
632 cc488aa7 2022-01-23 stsp .It Ev TOG_COLOR_REFS_BACKUP
633 cc488aa7 2022-01-23 stsp The color used to mark up references in the
634 cc488aa7 2022-01-23 stsp .Dq refs/got/backup/
635 cc488aa7 2022-01-23 stsp namespace.
636 cc488aa7 2022-01-23 stsp If not set, the default value
637 cc488aa7 2022-01-23 stsp .Dq cyan
638 cc488aa7 2022-01-23 stsp is used.
639 6d17833f 2019-11-08 stsp .El
640 030916b5 2018-07-12 stsp .Sh EXIT STATUS
641 030916b5 2018-07-12 stsp .Ex -std tog
642 030916b5 2018-07-12 stsp .Sh SEE ALSO
643 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
644 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
645 56b9a4ca 2019-06-21 stsp .Xr re_format 7
646 030916b5 2018-07-12 stsp .Sh AUTHORS
647 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
648 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org