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