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