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