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 87aa0e98 2018-08-18 stsp The supported views are:
39 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
40 87aa0e98 2018-08-18 stsp .It Cm log view
41 87aa0e98 2018-08-18 stsp Displays commits in the repository's history.
42 87aa0e98 2018-08-18 stsp This view is displayed initially if no
44 87aa0e98 2018-08-18 stsp is specified.
45 87aa0e98 2018-08-18 stsp .It Cm diff view
46 87aa0e98 2018-08-18 stsp Displays changes made in a particular commit.
47 87aa0e98 2018-08-18 stsp .It Cm blame view
48 87aa0e98 2018-08-18 stsp Displays the line-by-line history of a file.
49 87aa0e98 2018-08-18 stsp .It Cm tree view
50 87aa0e98 2018-08-18 stsp Displays the tree corresponding to a particular commit.
54 87aa0e98 2018-08-18 stsp provides global and command-specific key bindings and options.
55 87aa0e98 2018-08-18 stsp The global key bindings are:
56 87aa0e98 2018-08-18 stsp .Bl -tag -width Ds
61 87aa0e98 2018-08-18 stsp Quit the view which is in focus.
63 87aa0e98 2018-08-18 stsp Switch focus to the next view.
64 87aa0e98 2018-08-18 stsp Cycles through all open views.
67 87aa0e98 2018-08-18 stsp Global options must precede the command name, and are as follows:
68 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
70 030916b5 2018-07-12 stsp Display usage information.
73 030916b5 2018-07-12 stsp The commands for
75 030916b5 2018-07-12 stsp are as follows:
76 030916b5 2018-07-12 stsp .Bl -tag -width blame
77 ecb28ae0 2018-07-16 stsp .It Cm log [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ path ]
78 030916b5 2018-07-12 stsp Display history of a repository.
81 ecb28ae0 2018-07-16 stsp is specified, show only commits which modified this path.
83 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
85 030916b5 2018-07-12 stsp The key bindings for
87 030916b5 2018-07-12 stsp are as follows:
88 030916b5 2018-07-12 stsp .Bl -tag -width Ds
89 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
90 030916b5 2018-07-12 stsp Move the selection cursor down.
91 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
92 030916b5 2018-07-12 stsp Move the selection cursor up.
93 030916b5 2018-07-12 stsp .It Cm Enter
94 030916b5 2018-07-12 stsp Switch to the
96 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
98 030916b5 2018-07-12 stsp Switch to the
100 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
103 030916b5 2018-07-12 stsp The options for
104 030916b5 2018-07-12 stsp .Cm tog log
105 030916b5 2018-07-12 stsp are as follows:
106 030916b5 2018-07-12 stsp .Bl -tag -width Ds
107 030916b5 2018-07-12 stsp .It Fl c Ar commit
108 030916b5 2018-07-12 stsp Start traversing history at the specified
109 030916b5 2018-07-12 stsp .Ar commit .
110 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
111 030916b5 2018-07-12 stsp to a commit object.
112 ecb28ae0 2018-07-16 stsp .It Fl r Ar repository-path
113 ecb28ae0 2018-07-16 stsp Use the repository at the specified path.
114 ecb28ae0 2018-07-16 stsp If not specified, assume the repository is located at or above the current
115 ecb28ae0 2018-07-16 stsp working directory.
117 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
118 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
121 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
122 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
124 030916b5 2018-07-12 stsp .Ar repository path
125 030916b5 2018-07-12 stsp is omitted, use the current working directory.
127 030916b5 2018-07-12 stsp The key bindings for
128 030916b5 2018-07-12 stsp .Cm tog diff
129 030916b5 2018-07-12 stsp are as follows:
130 030916b5 2018-07-12 stsp .Bl -tag -width Ds
131 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
132 030916b5 2018-07-12 stsp Scroll down.
133 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
136 69069811 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
137 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
139 030916b5 2018-07-12 stsp The key bindings for
140 030916b5 2018-07-12 stsp .Cm tog blame
141 030916b5 2018-07-12 stsp are as follows:
142 030916b5 2018-07-12 stsp .Bl -tag -width Ds
143 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
144 030916b5 2018-07-12 stsp Move the selection cursor down.
145 38f94530 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
146 030916b5 2018-07-12 stsp Move the selection cursor up.
147 030916b5 2018-07-12 stsp .It Cm Enter
148 030916b5 2018-07-12 stsp Switch to the
150 030916b5 2018-07-12 stsp view for the currently selected line's commit.
154 030916b5 2018-07-12 stsp view for the version of the file in the currently selected line's commit.
158 7a2921f9 2018-07-12 stsp view for the version of the file in the currently selected line's commit's
159 7a2921f9 2018-07-12 stsp parent commit.
163 030916b5 2018-07-12 stsp view back to the previously blamed commit.
166 030916b5 2018-07-12 stsp The options for
167 030916b5 2018-07-12 stsp .Cm tog blame
168 030916b5 2018-07-12 stsp are as follows:
169 030916b5 2018-07-12 stsp .Bl -tag -width Ds
170 030916b5 2018-07-12 stsp .It Fl c Ar commit
171 030916b5 2018-07-12 stsp Start traversing history at the specified
172 030916b5 2018-07-12 stsp .Ar commit .
173 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
174 030916b5 2018-07-12 stsp to a commit object.
175 69069811 2018-08-02 stsp .It Fl r Ar repository-path
176 69069811 2018-08-02 stsp Use the repository at the specified path.
177 69069811 2018-08-02 stsp If not specified, assume the repository is located at or above the current
178 69069811 2018-08-02 stsp working directory.
180 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
181 030916b5 2018-07-12 stsp Display the repository tree.
183 030916b5 2018-07-12 stsp .Ar repository path
184 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
186 030916b5 2018-07-12 stsp The key bindings for
187 030916b5 2018-07-12 stsp .Cm tog tree
188 030916b5 2018-07-12 stsp are as follows:
189 030916b5 2018-07-12 stsp .Bl -tag -width Ds
190 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
191 030916b5 2018-07-12 stsp Move the selection cursor down.
192 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
193 030916b5 2018-07-12 stsp Move the selection cursor up.
194 030916b5 2018-07-12 stsp .It Cm Enter
195 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
197 030916b5 2018-07-12 stsp view for the currently selected file.
199 69efd4c4 2018-07-18 stsp Switch to the
201 69efd4c4 2018-07-18 stsp view for the currently selected tree entry.
202 030916b5 2018-07-12 stsp .It Cm Backspace
203 030916b5 2018-07-12 stsp Move back to the parent directory.
205 030916b5 2018-07-12 stsp Show the object IDs for all objects displayed in the
210 030916b5 2018-07-12 stsp The options for
211 030916b5 2018-07-12 stsp .Cm tog tree
212 030916b5 2018-07-12 stsp are as follows:
213 030916b5 2018-07-12 stsp .Bl -tag -width Ds
214 030916b5 2018-07-12 stsp .It Fl c Ar commit
215 030916b5 2018-07-12 stsp Start traversing history at the specified
216 030916b5 2018-07-12 stsp .Ar commit .
217 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
218 030916b5 2018-07-12 stsp to a commit object.
221 030916b5 2018-07-12 stsp .Sh EXIT STATUS
222 030916b5 2018-07-12 stsp .Ex -std tog
223 030916b5 2018-07-12 stsp .Sh SEE ALSO
224 5e5560e1 2018-08-01 stsp .Xr git-repository 5
225 030916b5 2018-07-12 stsp .Sh AUTHORS
226 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
