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