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 eb029fd6 2019-05-13 stsp .It Cm Down-arrow, j, >, Full stop
104 030916b5 2018-07-12 stsp Move the selection cursor down.
105 eb029fd6 2019-05-13 stsp .It Cm Up-arrow, k, <, Comma
106 030916b5 2018-07-12 stsp Move the selection cursor up.
107 9be75582 2019-06-26 stsp .It Cm Page-down, Ctrl+f
108 a60a9dc4 2019-05-13 jcs Move the selection cursor down one page.
109 9be75582 2019-06-26 stsp .It Cm Page-up, Ctrl+b
110 a60a9dc4 2019-05-13 jcs Move the selection cursor up one page.
111 27890b18 2021-08-30 stsp .It Cm Home, g
112 912a3f79 2021-08-30 j Move the cursor to the newest commit.
113 912a3f79 2021-08-30 j .It Cm End, G
114 912a3f79 2021-08-30 j Move the cursor to the oldest commit.
115 912a3f79 2021-08-30 j This will iterate over all commit objects in the repository and may take
116 912a3f79 2021-08-30 j a long time depending on the size of the repository.
117 e350feed 2019-05-12 stsp .It Cm Enter, Space
118 c0d30c23 2018-10-07 stsp Open a
119 030916b5 2018-07-12 stsp .Cm diff
120 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
121 030916b5 2018-07-12 stsp .It Cm t
122 a60a9dc4 2019-05-13 jcs Open a
123 030916b5 2018-07-12 stsp .Cm tree
124 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
125 5036bf37 2018-09-24 stsp .It Cm Backspace
126 678cbce5 2019-07-28 stsp Show log entries for the parent directory of the currently selected path,
127 678cbce5 2019-07-28 stsp unless an active search is in progress in which case
128 678cbce5 2019-07-28 stsp .Cm Backspace
129 678cbce5 2019-07-28 stsp aborts the search.
130 60493ae3 2019-06-20 stsp .It Cm /
131 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
132 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
133 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
134 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
135 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
136 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
137 60493ae3 2019-06-20 stsp .It Cm n
138 60493ae3 2019-06-20 stsp Find the next commit which matches the current search pattern.
139 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
140 678cbce5 2019-07-28 stsp .Cm Backspace
141 678cbce5 2019-07-28 stsp key is pressed.
142 b1bf1435 2019-06-21 stsp .It Cm N
143 b1bf1435 2019-06-21 stsp Find the previous commit which matches the current search pattern.
144 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
145 678cbce5 2019-07-28 stsp .Cm Backspace
146 678cbce5 2019-07-28 stsp key is pressed.
147 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
148 01ca22b1 2020-12-07 stsp Reload the
149 01ca22b1 2020-12-07 stsp .Cm log
150 01ca22b1 2020-12-07 stsp view with new commits found in the repository.
151 b672a97a 2020-01-27 stsp .It Cm B
152 01ca22b1 2020-12-07 stsp Reload the
153 01ca22b1 2020-12-07 stsp .Cm log
154 01ca22b1 2020-12-07 stsp view and toggle display of merged commits.
155 b672a97a 2020-01-27 stsp The
156 b672a97a 2020-01-27 stsp .Fl b
157 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
158 38cb327b 2020-11-24 stsp .It Cm r
159 38cb327b 2020-11-24 stsp Open a
160 38cb327b 2020-11-24 stsp .Cm ref
161 38cb327b 2020-11-24 stsp view listing all references in the repository.
162 38cb327b 2020-11-24 stsp This can then be used to open a new
163 38cb327b 2020-11-24 stsp .Cm log
164 38cb327b 2020-11-24 stsp view for arbitrary branches and tags.
165 030916b5 2018-07-12 stsp .El
166 030916b5 2018-07-12 stsp .Pp
167 030916b5 2018-07-12 stsp The options for
168 030916b5 2018-07-12 stsp .Cm tog log
169 030916b5 2018-07-12 stsp are as follows:
170 030916b5 2018-07-12 stsp .Bl -tag -width Ds
171 b672a97a 2020-01-27 stsp .It Fl b
172 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
173 1137e0ae 2020-01-27 stsp from other branches.
174 b672a97a 2020-01-27 stsp By default,
175 b672a97a 2020-01-27 stsp .Cm tog log
176 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
177 b672a97a 2020-01-27 stsp The
178 b672a97a 2020-01-27 stsp .Cm B
179 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
180 030916b5 2018-07-12 stsp .It Fl c Ar commit
181 030916b5 2018-07-12 stsp Start traversing history at the specified
182 030916b5 2018-07-12 stsp .Ar commit .
183 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
184 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
185 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
186 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
187 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
188 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
189 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
190 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
191 ecb28ae0 2018-07-16 stsp working directory.
192 212b39d1 2020-02-24 naddy If this directory is a
193 212b39d1 2020-02-24 naddy .Xr got 1
194 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
195 030916b5 2018-07-12 stsp .El
196 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
197 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
198 3dbaef42 2020-11-24 stsp Treat each of the two arguments as a reference, a tag name, or an object
199 3dbaef42 2020-11-24 stsp ID SHA1 hash, and display differences between the corresponding objects.
200 3dbaef42 2020-11-24 stsp Both objects must be of the same type (blobs, trees, or commits).
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 030916b5 2018-07-12 stsp .Pp
204 030916b5 2018-07-12 stsp The key bindings for
205 030916b5 2018-07-12 stsp .Cm tog diff
206 030916b5 2018-07-12 stsp are as follows:
207 030916b5 2018-07-12 stsp .Bl -tag -width Ds
208 64453f7e 2020-11-21 stsp .It Cm a
209 64453f7e 2020-11-21 stsp Toggle treatment of file contents as ASCII text even if binary data was
210 64453f7e 2020-11-21 stsp detected.
211 a60a9dc4 2019-05-13 jcs .It Cm Down-arrow, j
212 030916b5 2018-07-12 stsp Scroll down.
213 eb029fd6 2019-05-13 stsp .It Cm Up-arrow, k
214 030916b5 2018-07-12 stsp Scroll up.
215 a60a9dc4 2019-05-13 jcs .It Cm Page-down, Space, Ctrl+f
216 a60a9dc4 2019-05-13 jcs Scroll down one page.
217 a60a9dc4 2019-05-13 jcs .It Cm Page-up, Ctrl+b
218 a60a9dc4 2019-05-13 jcs Scroll up one page.
219 912a3f79 2021-08-30 j .It Cm Home, g, Ctrl-u
220 912a3f79 2021-08-30 j Scroll to the top of the view.
221 912a3f79 2021-08-30 j .It Cm End, G
222 912a3f79 2021-08-30 j Scroll to the bottom of the view.
223 dfc23429 2019-08-11 stsp .It Cm \&[
224 48ae06ee 2018-10-18 stsp Reduce the amount of diff context lines.
225 dfc23429 2019-08-11 stsp .It Cm \&]
226 48ae06ee 2018-10-18 stsp Increase the amount of diff context lines.
227 15a087fe 2019-02-21 stsp .It Cm <, Comma
228 01ca22b1 2020-12-07 stsp If the
229 01ca22b1 2020-12-07 stsp .Cm diff
230 01ca22b1 2020-12-07 stsp view was opened via the
231 01ca22b1 2020-12-07 stsp .Cm log
232 01ca22b1 2020-12-07 stsp view, move to the previous (younger) commit.
233 15a087fe 2019-02-21 stsp .It Cm >, Full stop
234 01ca22b1 2020-12-07 stsp If the
235 01ca22b1 2020-12-07 stsp .Cm diff
236 01ca22b1 2020-12-07 stsp view was opened via the
237 01ca22b1 2020-12-07 stsp .Cm log
238 01ca22b1 2020-12-07 stsp view, move to the next (older) commit.
239 66dc9065 2020-02-15 stsp .It Cm /
240 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
241 66dc9065 2020-02-15 stsp The search pattern is an extended regular expression.
242 66dc9065 2020-02-15 stsp Regular expression syntax is documented in
243 66dc9065 2020-02-15 stsp .Xr re_format 7 .
244 66dc9065 2020-02-15 stsp .It Cm n
245 66dc9065 2020-02-15 stsp Find the next line which matches the current search pattern.
246 66dc9065 2020-02-15 stsp .It Cm N
247 66dc9065 2020-02-15 stsp Find the previous line which matches the current search pattern.
248 3dbaef42 2020-11-24 stsp .It Cm w
249 3dbaef42 2020-11-24 stsp Toggle display of whitespace-only changes.
250 030916b5 2018-07-12 stsp .El
251 09b5bff8 2020-02-23 naddy .Pp
252 09b5bff8 2020-02-23 naddy The options for
253 09b5bff8 2020-02-23 naddy .Cm tog diff
254 09b5bff8 2020-02-23 naddy are as follows:
255 09b5bff8 2020-02-23 naddy .Bl -tag -width Ds
256 64453f7e 2020-11-21 stsp .It Fl a
257 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
258 3dbaef42 2020-11-24 stsp .It Fl C Ar number
259 3dbaef42 2020-11-24 stsp Set the number of context lines shown in the diff.
260 3dbaef42 2020-11-24 stsp By default, 3 lines of context are shown.
261 09b5bff8 2020-02-23 naddy .It Fl r Ar repository-path
262 09b5bff8 2020-02-23 naddy Use the repository at the specified path.
263 09b5bff8 2020-02-23 naddy If not specified, assume the repository is located at or above the current
264 09b5bff8 2020-02-23 naddy working directory.
265 212b39d1 2020-02-24 naddy If this directory is a
266 212b39d1 2020-02-24 naddy .Xr got 1
267 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
268 3dbaef42 2020-11-24 stsp .It Fl w
269 3dbaef42 2020-11-24 stsp Ignore whitespace-only changes.
270 09b5bff8 2020-02-23 naddy .El
271 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
272 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
273 030916b5 2018-07-12 stsp .Pp
274 030916b5 2018-07-12 stsp The key bindings for
275 030916b5 2018-07-12 stsp .Cm tog blame
276 030916b5 2018-07-12 stsp are as follows:
277 030916b5 2018-07-12 stsp .Bl -tag -width Ds
278 ea025d1d 2020-02-22 naddy .It Cm Down-arrow, j
279 030916b5 2018-07-12 stsp Move the selection cursor down.
280 ea025d1d 2020-02-22 naddy .It Cm Up-arrow, k
281 030916b5 2018-07-12 stsp Move the selection cursor up.
282 ea025d1d 2020-02-22 naddy .It Cm Page-down, Space, Ctrl+f
283 ea025d1d 2020-02-22 naddy Move the selection cursor down one page.
284 ea025d1d 2020-02-22 naddy .It Cm Page-up, Ctrl+b
285 ea025d1d 2020-02-22 naddy Move the selection cursor up one page.
286 030916b5 2018-07-12 stsp .It Cm Enter
287 c0d30c23 2018-10-07 stsp Open a
288 030916b5 2018-07-12 stsp .Cm diff
289 030916b5 2018-07-12 stsp view for the currently selected line's commit.
290 030916b5 2018-07-12 stsp .It Cm b
291 c0d30c23 2018-10-07 stsp Reload the
292 030916b5 2018-07-12 stsp .Cm blame
293 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
294 c0d30c23 2018-10-07 stsp selected line's commit.
295 7a2921f9 2018-07-12 stsp .It Cm p
296 c0d30c23 2018-10-07 stsp Reload the
297 7a2921f9 2018-07-12 stsp .Cm blame
298 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
299 c0d30c23 2018-10-07 stsp currently selected line's commit.
300 030916b5 2018-07-12 stsp .It Cm B
301 c0d30c23 2018-10-07 stsp Reload the
302 030916b5 2018-07-12 stsp .Cm blame
303 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
304 6c4c42e0 2019-06-24 stsp .It Cm /
305 0e404f95 2020-11-14 stsp Prompt for a search pattern and start searching for matching lines.
306 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
307 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
308 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
309 6c4c42e0 2019-06-24 stsp .It Cm n
310 6c4c42e0 2019-06-24 stsp Find the next line which matches the current search pattern.
311 6c4c42e0 2019-06-24 stsp .It Cm N
312 6c4c42e0 2019-06-24 stsp Find the previous line which matches the current search pattern.
313 030916b5 2018-07-12 stsp .El
314 030916b5 2018-07-12 stsp .Pp
315 030916b5 2018-07-12 stsp The options for
316 030916b5 2018-07-12 stsp .Cm tog blame
317 030916b5 2018-07-12 stsp are as follows:
318 030916b5 2018-07-12 stsp .Bl -tag -width Ds
319 030916b5 2018-07-12 stsp .It Fl c Ar commit
320 030916b5 2018-07-12 stsp Start traversing history at the specified
321 030916b5 2018-07-12 stsp .Ar commit .
322 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
323 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
324 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
325 69069811 2018-08-02 stsp .It Fl r Ar repository-path
326 69069811 2018-08-02 stsp Use the repository at the specified path.
327 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
328 69069811 2018-08-02 stsp working directory.
329 212b39d1 2020-02-24 naddy If this directory is a
330 212b39d1 2020-02-24 naddy .Xr got 1
331 212b39d1 2020-02-24 naddy work tree, use the repository path associated with this work tree.
332 030916b5 2018-07-12 stsp .El
333 55cccc34 2020-02-20 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Op Ar path
334 030916b5 2018-07-12 stsp Display the repository tree.
335 55cccc34 2020-02-20 stsp If a
336 55cccc34 2020-02-20 stsp .Ar path
337 55cccc34 2020-02-20 stsp is specified, show tree entries at this path.
338 030916b5 2018-07-12 stsp .Pp
339 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
340 848d6979 2019-08-12 stsp .Bl -column YXZ description
341 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
342 848d6979 2019-08-12 stsp .It / Ta entry is a directory
343 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
344 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
345 848d6979 2019-08-12 stsp .El
346 0d6c6ee3 2020-05-20 stsp .Pp
347 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
348 848d6979 2019-08-12 stsp .Pp
349 030916b5 2018-07-12 stsp The key bindings for
350 030916b5 2018-07-12 stsp .Cm tog tree
351 030916b5 2018-07-12 stsp are as follows:
352 030916b5 2018-07-12 stsp .Bl -tag -width Ds
353 ea025d1d 2020-02-22 naddy .It Cm Down-arrow, j
354 030916b5 2018-07-12 stsp Move the selection cursor down.
355 ea025d1d 2020-02-22 naddy .It Cm Up-arrow, k
356 030916b5 2018-07-12 stsp Move the selection cursor up.
357 ea025d1d 2020-02-22 naddy .It Cm Page-down, Ctrl+f
358 ea025d1d 2020-02-22 naddy Move the selection cursor down one page.
359 ea025d1d 2020-02-22 naddy .It Cm Page-up, Ctrl+b
360 ea025d1d 2020-02-22 naddy Move the selection cursor up one page.
361 030916b5 2018-07-12 stsp .It Cm Enter
362 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
363 030916b5 2018-07-12 stsp .Cm blame
364 030916b5 2018-07-12 stsp view for the currently selected file.
365 69efd4c4 2018-07-18 stsp .It Cm l
366 c0d30c23 2018-10-07 stsp Open a
367 69efd4c4 2018-07-18 stsp .Cm log
368 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
369 152c1c93 2020-11-29 stsp .It Cm r
370 152c1c93 2020-11-29 stsp Open a
371 152c1c93 2020-11-29 stsp .Cm ref
372 152c1c93 2020-11-29 stsp view listing all references in the repository.
373 152c1c93 2020-11-29 stsp This can then be used to open a new
374 152c1c93 2020-11-29 stsp .Cm tree
375 152c1c93 2020-11-29 stsp view for arbitrary branches and tags.
376 7837eeac 2018-09-24 stsp .It Cm Backspace
377 030916b5 2018-07-12 stsp Move back to the parent directory.
378 030916b5 2018-07-12 stsp .It Cm i
379 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
380 030916b5 2018-07-12 stsp .Cm tree
381 030916b5 2018-07-12 stsp view.
382 4eec20aa 2019-06-22 stsp .It Cm /
383 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
384 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
385 4eec20aa 2019-06-22 stsp against the tree entry's name.
386 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
387 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
388 4eec20aa 2019-06-22 stsp .It Cm n
389 4eec20aa 2019-06-22 stsp Find the next tree entry which matches the current search pattern.
390 4eec20aa 2019-06-22 stsp .It Cm N
391 4eec20aa 2019-06-22 stsp Find the previous tree entry which matches the current search pattern.
392 030916b5 2018-07-12 stsp .El
393 030916b5 2018-07-12 stsp .Pp
394 030916b5 2018-07-12 stsp The options for
395 030916b5 2018-07-12 stsp .Cm tog tree
396 030916b5 2018-07-12 stsp are as follows:
397 030916b5 2018-07-12 stsp .Bl -tag -width Ds
398 030916b5 2018-07-12 stsp .It Fl c Ar commit
399 030916b5 2018-07-12 stsp Start traversing history at the specified
400 030916b5 2018-07-12 stsp .Ar commit .
401 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
402 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
403 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
404 38cb327b 2020-11-24 stsp .It Fl r Ar repository-path
405 38cb327b 2020-11-24 stsp Use the repository at the specified path.
406 38cb327b 2020-11-24 stsp If not specified, assume the repository is located at or above the current
407 38cb327b 2020-11-24 stsp working directory.
408 38cb327b 2020-11-24 stsp If this directory is a
409 38cb327b 2020-11-24 stsp .Xr got 1
410 38cb327b 2020-11-24 stsp work tree, use the repository path associated with this work tree.
411 38cb327b 2020-11-24 stsp .El
412 38cb327b 2020-11-24 stsp .It Cm ref Oo Fl r Ar repository-path Oc
413 38cb327b 2020-11-24 stsp Display references in the repository.
414 38cb327b 2020-11-24 stsp .Pp
415 38cb327b 2020-11-24 stsp The key bindings for
416 38cb327b 2020-11-24 stsp .Cm tog ref
417 38cb327b 2020-11-24 stsp are as follows:
418 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
419 38cb327b 2020-11-24 stsp .It Cm Down-arrow, j
420 38cb327b 2020-11-24 stsp Move the selection cursor down.
421 38cb327b 2020-11-24 stsp .It Cm Up-arrow, k
422 38cb327b 2020-11-24 stsp Move the selection cursor up.
423 38cb327b 2020-11-24 stsp .It Cm Page-down, Ctrl+f
424 38cb327b 2020-11-24 stsp Move the selection cursor down one page.
425 38cb327b 2020-11-24 stsp .It Cm Page-up, Ctrl+b
426 38cb327b 2020-11-24 stsp Move the selection cursor up one page.
427 38cb327b 2020-11-24 stsp .It Cm Enter
428 01ca22b1 2020-12-07 stsp Open a
429 01ca22b1 2020-12-07 stsp .Cm log
430 01ca22b1 2020-12-07 stsp view which begins traversing history at the commit resolved via the
431 38cb327b 2020-11-24 stsp currently selected reference.
432 c42c9805 2020-11-24 stsp .It Cm t
433 c42c9805 2020-11-24 stsp Open a
434 c42c9805 2020-11-24 stsp .Cm tree
435 c42c9805 2020-11-24 stsp view showing the tree resolved via the currently selected reference.
436 38cb327b 2020-11-24 stsp .It Cm i
437 38cb327b 2020-11-24 stsp Show object IDs for all non-symbolic references displayed in the
438 38cb327b 2020-11-24 stsp .Cm ref
439 38cb327b 2020-11-24 stsp view.
440 38cb327b 2020-11-24 stsp .It Cm /
441 38cb327b 2020-11-24 stsp Prompt for a search pattern and start searching for matching references.
442 38cb327b 2020-11-24 stsp The search pattern is an extended regular expression which is matched
443 38cb327b 2020-11-24 stsp against absolute reference names.
444 38cb327b 2020-11-24 stsp Regular expression syntax is documented in
445 38cb327b 2020-11-24 stsp .Xr re_format 7 .
446 38cb327b 2020-11-24 stsp .It Cm n
447 38cb327b 2020-11-24 stsp Find the next reference which matches the current search pattern.
448 38cb327b 2020-11-24 stsp .It Cm N
449 38cb327b 2020-11-24 stsp Find the previous reference which matches the current search pattern.
450 38cb327b 2020-11-24 stsp .It Cm Ctrl+l
451 38cb327b 2020-11-24 stsp Reload the list of references displayed by the
452 38cb327b 2020-11-24 stsp .Cm ref
453 38cb327b 2020-11-24 stsp view.
454 38cb327b 2020-11-24 stsp .El
455 38cb327b 2020-11-24 stsp .Pp
456 38cb327b 2020-11-24 stsp The options for
457 38cb327b 2020-11-24 stsp .Cm tog ref
458 38cb327b 2020-11-24 stsp are as follows:
459 38cb327b 2020-11-24 stsp .Bl -tag -width Ds
460 74283ab8 2020-02-07 stsp .It Fl r Ar repository-path
461 74283ab8 2020-02-07 stsp Use the repository at the specified path.
462 74283ab8 2020-02-07 stsp If not specified, assume the repository is located at or above the current
463 74283ab8 2020-02-07 stsp working directory.
464 74283ab8 2020-02-07 stsp If this directory is a
465 74283ab8 2020-02-07 stsp .Xr got 1
466 74283ab8 2020-02-07 stsp work tree, use the repository path associated with this work tree.
467 030916b5 2018-07-12 stsp .El
468 030916b5 2018-07-12 stsp .El
469 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
470 6d17833f 2019-11-08 stsp .Bl -tag -width TOG_COLORS
471 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
472 6d17833f 2019-11-08 stsp .Nm
473 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
474 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
475 6d17833f 2019-11-08 stsp variables documented below.
476 6d17833f 2019-11-08 stsp The colors available in color schemes are
477 6d17833f 2019-11-08 stsp .Dq black ,
478 6d17833f 2019-11-08 stsp .Dq red ,
479 6d17833f 2019-11-08 stsp .Dq green ,
480 6d17833f 2019-11-08 stsp .Dq yellow ,
481 6d17833f 2019-11-08 stsp .Dq blue ,
482 93a300b2 2021-08-26 stsp .Dq magenta ,
483 1d7fe5cd 2019-11-08 stsp .Dq cyan ,
484 6d17833f 2019-11-08 stsp and
485 1d7fe5cd 2019-11-08 stsp .Dq default
486 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
487 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
488 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
489 6d17833f 2019-11-08 stsp If not set, the default value
490 6d17833f 2019-11-08 stsp .Dq magenta
491 6d17833f 2019-11-08 stsp is used.
492 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
493 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
494 6d17833f 2019-11-08 stsp If not set, the default value
495 6d17833f 2019-11-08 stsp .Dq cyan
496 6d17833f 2019-11-08 stsp is used.
497 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
498 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
499 6d17833f 2019-11-08 stsp If not set, the default value
500 6d17833f 2019-11-08 stsp .Dq yellow
501 6d17833f 2019-11-08 stsp is used.
502 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
503 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
504 c0b01bdb 2019-11-08 stsp If not set, the default value
505 c0b01bdb 2019-11-08 stsp .Dq green
506 c0b01bdb 2019-11-08 stsp is used.
507 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
508 93a300b2 2021-08-26 stsp The color used to mark up submodule tree entries.
509 c0b01bdb 2019-11-08 stsp If not set, the default value
510 c0b01bdb 2019-11-08 stsp .Dq magenta
511 c0b01bdb 2019-11-08 stsp is used.
512 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
513 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
514 c0b01bdb 2019-11-08 stsp If not set, the default value
515 91b8c405 2020-01-25 stsp .Dq magenta
516 c0b01bdb 2019-11-08 stsp is used.
517 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
518 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
519 6d17833f 2019-11-08 stsp If not set, the default value
520 91b8c405 2020-01-25 stsp .Dq cyan
521 c0b01bdb 2019-11-08 stsp is used.
522 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
523 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
524 c0b01bdb 2019-11-08 stsp If not set, the default value
525 6d17833f 2019-11-08 stsp .Dq green
526 6d17833f 2019-11-08 stsp is used.
527 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
528 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
529 11b20872 2019-11-08 stsp If not set, the default value
530 11b20872 2019-11-08 stsp .Dq green
531 11b20872 2019-11-08 stsp is used.
532 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
533 11b20872 2019-11-08 stsp The color used to mark up author information.
534 11b20872 2019-11-08 stsp If not set, the default value
535 11b20872 2019-11-08 stsp .Dq cyan
536 11b20872 2019-11-08 stsp is used.
537 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
538 11b20872 2019-11-08 stsp The color used to mark up date information.
539 11b20872 2019-11-08 stsp If not set, the default value
540 11b20872 2019-11-08 stsp .Dq yellow
541 11b20872 2019-11-08 stsp is used.
542 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_HEADS
543 38cb327b 2020-11-24 stsp The color used to mark up references in the
544 38cb327b 2020-11-24 stsp .Dq refs/heads/
545 38cb327b 2020-11-24 stsp namespace.
546 38cb327b 2020-11-24 stsp If not set, the default value
547 38cb327b 2020-11-24 stsp .Dq green
548 38cb327b 2020-11-24 stsp is used.
549 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_TAGS
550 38cb327b 2020-11-24 stsp The color used to mark up references in the
551 38cb327b 2020-11-24 stsp .Dq refs/tags/
552 38cb327b 2020-11-24 stsp namespace.
553 38cb327b 2020-11-24 stsp If not set, the default value
554 38cb327b 2020-11-24 stsp .Dq magenta
555 38cb327b 2020-11-24 stsp is used.
556 38cb327b 2020-11-24 stsp .It Ev TOG_COLOR_REFS_REMOTES
557 38cb327b 2020-11-24 stsp The color used to mark up references in the
558 38cb327b 2020-11-24 stsp .Dq refs/remotes/
559 38cb327b 2020-11-24 stsp namespace.
560 38cb327b 2020-11-24 stsp If not set, the default value
561 38cb327b 2020-11-24 stsp .Dq yellow
562 38cb327b 2020-11-24 stsp is used.
563 6d17833f 2019-11-08 stsp .El
564 030916b5 2018-07-12 stsp .Sh EXIT STATUS
565 030916b5 2018-07-12 stsp .Ex -std tog
566 030916b5 2018-07-12 stsp .Sh SEE ALSO
567 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
568 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
569 56b9a4ca 2019-06-21 stsp .Xr re_format 7
570 030916b5 2018-07-12 stsp .Sh AUTHORS
571 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
572 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org