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