1 030916b5 2018-07-12 stsp .\"
  2 030916b5 2018-07-12 stsp .\" Copyright (c) 2018 Stefan Sperling
  3 030916b5 2018-07-12 stsp .\"
  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.
  7 030916b5 2018-07-12 stsp .\"
  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.
 15 030916b5 2018-07-12 stsp .\"
 16 030916b5 2018-07-12 stsp .Dd $Mdocdate$
 17 030916b5 2018-07-12 stsp .Dt TOG 1
 18 030916b5 2018-07-12 stsp .Os
 19 030916b5 2018-07-12 stsp .Sh NAME
 20 030916b5 2018-07-12 stsp .Nm tog
 21 030916b5 2018-07-12 stsp .Nd git repository browser
 22 030916b5 2018-07-12 stsp .Sh SYNOPSIS
 23 030916b5 2018-07-12 stsp .Nm
 24 030916b5 2018-07-12 stsp .Ar command
 25 030916b5 2018-07-12 stsp .Op Fl h
 26 030916b5 2018-07-12 stsp .Op Ar arg ...
 27 030916b5 2018-07-12 stsp .Sh DESCRIPTION
 28 030916b5 2018-07-12 stsp .Nm
 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 030916b5 2018-07-12 stsp .Xr got-repository 5 .
 32 030916b5 2018-07-12 stsp .Pp
 33 030916b5 2018-07-12 stsp .Nm
 34 030916b5 2018-07-12 stsp provides global and command-specific options.
 35 030916b5 2018-07-12 stsp Global options must preceed the command name, and are as follows:
 36 030916b5 2018-07-12 stsp .Bl -tag -width tenletters
 37 030916b5 2018-07-12 stsp .It Fl h
 38 030916b5 2018-07-12 stsp Display usage information.
 39 030916b5 2018-07-12 stsp .El
 40 030916b5 2018-07-12 stsp .Pp
 41 030916b5 2018-07-12 stsp The commands for
 42 030916b5 2018-07-12 stsp .Nm
 43 030916b5 2018-07-12 stsp are as follows:
 44 030916b5 2018-07-12 stsp .Bl -tag -width blame
 45 030916b5 2018-07-12 stsp .It Cm log [ Fl c Ar commit ] [ Ar repository-path ]
 46 030916b5 2018-07-12 stsp Display history of a repository.
 47 030916b5 2018-07-12 stsp If the
 48 030916b5 2018-07-12 stsp .Ar repository path
 49 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
 50 030916b5 2018-07-12 stsp .Pp
 51 030916b5 2018-07-12 stsp This command is also executed if no explicit command is specified.
 52 030916b5 2018-07-12 stsp .Pp
 53 030916b5 2018-07-12 stsp The key bindings for
 54 030916b5 2018-07-12 stsp .Cm tog log
 55 030916b5 2018-07-12 stsp are as follows:
 56 030916b5 2018-07-12 stsp .Bl -tag -width Ds
 57 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
 58 030916b5 2018-07-12 stsp Move the selection cursor down.
 59 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
 60 030916b5 2018-07-12 stsp Move the selection cursor up.
 61 030916b5 2018-07-12 stsp .It Cm Enter
 62 030916b5 2018-07-12 stsp Switch to the
 63 030916b5 2018-07-12 stsp .Cm diff
 64 030916b5 2018-07-12 stsp view showing file changes made in the currently selected commit.
 65 030916b5 2018-07-12 stsp .It Cm t
 66 030916b5 2018-07-12 stsp Switch to the
 67 030916b5 2018-07-12 stsp .Cm tree
 68 030916b5 2018-07-12 stsp view showing the tree for the currently selected commit.
 69 030916b5 2018-07-12 stsp .It Cm q
 70 030916b5 2018-07-12 stsp Quit the
 71 030916b5 2018-07-12 stsp .Cm log
 72 030916b5 2018-07-12 stsp view.
 73 030916b5 2018-07-12 stsp .El
 74 030916b5 2018-07-12 stsp .Pp
 75 030916b5 2018-07-12 stsp The options for
 76 030916b5 2018-07-12 stsp .Cm tog log
 77 030916b5 2018-07-12 stsp are as follows:
 78 030916b5 2018-07-12 stsp .Bl -tag -width Ds
 79 030916b5 2018-07-12 stsp .It Fl c Ar commit
 80 030916b5 2018-07-12 stsp Start traversing history at the specified
 81 030916b5 2018-07-12 stsp .Ar commit .
 82 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
 83 030916b5 2018-07-12 stsp to a commit object.
 84 030916b5 2018-07-12 stsp .El
 85 030916b5 2018-07-12 stsp .It Cm diff [ Ar repository-path ] Ar object1 Ar object2
 86 030916b5 2018-07-12 stsp Display the differences between two objects in the repository.
 87 030916b5 2018-07-12 stsp Each
 88 030916b5 2018-07-12 stsp .Ar object
 89 030916b5 2018-07-12 stsp argument is a SHA1 hash which corresponds to the object.
 90 030916b5 2018-07-12 stsp Both objects must be of the same type (blobs, trees, or commits).
 91 030916b5 2018-07-12 stsp If the
 92 030916b5 2018-07-12 stsp .Ar repository path
 93 030916b5 2018-07-12 stsp is omitted, use the current working directory.
 94 030916b5 2018-07-12 stsp .Pp
 95 030916b5 2018-07-12 stsp The key bindings for
 96 030916b5 2018-07-12 stsp .Cm tog diff
 97 030916b5 2018-07-12 stsp are as follows:
 98 030916b5 2018-07-12 stsp .Bl -tag -width Ds
 99 dccb68cb 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
