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