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 0cf4efb1 2018-09-29 stsp supports several types of views which display repository data:
35 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
36 87aa0e98 2018-08-18 stsp .It Cm log view
37 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
38 87aa0e98 2018-08-18 stsp This view is displayed initially if no
40 87aa0e98 2018-08-18 stsp is specified.
41 87aa0e98 2018-08-18 stsp .It Cm diff view
42 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
43 87aa0e98 2018-08-18 stsp .It Cm blame view
44 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
45 87aa0e98 2018-08-18 stsp .It Cm tree view
46 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
50 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
51 87aa0e98 2018-08-18 stsp The global key bindings are:
52 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
57 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
59 0cf4efb1 2018-09-29 stsp Switch focus to the next view. Cycles through all views.
61 0cf4efb1 2018-09-29 stsp Switch focus to the previous view. Cycles through all views.
63 0cf4efb1 2018-09-29 stsp Toggle fullscreen mode for the view which is in focus.
66 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
67 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
69 030916b5 2018-07-12 stsp Display usage information.
72 030916b5 2018-07-12 stsp The commands for
74 030916b5 2018-07-12 stsp are as follows:
75 030916b5 2018-07-12 stsp .Bl -tag -width blame
76 ecb28ae0 2018-07-16 stsp .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
77 030916b5 2018-07-12 stsp Display history of a repository.
80 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
82 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
84 030916b5 2018-07-12 stsp The key bindings for
86 030916b5 2018-07-12 stsp are as follows:
87 030916b5 2018-07-12 stsp .Bl -tag -width Ds
88 bcbd79e2 2018-08-19 stsp .It Cm Down-arrow, j, ], Page-down
89 030916b5 2018-07-12 stsp Move the selection cursor down.
90 bcbd79e2 2018-08-19 stsp .It Cm Up-arrow, k, [, Page-up
91 030916b5 2018-07-12 stsp Move the selection cursor up.
92 030916b5 2018-07-12 stsp .It Cm Enter
93 030916b5 2018-07-12 stsp Switch to the
95 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
97 030916b5 2018-07-12 stsp Switch to the
99 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
100 5036bf37 2018-09-24 stsp .It Cm Backspace
101 5036bf37 2018-09-24 stsp Show log entries for the parent directory of the currently selected path.
104 030916b5 2018-07-12 stsp The options for
105 030916b5 2018-07-12 stsp .Cm tog log
106 030916b5 2018-07-12 stsp are as follows:
107 030916b5 2018-07-12 stsp .Bl -tag -width Ds
108 030916b5 2018-07-12 stsp .It Fl c Ar commit
109 030916b5 2018-07-12 stsp Start traversing history at the specified
110 030916b5 2018-07-12 stsp .Ar commit .
111 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
112 030916b5 2018-07-12 stsp to a commit object.
113 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
114 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
115 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
116 ecb28ae0 2018-07-16 stsp working directory.
118 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
119 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
122 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
123 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
125 030916b5 2018-07-12 stsp .Ar repository path
126 030916b5 2018-07-12 stsp is omitted, use the current working directory.
128 030916b5 2018-07-12 stsp The key bindings for
129 030916b5 2018-07-12 stsp .Cm tog diff
130 030916b5 2018-07-12 stsp are as follows:
131 030916b5 2018-07-12 stsp .Bl -tag -width Ds
132 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
133 030916b5 2018-07-12 stsp Scroll down.
134 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
137 69069811 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
138 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
140 030916b5 2018-07-12 stsp The key bindings for
141 030916b5 2018-07-12 stsp .Cm tog blame
142 030916b5 2018-07-12 stsp are as follows:
143 030916b5 2018-07-12 stsp .Bl -tag -width Ds
144 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
145 030916b5 2018-07-12 stsp Move the selection cursor down.
146 31607d6c 2018-08-18 stsp .It Cm Up-arrow, k, Page-up
147 030916b5 2018-07-12 stsp Move the selection cursor up.
148 030916b5 2018-07-12 stsp .It Cm Enter
149 030916b5 2018-07-12 stsp Switch to the
151 030916b5 2018-07-12 stsp view for the currently selected line's commit.
155 030916b5 2018-07-12 stsp view for the version of the file in the currently selected line's commit.
159 7a2921f9 2018-07-12 stsp view for the version of the file in the currently selected line's commit's
160 7a2921f9 2018-07-12 stsp parent commit.
164 030916b5 2018-07-12 stsp view back to the previously blamed commit.
167 030916b5 2018-07-12 stsp The options for
168 030916b5 2018-07-12 stsp .Cm tog blame
169 030916b5 2018-07-12 stsp are as follows:
170 030916b5 2018-07-12 stsp .Bl -tag -width Ds
171 030916b5 2018-07-12 stsp .It Fl c Ar commit
172 030916b5 2018-07-12 stsp Start traversing history at the specified
173 030916b5 2018-07-12 stsp .Ar commit .
174 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
175 030916b5 2018-07-12 stsp to a commit object.
176 69069811 2018-08-02 stsp .It Fl r Ar repository-path
177 69069811 2018-08-02 stsp Use the repository at the specified path.
178 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
179 69069811 2018-08-02 stsp working directory.
181 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
182 030916b5 2018-07-12 stsp Display the repository tree.
184 030916b5 2018-07-12 stsp .Ar repository path
185 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
187 030916b5 2018-07-12 stsp The key bindings for
188 030916b5 2018-07-12 stsp .Cm tog tree
189 030916b5 2018-07-12 stsp are as follows:
190 030916b5 2018-07-12 stsp .Bl -tag -width Ds
191 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
192 030916b5 2018-07-12 stsp Move the selection cursor down.
193 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
194 030916b5 2018-07-12 stsp Move the selection cursor up.
195 030916b5 2018-07-12 stsp .It Cm Enter
196 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
198 030916b5 2018-07-12 stsp view for the currently selected file.
200 69efd4c4 2018-07-18 stsp Switch to the
202 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
203 7837eeac 2018-09-24 stsp .It Cm Backspace
204 030916b5 2018-07-12 stsp Move back to the parent directory.
206 030916b5 2018-07-12 stsp Show the object IDs for all objects displayed in the
211 030916b5 2018-07-12 stsp The options for
212 030916b5 2018-07-12 stsp .Cm tog tree
213 030916b5 2018-07-12 stsp are as follows:
214 030916b5 2018-07-12 stsp .Bl -tag -width Ds
215 030916b5 2018-07-12 stsp .It Fl c Ar commit
216 030916b5 2018-07-12 stsp Start traversing history at the specified
217 030916b5 2018-07-12 stsp .Ar commit .
218 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
219 030916b5 2018-07-12 stsp to a commit object.
222 030916b5 2018-07-12 stsp .Sh EXIT STATUS
223 030916b5 2018-07-12 stsp .Ex -std tog
224 030916b5 2018-07-12 stsp .Sh SEE ALSO
225 5e5560e1 2018-08-01 stsp .Xr git-repository 5
226 030916b5 2018-07-12 stsp .Sh AUTHORS
227 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org