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, and log message.
111 Regular expression syntax is documented in
112 .Xr re_format 7 .
113 .It Cm n
114 Find the next commit which matches the current search pattern.
115 .It Cm N
116 Find the previous commit which matches the current search pattern.
117 .El
118 .Pp
119 The options for
120 .Cm tog log
121 are as follows:
122 .Bl -tag -width Ds
123 .It Fl c Ar commit
124 Start traversing history at the specified
125 .Ar commit .
126 The expected argument is the name of a branch or a SHA1 hash which corresponds
127 to a commit object.
128 If this option is not specified, default to the work tree's current branch
129 if invoked in a work tree, or to the repository's HEAD reference.
130 .It Fl r Ar repository-path
131 Use the repository at the specified path.
132 If not specified, assume the repository is located at or above the current
133 working directory.
134 .El
135 .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
136 Display the differences between two objects in the repository.
137 Each
138 .Ar object
139 argument is a SHA1 hash which corresponds to the object.
140 Both objects must be of the same type (blobs, trees, or commits).
141 If the
142 .Ar repository path
143 is omitted, use the current working directory.
144 .Pp
145 The key bindings for
146 .Cm tog diff
147 are as follows:
148 .Bl -tag -width Ds
149 .It Cm Down-arrow, j
150 Scroll down.
151 .It Cm Up-arrow, k
152 Scroll up.
153 .It Cm Page-down, Space, Ctrl+f
154 Scroll down one page.
155 .It Cm Page-up, Ctrl+b
156 Scroll up one page.
157 .It Cm [
158 Reduce the amount of diff context lines.
159 .It Cm ]
160 Increase the amount of diff context lines.
161 .It Cm <, Comma
162 If the diff view was opened via the log view, move to the previous (younger)
163 commit.
164 .It Cm >, Full stop
165 If the diff view was opened via the log view, move to the next (older) commit.
166 .El
167 .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
168 Display line-by-line history of a file at the specified path.
169 .Pp
170 The key bindings for
171 .Cm tog blame
172 are as follows:
173 .Bl -tag -width Ds
174 .It Cm Down-arrow, j, Page-down, Space
175 Move the selection cursor down.
176 .It Cm Up-arrow, k, Page-up
177 Move the selection cursor up.
178 .It Cm Enter
179 Open a
180 .Cm diff
181 view for the currently selected line's commit.
182 .It Cm b
183 Reload the
184 .Cm blame
185 view with the version of the file as found in the currently
186 selected line's commit.
187 .It Cm p
188 Reload the
189 .Cm blame
190 view with the version of the file as found in the parent commit of the
191 currently selected line's commit.
192 .It Cm B
193 Reload the
194 .Cm blame
195 view with the previously blamed commit.
196 .It Cm /
197 Prompt for a search pattern and start searching for matching line.
198 The search pattern is an extended regular expression.
199 Regular expression syntax is documented in
200 .Xr re_format 7 .
201 .It Cm n
202 Find the next line which matches the current search pattern.
203 .It Cm N
204 Find the previous line which matches the current search pattern.
205 .El
206 .Pp
207 The options for
208 .Cm tog blame
209 are as follows:
210 .Bl -tag -width Ds
211 .It Fl c Ar commit
212 Start traversing history at the specified
213 .Ar commit .
214 The expected argument is the name of a branch or a SHA1 hash which corresponds
215 to a commit object.
216 .It Fl r Ar repository-path
217 Use the repository at the specified path.
218 If not specified, assume the repository is located at or above the current
219 working directory.
220 .El
221 .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
222 Display the repository tree.
223 If the
224 .Ar repository path
225 is omitted, assume the repository is located in the current working directory.
226 .Pp
227 The key bindings for
228 .Cm tog tree
229 are as follows:
230 .Bl -tag -width Ds
231 .It Cm Down-arrow, j, Page-down
232 Move the selection cursor down.
233 .It Cm Up-arrow, k, Page-up
234 Move the selection cursor up.
235 .It Cm Enter
236 Enter the currently selected directory, or switch to the
237 .Cm blame
238 view for the currently selected file.
239 .It Cm l
240 Open a
241 .Cm log
242 view for the currently selected tree entry.
243 .It Cm Backspace
244 Move back to the parent directory.
245 .It Cm i
246 Show object IDs for all objects displayed in the
247 .Cm tree
248 view.
249 .It Cm /
250 Prompt for a search pattern and start searching for matching tree entries.
251 The search pattern is an extended regular expression which is matched
252 against the tree entry's name.
253 Regular expression syntax is documented in
254 .Xr re_format 7 .
255 .It Cm n
256 Find the next tree entry which matches the current search pattern.
257 .It Cm N
258 Find the previous tree entry which matches the current search pattern.
259 .El
260 .Pp
261 The options for
262 .Cm tog tree
263 are as follows:
264 .Bl -tag -width Ds
265 .It Fl c Ar commit
266 Start traversing history at the specified
267 .Ar commit .
268 The expected argument is the name of a branch or a SHA1 hash which corresponds
269 to a commit object.
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