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