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