100 030916b5 2018-07-12 stsp Scroll down.
101 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
102 030916b5 2018-07-12 stsp Scroll up.
103 030916b5 2018-07-12 stsp .It Cm q
104 030916b5 2018-07-12 stsp Quit the
105 030916b5 2018-07-12 stsp .Cm diff
106 030916b5 2018-07-12 stsp view.
107 030916b5 2018-07-12 stsp .El
108 030916b5 2018-07-12 stsp .It Cm blame [ Fl c Ar commit ] [ Ar repository-path ] Ar path
109 030916b5 2018-07-12 stsp Display line-by-line history of a file at the specified path.
110 030916b5 2018-07-12 stsp If the
111 030916b5 2018-07-12 stsp .Ar repository path
112 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
113 030916b5 2018-07-12 stsp .Pp
114 030916b5 2018-07-12 stsp The key bindings for
115 030916b5 2018-07-12 stsp .Cm tog blame
116 030916b5 2018-07-12 stsp are as follows:
117 030916b5 2018-07-12 stsp .Bl -tag -width Ds
118 38f94530 2018-07-12 stsp .It Cm Down-arrow, j, Page-down, Space
119 030916b5 2018-07-12 stsp Move the selection cursor down.
120 38f94530 2018-07-12 stsp .It Cm Up-arrow, k, Page-up, Backspace
121 030916b5 2018-07-12 stsp Move the selection cursor up.
122 030916b5 2018-07-12 stsp .It Cm Enter
123 030916b5 2018-07-12 stsp Switch to the
124 030916b5 2018-07-12 stsp .Cm diff
125 030916b5 2018-07-12 stsp view for the currently selected line's commit.
126 030916b5 2018-07-12 stsp .It Cm b
127 030916b5 2018-07-12 stsp Show the
128 030916b5 2018-07-12 stsp .Cm blame
129 030916b5 2018-07-12 stsp view for the version of the file in the currently selected line's commit.
130 7a2921f9 2018-07-12 stsp .It Cm p
131 7a2921f9 2018-07-12 stsp Show the
132 7a2921f9 2018-07-12 stsp .Cm blame
133 7a2921f9 2018-07-12 stsp view for the version of the file in the currently selected line's commit's
134 7a2921f9 2018-07-12 stsp parent commit.
135 030916b5 2018-07-12 stsp .It Cm B
136 030916b5 2018-07-12 stsp Switch the
137 030916b5 2018-07-12 stsp .Cm blame
138 030916b5 2018-07-12 stsp view back to the previously blamed commit.
139 030916b5 2018-07-12 stsp .It Cm q
140 030916b5 2018-07-12 stsp Quit the
141 030916b5 2018-07-12 stsp .Cm diff
142 030916b5 2018-07-12 stsp view.
143 030916b5 2018-07-12 stsp .El
144 030916b5 2018-07-12 stsp .Pp
145 030916b5 2018-07-12 stsp The options for
146 030916b5 2018-07-12 stsp .Cm tog blame
147 030916b5 2018-07-12 stsp are as follows:
148 030916b5 2018-07-12 stsp .Bl -tag -width Ds
149 030916b5 2018-07-12 stsp .It Fl c Ar commit
150 030916b5 2018-07-12 stsp Start traversing history at the specified
151 030916b5 2018-07-12 stsp .Ar commit .
152 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
153 030916b5 2018-07-12 stsp to a commit object.
154 030916b5 2018-07-12 stsp .El
155 030916b5 2018-07-12 stsp .It Cm tree [ Fl c Ar commit ] [ Ar repository-path ]
156 030916b5 2018-07-12 stsp Display the repository tree.
157 030916b5 2018-07-12 stsp If the
158 030916b5 2018-07-12 stsp .Ar repository path
159 030916b5 2018-07-12 stsp is omitted, assume the repository is located in the current working directory.
160 030916b5 2018-07-12 stsp .Pp
161 030916b5 2018-07-12 stsp The key bindings for
162 030916b5 2018-07-12 stsp .Cm tog tree
163 030916b5 2018-07-12 stsp are as follows:
164 030916b5 2018-07-12 stsp .Bl -tag -width Ds
165 030916b5 2018-07-12 stsp .It Cm Down-arrow, j, Page-down
166 030916b5 2018-07-12 stsp Move the selection cursor down.
167 030916b5 2018-07-12 stsp .It Cm Up-arrow, k, Page-up
168 030916b5 2018-07-12 stsp Move the selection cursor up.
169 030916b5 2018-07-12 stsp .It Cm Enter
170 030916b5 2018-07-12 stsp Enter the currently selected directory, or switch to the
171 030916b5 2018-07-12 stsp .Cm blame
172 030916b5 2018-07-12 stsp view for the currently selected file.
173 030916b5 2018-07-12 stsp .It Cm Backspace
174 030916b5 2018-07-12 stsp Move back to the parent directory.
175 030916b5 2018-07-12 stsp .It Cm i
176 030916b5 2018-07-12 stsp Show the object IDs for all objects displayed in the
177 030916b5 2018-07-12 stsp .Cm tree
178 030916b5 2018-07-12 stsp view.
179 030916b5 2018-07-12 stsp .El
180 030916b5 2018-07-12 stsp .Pp
181 030916b5 2018-07-12 stsp The options for
182 030916b5 2018-07-12 stsp .Cm tog tree
183 030916b5 2018-07-12 stsp are as follows:
184 030916b5 2018-07-12 stsp .Bl -tag -width Ds
185 030916b5 2018-07-12 stsp .It Fl c Ar commit
186 030916b5 2018-07-12 stsp Start traversing history at the specified
187 030916b5 2018-07-12 stsp .Ar commit .
188 030916b5 2018-07-12 stsp The expected argument is the name of a branch or a SHA1 hash which corresponds
189 030916b5 2018-07-12 stsp to a commit object.
190 030916b5 2018-07-12 stsp .El
191 030916b5 2018-07-12 stsp .El
192 030916b5 2018-07-12 stsp .Sh EXIT STATUS
193 030916b5 2018-07-12 stsp .Ex -std tog
194 030916b5 2018-07-12 stsp .Sh SEE ALSO
195 030916b5 2018-07-12 stsp .Xr got-repository 5
196 030916b5 2018-07-12 stsp .Sh AUTHORS
197 030916b5 2018-07-12 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org