2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
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.
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.
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
21 aee2a8bd 2019-08-05 stsp .Nd Git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
26 030916b5 2018-07-12 stsp .Op Ar arg ...
27 030916b5 2018-07-12 stsp .Sh DESCRIPTION
29 aee2a8bd 2019-08-05 stsp is an interactive read-only browser for Git repositories.
30 030916b5 2018-07-12 stsp This repository format is described in
31 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
34 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
35 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
36 9419758a 2019-03-27 stsp .It Log view
37 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
38 87aa0e98 2018-08-18 stsp This view is displayed initially if no
40 87aa0e98 2018-08-18 stsp is specified.
41 9419758a 2019-03-27 stsp .It Diff view
42 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
43 9419758a 2019-03-27 stsp .It Blame view
44 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
45 9419758a 2019-03-27 stsp .It Tree view
46 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
50 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
51 87aa0e98 2018-08-18 stsp The global key bindings are:
52 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
57 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
59 c0d30c23 2018-10-07 stsp Switch focus between views.
61 c0d30c23 2018-10-07 stsp Toggle fullscreen mode for a split-screen view.
63 e9b3576f 2019-03-27 stsp will automatically use split-screen views if the size of the terminal
64 e9b3576f 2019-03-27 stsp window is sufficiently large.
67 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
68 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
70 030916b5 2018-07-12 stsp Display usage information.
71 83cd27f8 2020-01-13 stsp .It Fl V, -version
72 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
75 030916b5 2018-07-12 stsp The commands for
77 030916b5 2018-07-12 stsp are as follows:
78 030916b5 2018-07-12 stsp .Bl -tag -width blame
79 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
80 030916b5 2018-07-12 stsp Display history of a repository.
83 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
85 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
87 030916b5 2018-07-12 stsp The key bindings for
89 030916b5 2018-07-12 stsp are as follows:
90 030916b5 2018-07-12 stsp .Bl -tag -width Ds
91 eb029fd6 2019-05-13 stsp .It Cm Down-arrow, j, >, Full stop
92 030916b5 2018-07-12 stsp Move the selection cursor down.
93 eb029fd6 2019-05-13 stsp .It Cm Up-arrow, k, <, Comma
94 030916b5 2018-07-12 stsp Move the selection cursor up.
95 9be75582 2019-06-26 stsp .It Cm Page-down, Ctrl+f
96 a60a9dc4 2019-05-13 jcs Move the selection cursor down one page.
97 9be75582 2019-06-26 stsp .It Cm Page-up, Ctrl+b
98 a60a9dc4 2019-05-13 jcs Move the selection cursor up one page.
99 e350feed 2019-05-12 stsp .It Cm Enter, Space
102 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
106 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
107 5036bf37 2018-09-24 stsp .It Cm Backspace
108 678cbce5 2019-07-28 stsp Show log entries for the parent directory of the currently selected path,
109 678cbce5 2019-07-28 stsp unless an active search is in progress in which case
110 678cbce5 2019-07-28 stsp .Cm Backspace
111 678cbce5 2019-07-28 stsp aborts the search.
113 60493ae3 2019-06-20 stsp Prompt for a search pattern and start searching for matching commits.
114 60493ae3 2019-06-20 stsp The search pattern is an extended regular expression which is matched
115 df0b3d8a 2019-06-28 stsp against a commit's author name, committer name, log message, and
116 df0b3d8a 2019-06-28 stsp commit ID SHA1 hash.
117 e6c76b79 2019-06-21 stsp Regular expression syntax is documented in
118 e6c76b79 2019-06-21 stsp .Xr re_format 7 .
120 60493ae3 2019-06-20 stsp Find the next commit which matches the current search pattern.
121 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
122 678cbce5 2019-07-28 stsp .Cm Backspace
123 678cbce5 2019-07-28 stsp key is pressed.
125 b1bf1435 2019-06-21 stsp Find the previous commit which matches the current search pattern.
126 678cbce5 2019-07-28 stsp Searching continues until either a match is found or the
127 678cbce5 2019-07-28 stsp .Cm Backspace
128 678cbce5 2019-07-28 stsp key is pressed.
129 bf0668dd 2019-06-26 stsp .It Cm Ctrl+l
130 d01904d4 2019-06-25 stsp Reload the log view with new commits found in the repository.
132 b672a97a 2020-01-27 stsp Reload the log view and toggle display of merged commits.
135 b672a97a 2020-01-27 stsp option determines whether merged commits are displayed initially.
138 030916b5 2018-07-12 stsp The options for
139 030916b5 2018-07-12 stsp .Cm tog log
140 030916b5 2018-07-12 stsp are as follows:
141 030916b5 2018-07-12 stsp .Bl -tag -width Ds
143 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
144 1137e0ae 2020-01-27 stsp from other branches.
145 b672a97a 2020-01-27 stsp By default,
146 b672a97a 2020-01-27 stsp .Cm tog log
147 b672a97a 2020-01-27 stsp shows the linear history of the current branch only.
150 b672a97a 2020-01-27 stsp key binding can be used to toggle display of merged commits at run-time.
151 030916b5 2018-07-12 stsp .It Fl c Ar commit
152 030916b5 2018-07-12 stsp Start traversing history at the specified
153 030916b5 2018-07-12 stsp .Ar commit .
154 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
155 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
156 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
157 19e70ad6 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
158 19e70ad6 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
159 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
160 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
161 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
162 ecb28ae0 2018-07-16 stsp working directory.
164 dfc23429 2019-08-11 stsp .It Cm diff Oo Ar repository-path Oc Ar object1 object2
165 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
168 a54b6686 2019-06-28 stsp argument is an object ID SHA1 hash.
169 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
170 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
171 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
173 030916b5 2018-07-12 stsp .Ar repository path
174 030916b5 2018-07-12 stsp is omitted, use the current working directory.
176 030916b5 2018-07-12 stsp The key bindings for
177 030916b5 2018-07-12 stsp .Cm tog diff
178 030916b5 2018-07-12 stsp are as follows:
179 030916b5 2018-07-12 stsp .Bl -tag -width Ds
180 a60a9dc4 2019-05-13 jcs .It Cm Down-arrow, j
181 030916b5 2018-07-12 stsp Scroll down.
182 eb029fd6 2019-05-13 stsp .It Cm Up-arrow, k
184 a60a9dc4 2019-05-13 jcs .It Cm Page-down, Space, Ctrl+f
185 a60a9dc4 2019-05-13 jcs Scroll down one page.
186 a60a9dc4 2019-05-13 jcs .It Cm Page-up, Ctrl+b
187 a60a9dc4 2019-05-13 jcs Scroll up one page.
189 48ae06ee 2018-10-18 stsp Reduce the amount of diff context lines.
191 48ae06ee 2018-10-18 stsp Increase the amount of diff context lines.
192 15a087fe 2019-02-21 stsp .It Cm <, Comma
193 15a087fe 2019-02-21 stsp If the diff view was opened via the log view, move to the previous (younger)
195 15a087fe 2019-02-21 stsp .It Cm >, Full stop
196 15a087fe 2019-02-21 stsp If the diff view was opened via the log view, move to the next (older) commit.
198 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
199 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
201 030916b5 2018-07-12 stsp The key bindings for
202 030916b5 2018-07-12 stsp .Cm tog blame
203 030916b5 2018-07-12 stsp are as follows:
204 030916b5 2018-07-12 stsp .Bl -tag -width Ds
205 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
206 030916b5 2018-07-12 stsp Move the selection cursor down.
207 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
208 030916b5 2018-07-12 stsp Move the selection cursor up.
209 030916b5 2018-07-12 stsp .It Cm Enter
212 030916b5 2018-07-12 stsp view for the currently selected line's commit.
216 c0d30c23 2018-10-07 stsp view with the version of the file as found in the currently
217 c0d30c23 2018-10-07 stsp selected line's commit.
221 c0d30c23 2018-10-07 stsp view with the version of the file as found in the parent commit of the
222 c0d30c23 2018-10-07 stsp currently selected line's commit.
226 c0d30c23 2018-10-07 stsp view with the previously blamed commit.
228 6c4c42e0 2019-06-24 stsp Prompt for a search pattern and start searching for matching line.
229 6c4c42e0 2019-06-24 stsp The search pattern is an extended regular expression.
230 6c4c42e0 2019-06-24 stsp Regular expression syntax is documented in
231 6c4c42e0 2019-06-24 stsp .Xr re_format 7 .
233 6c4c42e0 2019-06-24 stsp Find the next line which matches the current search pattern.
235 6c4c42e0 2019-06-24 stsp Find the previous line which matches the current search pattern.
238 030916b5 2018-07-12 stsp The options for
239 030916b5 2018-07-12 stsp .Cm tog blame
240 030916b5 2018-07-12 stsp are as follows:
241 030916b5 2018-07-12 stsp .Bl -tag -width Ds
242 030916b5 2018-07-12 stsp .It Fl c Ar commit
243 030916b5 2018-07-12 stsp Start traversing history at the specified
244 030916b5 2018-07-12 stsp .Ar commit .
245 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
246 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
247 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
248 69069811 2018-08-02 stsp .It Fl r Ar repository-path
249 69069811 2018-08-02 stsp Use the repository at the specified path.
250 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
251 69069811 2018-08-02 stsp working directory.
253 dfc23429 2019-08-11 stsp .It Cm tree Oo Fl c Ar commit Oc Op Ar repository-path
254 030916b5 2018-07-12 stsp Display the repository tree.
256 030916b5 2018-07-12 stsp .Ar repository path
257 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
259 848d6979 2019-08-12 stsp Displayed tree entries may carry one of the following trailing annotations:
260 848d6979 2019-08-12 stsp .Bl -column YXZ description
261 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
262 848d6979 2019-08-12 stsp .It / Ta entry is a directory
263 848d6979 2019-08-12 stsp .It * Ta entry is an executable file
264 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
267 030916b5 2018-07-12 stsp The key bindings for
268 030916b5 2018-07-12 stsp .Cm tog tree
269 030916b5 2018-07-12 stsp are as follows:
270 030916b5 2018-07-12 stsp .Bl -tag -width Ds
271 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
272 030916b5 2018-07-12 stsp Move the selection cursor down.
273 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
274 030916b5 2018-07-12 stsp Move the selection cursor up.
275 030916b5 2018-07-12 stsp .It Cm Enter
276 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
278 030916b5 2018-07-12 stsp view for the currently selected file.
282 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
283 7837eeac 2018-09-24 stsp .It Cm Backspace
284 030916b5 2018-07-12 stsp Move back to the parent directory.
286 c0d30c23 2018-10-07 stsp Show object IDs for all objects displayed in the
290 4eec20aa 2019-06-22 stsp Prompt for a search pattern and start searching for matching tree entries.
291 4eec20aa 2019-06-22 stsp The search pattern is an extended regular expression which is matched
292 4eec20aa 2019-06-22 stsp against the tree entry's name.
293 4eec20aa 2019-06-22 stsp Regular expression syntax is documented in
294 4eec20aa 2019-06-22 stsp .Xr re_format 7 .
296 4eec20aa 2019-06-22 stsp Find the next tree entry which matches the current search pattern.
298 4eec20aa 2019-06-22 stsp Find the previous tree entry which matches the current search pattern.
301 030916b5 2018-07-12 stsp The options for
302 030916b5 2018-07-12 stsp .Cm tog tree
303 030916b5 2018-07-12 stsp are as follows:
304 030916b5 2018-07-12 stsp .Bl -tag -width Ds
305 030916b5 2018-07-12 stsp .It Fl c Ar commit
306 030916b5 2018-07-12 stsp Start traversing history at the specified
307 030916b5 2018-07-12 stsp .Ar commit .
308 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
309 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
310 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
313 6d17833f 2019-11-08 stsp .Sh ENVIRONMENT
314 6d17833f 2019-11-08 stsp .Bl -tag -width TOG_COLORS
315 6d17833f 2019-11-08 stsp .It Ev TOG_COLORS
317 6d17833f 2019-11-08 stsp shows colorized output if this variable is set to a non-empty value.
318 6d17833f 2019-11-08 stsp The default color scheme can be modified by setting the environment
319 6d17833f 2019-11-08 stsp variables documented below.
320 6d17833f 2019-11-08 stsp The colors available in color schemes are
321 6d17833f 2019-11-08 stsp .Dq black ,
323 6d17833f 2019-11-08 stsp .Dq green ,
324 6d17833f 2019-11-08 stsp .Dq yellow ,
326 6d17833f 2019-11-08 stsp .Dq megenta ,
329 1d7fe5cd 2019-11-08 stsp .Dq default
330 1d7fe5cd 2019-11-08 stsp which maps to the terminal's default foreground color.
331 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_MINUS
332 6d17833f 2019-11-08 stsp The color used to mark up removed lines in diffs.
333 6d17833f 2019-11-08 stsp If not set, the default value
334 6d17833f 2019-11-08 stsp .Dq magenta
336 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_PLUS
337 6d17833f 2019-11-08 stsp The color used to mark up added lines in diffs.
338 6d17833f 2019-11-08 stsp If not set, the default value
341 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_CHUNK_HEADER
342 6d17833f 2019-11-08 stsp The color used to mark up chunk header lines in diffs.
343 6d17833f 2019-11-08 stsp If not set, the default value
346 6d17833f 2019-11-08 stsp .It Ev TOG_COLOR_DIFF_META
347 6d17833f 2019-11-08 stsp The color used to mark up meta data in diffs.
348 c0b01bdb 2019-11-08 stsp If not set, the default value
351 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SUBMODULE
352 c0b01bdb 2019-11-08 stsp The color used to mark up sobmodules tree entries.
353 c0b01bdb 2019-11-08 stsp If not set, the default value
354 c0b01bdb 2019-11-08 stsp .Dq magenta
356 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_SYMLINK
357 c0b01bdb 2019-11-08 stsp The color used to mark up symbolic link tree entries.
358 c0b01bdb 2019-11-08 stsp If not set, the default value
359 91b8c405 2020-01-25 stsp .Dq magenta
361 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_DIRECTORY
362 c0b01bdb 2019-11-08 stsp The color used to mark up directory tree entries.
363 6d17833f 2019-11-08 stsp If not set, the default value
366 c0b01bdb 2019-11-08 stsp .It Ev TOG_COLOR_TREE_EXECUTABLE
367 c0b01bdb 2019-11-08 stsp The color used to mark up executable file tree entries.
368 c0b01bdb 2019-11-08 stsp If not set, the default value
371 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_COMMIT
372 11b20872 2019-11-08 stsp The color used to mark up commit IDs.
373 11b20872 2019-11-08 stsp If not set, the default value
376 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_AUTHOR
377 11b20872 2019-11-08 stsp The color used to mark up author information.
378 11b20872 2019-11-08 stsp If not set, the default value
381 11b20872 2019-11-08 stsp .It Ev TOG_COLOR_DATE
382 11b20872 2019-11-08 stsp The color used to mark up date information.
383 11b20872 2019-11-08 stsp If not set, the default value
387 030916b5 2018-07-12 stsp .Sh EXIT STATUS
388 030916b5 2018-07-12 stsp .Ex -std tog
389 030916b5 2018-07-12 stsp .Sh SEE ALSO
390 56b9a4ca 2019-06-21 stsp .Xr got 1 ,
391 56b9a4ca 2019-06-21 stsp .Xr git-repository 5 ,
392 56b9a4ca 2019-06-21 stsp .Xr re_format 7
393 030916b5 2018-07-12 stsp .Sh AUTHORS
394 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
395 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
