2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
4 030916b5 2018-07-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 030916b5 2018-07-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 030916b5 2018-07-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 030916b5 2018-07-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 030916b5 2018-07-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 030916b5 2018-07-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 030916b5 2018-07-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 030916b5 2018-07-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 030916b5 2018-07-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 030916b5 2018-07-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
21 030916b5 2018-07-12 stsp .Nd git repository browser
22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
26 030916b5 2018-07-12 stsp .Op Ar arg ...
27 030916b5 2018-07-12 stsp .Sh DESCRIPTION
29 030916b5 2018-07-12 stsp is an interactive read-only browser for git repositories.
30 030916b5 2018-07-12 stsp This repository format is described in
31 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
34 87aa0e98 2018-08-18 stsp supports several types of views which display repository data.
35 87aa0e98 2018-08-18 stsp An arbitrary number of views may be opened simultaneously by
36 87aa0e98 2018-08-18 stsp navigating the repository with
38 bcbd79e2 2018-08-19 stsp Sometimes, if one view is opened from another view, the child view
39 bcbd79e2 2018-08-19 stsp is linked to its parent view and both views will keep their data
40 bcbd79e2 2018-08-19 stsp display in sync.
41 87aa0e98 2018-08-18 stsp The supported views are:
42 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
43 87aa0e98 2018-08-18 stsp .It Cm log view
44 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
45 87aa0e98 2018-08-18 stsp This view is displayed initially if no
47 87aa0e98 2018-08-18 stsp is specified.
48 87aa0e98 2018-08-18 stsp .It Cm diff view
49 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
50 87aa0e98 2018-08-18 stsp .It Cm blame view
51 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
52 87aa0e98 2018-08-18 stsp .It Cm tree view
53 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
57 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
58 87aa0e98 2018-08-18 stsp The global key bindings are:
59 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
64 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
66 87aa0e98 2018-08-18 stsp Switch focus to the next view.
67 87aa0e98 2018-08-18 stsp Cycles through all open views.
68 31607d6c 2018-08-18 stsp .It Cm Backspace
69 31607d6c 2018-08-18 stsp Switch focus to the previous view.
70 31607d6c 2018-08-18 stsp Cycles through all open views.
73 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
74 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
76 030916b5 2018-07-12 stsp Display usage information.
79 030916b5 2018-07-12 stsp The commands for
81 030916b5 2018-07-12 stsp are as follows:
82 030916b5 2018-07-12 stsp .Bl -tag -width blame
83 ecb28ae0 2018-07-16 stsp .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
84 030916b5 2018-07-12 stsp Display history of a repository.
87 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
89 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
91 030916b5 2018-07-12 stsp The key bindings for
93 030916b5 2018-07-12 stsp are as follows:
94 030916b5 2018-07-12 stsp .Bl -tag -width Ds
95 bcbd79e2 2018-08-19 stsp .It Cm Down-arrow, j, ], Page-down
96 030916b5 2018-07-12 stsp Move the selection cursor down.
97 bcbd79e2 2018-08-19 stsp .It Cm Up-arrow, k, [, Page-up
98 030916b5 2018-07-12 stsp Move the selection cursor up.
99 030916b5 2018-07-12 stsp .It Cm Enter
100 030916b5 2018-07-12 stsp Switch to the
102 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
103 bcbd79e2 2018-08-19 stsp The diff view is linked to the log view so either view will be
104 bcbd79e2 2018-08-19 stsp updated when the other switches to a different commit.
106 030916b5 2018-07-12 stsp Switch to the
108 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
111 030916b5 2018-07-12 stsp The options for
112 030916b5 2018-07-12 stsp .Cm tog log
113 030916b5 2018-07-12 stsp are as follows:
114 030916b5 2018-07-12 stsp .Bl -tag -width Ds
115 030916b5 2018-07-12 stsp .It Fl c Ar commit
116 030916b5 2018-07-12 stsp Start traversing history at the specified
117 030916b5 2018-07-12 stsp .Ar commit .
118 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
119 030916b5 2018-07-12 stsp to a commit object.
120 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
121 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
122 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
123 ecb28ae0 2018-07-16 stsp working directory.
125 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
126 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
129 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
130 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
132 030916b5 2018-07-12 stsp .Ar repository path
133 030916b5 2018-07-12 stsp is omitted, use the current working directory.
135 030916b5 2018-07-12 stsp The key bindings for
136 030916b5 2018-07-12 stsp .Cm tog diff
137 030916b5 2018-07-12 stsp are as follows:
138 030916b5 2018-07-12 stsp .Bl -tag -width Ds
139 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
140 030916b5 2018-07-12 stsp Scroll down.
141 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
144 bcbd79e2 2018-08-19 stsp Switch to the previous commit in parent
145 bcbd79e2 2018-08-19 stsp .Cm log view .
147 bcbd79e2 2018-08-19 stsp Switch to the next commit in parent
148 bcbd79e2 2018-08-19 stsp .Cm log view .
150 69069811 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
151 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
153 030916b5 2018-07-12 stsp The key bindings for
154 030916b5 2018-07-12 stsp .Cm tog blame
155 030916b5 2018-07-12 stsp are as follows:
156 030916b5 2018-07-12 stsp .Bl -tag -width Ds
157 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
158 030916b5 2018-07-12 stsp Move the selection cursor down.
159 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
160 030916b5 2018-07-12 stsp Move the selection cursor up.
161 030916b5 2018-07-12 stsp .It Cm Enter
162 030916b5 2018-07-12 stsp Switch to the
164 030916b5 2018-07-12 stsp view for the currently selected line's commit.
168 030916b5 2018-07-12 stsp view for the version of the file in the currently selected line's commit.
172 7a2921f9 2018-07-12 stsp view for the version of the file in the currently selected line's commit's
173 7a2921f9 2018-07-12 stsp parent commit.
177 030916b5 2018-07-12 stsp view back to the previously blamed commit.
180 030916b5 2018-07-12 stsp The options for
181 030916b5 2018-07-12 stsp .Cm tog blame
182 030916b5 2018-07-12 stsp are as follows:
183 030916b5 2018-07-12 stsp .Bl -tag -width Ds
184 030916b5 2018-07-12 stsp .It Fl c Ar commit
185 030916b5 2018-07-12 stsp Start traversing history at the specified
186 030916b5 2018-07-12 stsp .Ar commit .
187 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
188 030916b5 2018-07-12 stsp to a commit object.
189 69069811 2018-08-02 stsp .It Fl r Ar repository-path
190 69069811 2018-08-02 stsp Use the repository at the specified path.
191 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
192 69069811 2018-08-02 stsp working directory.
194 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
195 030916b5 2018-07-12 stsp Display the repository tree.
197 030916b5 2018-07-12 stsp .Ar repository path
198 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
200 030916b5 2018-07-12 stsp The key bindings for
201 030916b5 2018-07-12 stsp .Cm tog tree
202 030916b5 2018-07-12 stsp are as follows:
203 030916b5 2018-07-12 stsp .Bl -tag -width Ds
204 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
205 030916b5 2018-07-12 stsp Move the selection cursor down.
206 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
207 030916b5 2018-07-12 stsp Move the selection cursor up.
208 030916b5 2018-07-12 stsp .It Cm Enter
209 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
211 030916b5 2018-07-12 stsp view for the currently selected file.
213 69efd4c4 2018-07-18 stsp Switch to the
215 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
216 31607d6c 2018-08-18 stsp .It Cm Left-arrow
217 030916b5 2018-07-12 stsp Move back to the parent directory.
219 030916b5 2018-07-12 stsp Show the object IDs for all objects displayed in the
224 030916b5 2018-07-12 stsp The options for
225 030916b5 2018-07-12 stsp .Cm tog tree
226 030916b5 2018-07-12 stsp are as follows:
227 030916b5 2018-07-12 stsp .Bl -tag -width Ds
228 030916b5 2018-07-12 stsp .It Fl c Ar commit
229 030916b5 2018-07-12 stsp Start traversing history at the specified
230 030916b5 2018-07-12 stsp .Ar commit .
231 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
232 030916b5 2018-07-12 stsp to a commit object.
235 030916b5 2018-07-12 stsp .Sh EXIT STATUS
236 030916b5 2018-07-12 stsp .Ex -std tog
237 030916b5 2018-07-12 stsp .Sh SEE ALSO
238 5e5560e1 2018-08-01 stsp .Xr git-repository 5
239 030916b5 2018-07-12 stsp .Sh AUTHORS
240 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
