1 .\"
2 .\" Copyright (c) 2018 Stefan Sperling
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd $Mdocdate$
17 .Dt TOG 1
18 .Os
19 .Sh NAME
20 .Nm tog
21 .Nd git repository browser
22 .Sh SYNOPSIS
23 .Nm
24 .Ar command
25 .Op Fl h
26 .Op Ar arg ...
27 .Sh DESCRIPTION
28 .Nm
29 is an interactive read-only browser for git repositories.
30 This repository format is described in
31 .Xr git-repository 5 .
32 .Pp
33 .Nm
34 supports several types of views which display repository data:
35 .Bl -tag -width Ds
36 .It Log view
37 Displays commits in the repository's history.
38 This view is displayed initially if no
39 .Ar command
40 is specified.
41 .It Diff view
42 Displays changes made in a particular commit.
43 .It Blame view
44 Displays the line-by-line history of a file.
45 .It Tree view
46 Displays the tree corresponding to a particular commit.
47 .El
48 .Pp
49 .Nm
50 provides global and command-specific key bindings and options.
51 The global key bindings are:
52 .Bl -tag -width Ds
53 .It Cm Q
54 Quit
55 .Nm .
56 .It Cm q
57 Quit the view which is in focus.
58 .It Cm Tab
59 Switch focus between views.
60 .It Cm f
61 Toggle fullscreen mode for a split-screen view.
62 .Nm
63 will automatically use split-screen views if the size of the terminal
64 window is sufficiently large.
65 .El
66 .Pp
67 Global options must precede the command name, and are as follows:
68 .Bl -tag -width tenletters
69 .It Fl h
70 Display usage information.
71 .El
72 .Pp
73 The commands for
74 .Nm
75 are as follows:
76 .Bl -tag -width blame
77 .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
78 Display history of a repository.
79 If a
80 .Ar path
81 is specified, show only commits which modified this path.
82 .Pp
83 This command is also executed if no explicit command is specified.
84 .Pp
85 The key bindings for
86 .Cm tog log
87 are as follows:
88 .Bl -tag -width Ds
89 .It Cm Down-arrow, j, >, Full stop
90 Move the selection cursor down.
91 .It Cm Up-arrow, k, <, Comma
92 Move the selection cursor up.
93 .It Cm Page-down, Ctrl+f
94 Move the selection cursor down one page.
95 .It Cm Page-up, Ctrl+b
96 Move the selection cursor up one page.
97 .It Cm Enter, Space
98 Open a
99 .Cm diff
100 view showing file changes made in the currently selected commit.
101 .It Cm t
102 Open a
103 .Cm tree
104 view showing the tree for the currently selected commit.
105 .It Cm Backspace
106 Show log entries for the parent directory of the currently selected path.
107 .It Cm /
108 Prompt for a search pattern and start searching for matching commits.
109 The search pattern is an extended regular expression which is matched
110 against a commit's author name, committer name, log message, and
111 commit ID SHA1 hash.
112 Regular expression syntax is documented in
113 .Xr re_format 7 .
114 .It Cm n
115 Find the next commit which matches the current search pattern.
116 .It Cm N
117 Find the previous commit which matches the current search pattern.
118 .It Cm Ctrl+l
119 Reload the log view with new commits found in the repository.
120 .El
121 .Pp
122 The options for
123 .Cm tog log
124 are as follows:
125 .Bl -tag -width Ds
126 .It Fl c Ar commit
127 Start traversing history at the specified
128 .Ar commit .
129 The expected argument is the name of a branch or a commit ID SHA1 hash.
130 If this option is not specified, default to the work tree's current branch
131 if invoked in a work tree, or to the repository's HEAD reference.
132 .It Fl r Ar repository-path
133 Use the repository at the specified path.
134 If not specified, assume the repository is located at or above the current
135 working directory.
136 .El
137 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
138 Display the differences between two objects in the repository.
139 Each
140 .Ar object
141 argument is an object ID SHA1 hash.
142 Both objects must be of the same type (blobs, trees, or commits).
143 If the
144 .Ar repository path
145 is omitted, use the current working directory.
146 .Pp
147 The key bindings for
148 .Cm tog diff
149 are as follows:
150 .Bl -tag -width Ds
151 .It Cm Down-arrow, j
152 Scroll down.
153 .It Cm Up-arrow, k
154 Scroll up.
155 .It Cm Page-down, Space, Ctrl+f
156 Scroll down one page.
157 .It Cm Page-up, Ctrl+b
158 Scroll up one page.
159 .It Cm [
160 Reduce the amount of diff context lines.
161 .It Cm ]
162 Increase the amount of diff context lines.
163 .It Cm <, Comma
164 If the diff view was opened via the log view, move to the previous (younger)
165 commit.
166 .It Cm >, Full stop
167 If the diff view was opened via the log view, move to the next (older) commit.
168 .El
169 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
170 Display line-by-line history of a file at the specified path.
171 .Pp
172 The key bindings for
173 .Cm tog blame
174 are as follows:
175 .Bl -tag -width Ds
176 .It Cm Down-arrow, j, Page-down, Space
177 Move the selection cursor down.
178 .It Cm Up-arrow, k, Page-up
179 Move the selection cursor up.
180 .It Cm Enter
181 Open a
182 .Cm diff
183 view for the currently selected line's commit.
184 .It Cm b
185 Reload the
186 .Cm blame
187 view with the version of the file as found in the currently
188 selected line's commit.
189 .It Cm p
190 Reload the
191 .Cm blame
192 view with the version of the file as found in the parent commit of the
193 currently selected line's commit.
194 .It Cm B
195 Reload the
196 .Cm blame
197 view with the previously blamed commit.
198 .It Cm /
199 Prompt for a search pattern and start searching for matching line.
200 The search pattern is an extended regular expression.
201 Regular expression syntax is documented in
202 .Xr re_format 7 .
203 .It Cm n
204 Find the next line which matches the current search pattern.
205 .It Cm N
206 Find the previous line which matches the current search pattern.
207 .El
208 .Pp
209 The options for
210 .Cm tog blame
211 are as follows:
212 .Bl -tag -width Ds
213 .It Fl c Ar commit
214 Start traversing history at the specified
215 .Ar commit .
216 The expected argument is the name of a branch or a commit ID SHA1 hash.
217 .It Fl r Ar repository-path
218 Use the repository at the specified path.
219 If not specified, assume the repository is located at or above the current
220 working directory.
221 .El
222 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
223 Display the repository tree.
224 If the
225 .Ar repository path
226 is omitted, assume the repository is located in the current working directory.
227 .Pp
228 The key bindings for
229 .Cm tog tree
230 are as follows:
231 .Bl -tag -width Ds
232 .It Cm Down-arrow, j, Page-down
233 Move the selection cursor down.
234 .It Cm Up-arrow, k, Page-up
235 Move the selection cursor up.
236 .It Cm Enter
237 Enter the currently selected directory, or switch to the
238 .Cm blame
239 view for the currently selected file.
240 .It Cm l
241 Open a
242 .Cm log
243 view for the currently selected tree entry.
244 .It Cm Backspace
245 Move back to the parent directory.
246 .It Cm i
247 Show object IDs for all objects displayed in the
248 .Cm tree
249 view.
250 .It Cm /
251 Prompt for a search pattern and start searching for matching tree entries.
252 The search pattern is an extended regular expression which is matched
253 against the tree entry's name.
254 Regular expression syntax is documented in
255 .Xr re_format 7 .
256 .It Cm n
257 Find the next tree entry which matches the current search pattern.
258 .It Cm N
259 Find the previous tree entry which matches the current search pattern.
260 .El
261 .Pp
262 The options for
263 .Cm tog tree
264 are as follows:
265 .Bl -tag -width Ds
266 .It Fl c Ar commit
267 Start traversing history at the specified
268 .Ar commit .
269 The expected argument is the name of a branch or a commit ID SHA1 hash.
270 .El
271 .El
272 .Sh EXIT STATUS
273 .Ex -std tog
274 .Sh SEE ALSO
275 .Xr got 1 ,
276 .Xr git-repository 5 ,
277 .Xr re_format 7
278 .Sh AUTHORS
279 .An Stefan Sperling Aq Mt stsp@openbsd.org
280 .An joshua stein Aq Mt jcs@openbsd.org