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