Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 368 lines (245 sloc) 10.356 kB
a96ec4d @acaudwell Initial revision of Gource.
authored
1
2 Gource
3
c50fe93 @acaudwell changed subtitle
authored
4 software version control visualization
a96ec4d @acaudwell Initial revision of Gource.
authored
5
6 Copyright (C) 2009 Andrew Caudwell
7
0f48400 @acaudwell changed homepage url again
authored
8 http://gource.googlecode.com/
a96ec4d @acaudwell Initial revision of Gource.
authored
9
10 Contents
11 ========
12
91fdfda @acaudwell improved documentation
authored
13 1. Description
14 2. Requirements
8eb8eec @acaudwell Put installation instructions in INSTALL file.
authored
15 3. Using Gource
16 4. Copyright
91fdfda @acaudwell improved documentation
authored
17
18 1. Description
8eb8eec @acaudwell Put installation instructions in INSTALL file.
authored
19 ==============
9d6af42 @acaudwell added new line
authored
20
91fdfda @acaudwell improved documentation
authored
21 OpenGL-based 3D visualisation tool for source control repositories.
22
5699e29 @acaudwell Documenting Bazaar support.
authored
23 The repository is displayed as a tree where the root of the repository is the
24 centre, directories are branches and files are leaves. Contributors to the
25 source code appear and disappear as they contribute to specific files and
26 directories.
91fdfda @acaudwell improved documentation
authored
27
28 2. Requirements
a96ec4d @acaudwell Initial revision of Gource.
authored
29 ===============
30
5699e29 @acaudwell Documenting Bazaar support.
authored
31 Gource's display is rendered using OpenGL and requires a 3D accelerated video
32 card to run.
a96ec4d @acaudwell Initial revision of Gource.
authored
33
8eb8eec @acaudwell Put installation instructions in INSTALL file.
authored
34 3. Using Gource
a96ec4d @acaudwell Initial revision of Gource.
authored
35 ===============
36
37 gource <options> <path>
38
39 options:
40
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
41 -h, --help
5a8dbfd @acaudwell Partitioned help() message into normal and 'extended' help (viewed wi…
authored
42 Help ('-H' for extended help).
a96ec4d @acaudwell Initial revision of Gource.
authored
43
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
44 -WIDTHxHEIGHT, --viewport WIDTHxHEIGHT
45 Set the viewport size. If -f is also supplied, will attempt to set
34e413a @acaudwell -WIDTHxHEIGHT! creates a non-resizable window.
authored
46 the video mode to this also. Add ! to make the window non-resizable.
a96ec4d @acaudwell Initial revision of Gource.
authored
47
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
48 -f, --fullscreen
49 Fullscreen.
50
51 -w, --windowed
52 Windowed.
53
ad2fa86 @acaudwell Added --transparent to make the background see-through (for screensho…
authored
54 --transparent
55 Make the background transparent. Only really useful for screenshots.
56
a96ec4d @acaudwell Initial revision of Gource.
authored
57 -p, --start-position POSITION
91cc73d @acaudwell Allow -start-position random to set a random start position.
authored
58 Begin at some position in the log (between 0.0 and 1.0 or 'random').
a96ec4d @acaudwell Initial revision of Gource.
authored
59
381df27 @acaudwell Added --stop-position option.
authored
60 --stop-position POSITION
1e244cf @acaudwell Added --stop-at-end option (more intuitive than --stop-position 1.0).
authored
61 Stop (exit) at some position in the log (does not work with STDIN).
381df27 @acaudwell Added --stop-position option.
authored
62
5968867 @acaudwell Set title, change font size and colour.
authored
63 -t, --stop-at-time SECONDS
64 Stop (exit) after a specified number of seconds.
65
1e244cf @acaudwell Added --stop-at-end option (more intuitive than --stop-position 1.0).
authored
66 --stop-at-end
67 Stop (exit) at the end of the log / stream.
68
69 --loop
70 Loop back to the start of the log when the end is reached.
71
a96ec4d @acaudwell Initial revision of Gource.
authored
72 -a, --auto-skip-seconds SECONDS
5699e29 @acaudwell Documenting Bazaar support.
authored
73 Skip to next entry if nothing happens for a number of seconds.
a96ec4d @acaudwell Initial revision of Gource.
authored
74
75 -s, --seconds-per-day SECONDS
76 Speed of simulation in seconds per day.
77
fbc76f9 @acaudwell Documented --realtime option that was missing.
authored
78 --realtime
79 Realtime playback speed.
80
4bd8ed8 @acaudwell Exposed --time-scale option (previously only available interactively).
authored
81 -c, --time-scale SCALE
82 Change simulation time scale.
83
a96ec4d @acaudwell Initial revision of Gource.
authored
84 -i, --file-idle-time SECONDS
b254384 @acaudwell Allow --max-files 0 to turn off max-files limit.
authored
85 Time in seconds files remain idle before they are removed or 0
86 for no limit.
a96ec4d @acaudwell Initial revision of Gource.
authored
87
88 -e, --elasticity FLOAT
89 Elasticity of nodes.
90
ad2fa86 @acaudwell Added --transparent to make the background see-through (for screensho…
authored
91 -b, --background-colour FFFFFF
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
92 Background colour in hex.
a96ec4d @acaudwell Initial revision of Gource.
authored
93
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
94 --background-image IMAGE
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
95 Set a background image.
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
96
97 --logo IMAGE
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
98 Logo to display in the foreground.
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
99
100 --logo-offset XxY
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
101 Offset position of the logo.
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
102
5968867 @acaudwell Set title, change font size and colour.
authored
103 --title TITLE
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
104 Set a title.
5968867 @acaudwell Set title, change font size and colour.
authored
105
106 --font-size SIZE
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
107 Font size used by the date and title.
5968867 @acaudwell Set title, change font size and colour.
authored
108
109 --font-colour FFFFFF
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
110 Font colour used by the date and title in hex.
5968867 @acaudwell Set title, change font size and colour.
authored
111
745796a @acaudwell Added file extension key toggled with K key or enabled with --key.
authored
112 --key
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
113 Show file extension key.
745796a @acaudwell Added file extension key toggled with K key or enabled with --key.
authored
114
fbc76f9 @acaudwell Documented --realtime option that was missing.
authored
115 --date-format FORMAT
116 Specify display date string (strftime format).
117
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
118 --log-command VCS
b367746 @acaudwell Added mouse-over tool tips.
authored
119 Show the VCS log command used by gource (git,svn,hg,bzr,cvs2cl).
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
120
121 --log-format VCS
b367746 @acaudwell Added mouse-over tool tips.
authored
122 Specify the log format (git,svn,hg,bzr,cvs2cl,custom).
123
5156be3 @acaudwell Implemented --logo and --background-image options.
authored
124 Required when reading from STDIN.
733428a @acaudwell added --log-format command.
authored
125
3f418f1 @acaudwell Documented new commands and changes by Johannes Schindelin.
authored
126 --git-branch
127 Get the git log of a branch other than the current one.
128
a96ec4d @acaudwell Initial revision of Gource.
authored
129 --follow-user USER
130 Have the camera automatically follow a particular user.
131
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
132 --highlight-dirs
133 Highlight the names of all directories.
134
a96ec4d @acaudwell Initial revision of Gource.
authored
135 --highlight-user USER
136 Highlight the names of a particular user.
137
60392f0 @acaudwell Added --highlight-dirs option.
authored
138 --highlight-users
a96ec4d @acaudwell Initial revision of Gource.
authored
139 Highlight the names of all users.
140
7046c49 @acaudwell Added a bunch of new options:
authored
141 --highlight-colour FFFFFF
d7e53a2 @acaudwell Fixes and additions to font colouring command line options.
authored
142 Font colour for highlighted users in hex.
143
144 --selection-colour FFFFFF
145 Font colour for selected users and files.
146
147 --dir-colour FFFFFF
148 Font colour for directories.
7046c49 @acaudwell Added a bunch of new options:
authored
149
a96ec4d @acaudwell Initial revision of Gource.
authored
150 --file-filter REGEX
151 Filter out any files matching a specified regular expression.
152
61e710d @acaudwell Added --file-extensions to show filename extensions only.
authored
153 --file-extensions
154 Show filename extensions only.
155
ce07573 @acaudwell Added --user-filter REGEX option.
authored
156 --user-filter REGEX
157 Filter out any users matching a specified regular expression.
158
a96ec4d @acaudwell Initial revision of Gource.
authored
159 --user-image-dir DIRECTORY
5699e29 @acaudwell Documenting Bazaar support.
authored
160 Directory containing .jpg or .png images of users
161 (eg 'Full Name.png') to use as avatars.
a96ec4d @acaudwell Initial revision of Gource.
authored
162
163 --default-user-image IMAGE
7f10c23 @acaudwell Documented --user-image-dir flag.
authored
164 Path of .jpg or .png to use as the default user image.
a96ec4d @acaudwell Initial revision of Gource.
authored
165
166 --colour-images
167 Colourize user images.
168
b28f4ac @acaudwell Added --crop AXIS option.
authored
169 --crop AXIS
170 Crop view on an axis (vertical,horizontal).
171
2e2a418 @acaudwell More accurate camera tracking, added --padding option.
authored
172 --padding FLOAT
173 Camera view padding.
174
a96ec4d @acaudwell Initial revision of Gource.
authored
175 --multi-sampling
176 Enable multi-sampling.
177
5f20ec3 @acaudwell Added --no-vsync option.
authored
178 --no-vsync
179 Disable vsync.
180
4b17e5e @matthiaskrgr README: minor indentation change to "--bloom-multiplier FLOAT"
matthiaskrgr authored
181 --bloom-multiplier FLOAT
0e73ab1 @acaudwell Moved changes to ChangeLog file
authored
182 Adjust the amount of bloom.
183
306dd78 @acaudwell Added --bloom-intensity option.
authored
184 --bloom-intensity FLOAT
185 Adjust the intensity of the bloom.
186
a96ec4d @acaudwell Initial revision of Gource.
authored
187 --max-files
b254384 @acaudwell Allow --max-files 0 to turn off max-files limit.
authored
188 Set the maximum number of files or 0 for no limit.
189
190 Excess files will be discarded.
a96ec4d @acaudwell Initial revision of Gource.
authored
191
145e35e @acaudwell Added --max-user-speed and --user-friction and renamed --max-commit-l…
authored
192 --max-file-lag SECONDS
193 Max time files of a commit can take to appear.
194
b254384 @acaudwell Allow --max-files 0 to turn off max-files limit.
authored
195 Use -1 for no limit.
196
145e35e @acaudwell Added --max-user-speed and --user-friction and renamed --max-commit-l…
authored
197 --max-user-speed UNITS
198 Max speed users can travel per second.
199
200 --user-friction SECONDS
9445621 @acaudwell Fixed description of user-friction option.
authored
201 Time users take to come to a halt.
145e35e @acaudwell Added --max-user-speed and --user-friction and renamed --max-commit-l…
authored
202
6ebd656 @acaudwell Added --user-scale and --hide-dirnames options.
authored
203 --user-scale SCALE
204 Change scale of users.
205
f0adee4 @acaudwell Document --camera-mode option.
authored
206 --camera-mode MODE
207 Camera mode (overview,track).
208
ca5806c @acaudwell Added automatic camera rotation.
authored
209 --disable-auto-rotate
210 Disable automatic camera rotation.
211
eabf7d5 @acaudwell Added --hide option to use instead of multiple --hide-ELEMENT options.
authored
212 --hide DISPLAY_ELEMENT
a60458c @acaudwell Rewrote the '--hide DISPLAY_ELEMENT' section of the documentation.
authored
213 Hide one or more display elements from the list below:
214
215 bloom - bloom effect
216 date - current date
217 dirnames - names of directories
218 files - file icons
219 filenames - names of files
220 mouse - mouse cursor
221 progress - progress bar widget
5627a38 @acaudwell Added --hide root option to not draw branches from the root directory.
authored
222 root - root directory of tree
a60458c @acaudwell Rewrote the '--hide DISPLAY_ELEMENT' section of the documentation.
authored
223 tree - animated tree structure
224 users - user avatars
225 usernames - names of users
226
227 Separate multiple elements with commas (eg 'mouse,progress')
a96ec4d @acaudwell Initial revision of Gource.
authored
228
7046c49 @acaudwell Added a bunch of new options:
authored
229 --hash-seed SEED
230 Change the seed of hash function.
231
00fe162 @acaudwell Added -o alias for --output--ppm-stream and --fps for --output-framer…
authored
232 -o, --output-ppm-stream FILE
233 Output a PPM image stream to a file ('-' for STDOUT).
34896ba @acaudwell Document video recording options. Added bitrate
authored
234
ce07573 @acaudwell Added --user-filter REGEX option.
authored
235 This will automatically hide the progress bar initially and
236 enable 'stop-at-end' unless other behaviour is specified.
237
5a8dbfd @acaudwell Partitioned help() message into normal and 'extended' help (viewed wi…
authored
238 -r, --output-framerate FPS
00fe162 @acaudwell Added -o alias for --output--ppm-stream and --fps for --output-framer…
authored
239 Framerate of output (25,30,60). Used with --output-ppm-stream.
924452d @acaudwell Support 3 options for video framerate 25,30,60.
authored
240
7046c49 @acaudwell Added a bunch of new options:
authored
241 --output-custom-log FILE
242 Output a custom format log file ('-' for STDOUT).
243
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
244 --load-config CONFIG_FILE
ce07573 @acaudwell Added --user-filter REGEX option.
authored
245 Load a gource conf file.
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
246
247 --save-config CONFIG_FILE
ce07573 @acaudwell Added --user-filter REGEX option.
authored
248 Save a gource conf file with the current options.
e5b0ad0 @acaudwell Added save-config and load-config options.
authored
249
250 --path PATH
251
ce07573 @acaudwell Added --user-filter REGEX option.
authored
252 path Either a supported version control directory, a pre-generated log
b367746 @acaudwell Added mouse-over tool tips.
authored
253 file (see log commands or the custom log format), a Gource conf
ce07573 @acaudwell Added --user-filter REGEX option.
authored
254 file or '-' to read STDIN.
255
b6c957f @matthiaskrgr README: fix typos
matthiaskrgr authored
256 If path is omitted, gource will attempt to read a log from the
ce07573 @acaudwell Added --user-filter REGEX option.
authored
257 current directory.
a96ec4d @acaudwell Initial revision of Gource.
authored
258
174e9ba @acaudwell WIP SVN support.
authored
259 Git, Bazaar, Mercurial and SVN Examples:
a96ec4d @acaudwell Initial revision of Gource.
authored
260
b6c957f @matthiaskrgr README: fix typos
matthiaskrgr authored
261 View the log of the repository in the current path:
a96ec4d @acaudwell Initial revision of Gource.
authored
262
263 gource
264
9eabadd @acaudwell document Mercurial support
authored
265 View the log of a project in the specified directory:
a96ec4d @acaudwell Initial revision of Gource.
authored
266
267 gource my-project-dir
268
174e9ba @acaudwell WIP SVN support.
authored
269 For large projects, generating a log of the project history may take a long
270 time. For centralized VCS like SVN, generating the log may also put load on
271 the central VCS server.
a96ec4d @acaudwell Initial revision of Gource.
authored
272
174e9ba @acaudwell WIP SVN support.
authored
273 In these cases, you may like to save a copy of the log for later use.
a96ec4d @acaudwell Initial revision of Gource.
authored
274
174e9ba @acaudwell WIP SVN support.
authored
275 You can generate a log in the VCS specific log format using
276 the --log-command VCS option:
277
278 cd my-svn-project
279 `gource --log-command svn` > my-svn-project.log
280 gource my-svn-project.log
281
282 You can also have Gource write a copy of the log file in its own format:
283
284 gource --output-custom-log my-project-custom.log
a96ec4d @acaudwell Initial revision of Gource.
authored
285
b367746 @acaudwell Added mouse-over tool tips.
authored
286 CVS Support:
448b93d Add a note about SVN support via git svn to the README
Sebastian Hahn authored
287
9513dc3 @acaudwell Took out automatic log generation from calling cvs2cl directly as thi…
authored
288 Use 'cvs2cl' to generate the log and then pass it to Gource:
78085e3 @acaudwell Further changes to SVN instructions.
authored
289
b367746 @acaudwell Added mouse-over tool tips.
authored
290 cvs2cl --chrono --stdout --xml -g-q > my-cvs-project.log
291 gource my-cvs-project.log
bfb0317 @acaudwell Direct people to the homepage for support for other
authored
292
a96ec4d @acaudwell Initial revision of Gource.
authored
293 Custom Log Format:
294
5699e29 @acaudwell Documenting Bazaar support.
authored
295 If you want to use Gource with something other than the supported systems,
296 there is a pipe ('|') delimited custom log format:
a96ec4d @acaudwell Initial revision of Gource.
authored
297
298 timestamp - A unix timestamp of when the update occured.
299 username - The name of the user who made the update.
5699e29 @acaudwell Documenting Bazaar support.
authored
300 type - initial for the update type - (A)dded, (M)odified or (D)eleted.
a96ec4d @acaudwell Initial revision of Gource.
authored
301 file - Path of the file updated.
302 colour - A colour for the file in hex (FFFFFF) format. Optional.
303
4bad0ec @acaudwell Removed direct FFmpeg support.
authored
304 Recording Videos:
305
c168908 @acaudwell Defer to homepage for video recording instructions.
authored
306 See the guide on the homepage for examples of recording videos with Gource:
4bad0ec @acaudwell Removed direct FFmpeg support.
authored
307
c168908 @acaudwell Defer to homepage for video recording instructions.
authored
308 http://code.google.com/p/gource/wiki/Videos
4bad0ec @acaudwell Removed direct FFmpeg support.
authored
309
b367746 @acaudwell Added mouse-over tool tips.
authored
310 More Information:
311
312 Visit the Gource homepage for guides and examples of using Gource with various
313 version control systems:
314
315 http://code.google.com/p/gource/
316
a96ec4d @acaudwell Initial revision of Gource.
authored
317 Interface:
318
5699e29 @acaudwell Documenting Bazaar support.
authored
319 The time shown in the top left of the screen is set initially from the first
320 log entry read and is incremented according to the simulation speed
321 (--seconds-per-day).
a96ec4d @acaudwell Initial revision of Gource.
authored
322
b6c957f @matthiaskrgr README: fix typos
matthiaskrgr authored
323 Pressing SPACE at any time will pause/resume the simulation. While paused you
5699e29 @acaudwell Documenting Bazaar support.
authored
324 may use the mouse to inspect the detail of individual files and users.
a96ec4d @acaudwell Initial revision of Gource.
authored
325
326 TAB cycles through selecting the current visible users.
327
5d94c95 @acaudwell Middle mouse button now toggles the camera mode.
authored
328 The camera mode, either tracking activity or showing the entire code tree, can
329 be toggled using the Middle mouse button.
330
331 You can drag the left mouse button to manually control the camera. The right
332 mouse button rotates the view.
a96ec4d @acaudwell Initial revision of Gource.
authored
333
334 Interactive keyboard commands:
335
336 (V) Toggle camera mode
337 (C) Displays Gource logo
745796a @acaudwell Added file extension key toggled with K key or enabled with --key.
authored
338 (K) Toggle file extension key.
9b4ee0b @acaudwell M key now toggles mouse visibility.
authored
339 (M) Toggle mouse visibility
a96ec4d @acaudwell Initial revision of Gource.
authored
340 (N) Jump forward in time to next log entry.
dc25ca0 @acaudwell Pressing S randomizes colours (resolve clashes, ugly file colours).
authored
341 (S) Randomize colours.
3edfd16 @acaudwell time_scale increment tweaks and documentation.
authored
342 (+-) Adjust simulation speed.
343 (<>) Adjust time scale.
a96ec4d @acaudwell Initial revision of Gource.
authored
344 (TAB) Cycle through visible users
e11f6a1 @acaudwell Document fullscreen toggle.
authored
345
346 (Alt+Enter) Toggle Fullscreen
347
a96ec4d @acaudwell Initial revision of Gource.
authored
348 (ESC) Quit
349
8eb8eec @acaudwell Put installation instructions in INSTALL file.
authored
350 4. Copyright
a96ec4d @acaudwell Initial revision of Gource.
authored
351 ============
352
c50fe93 @acaudwell changed subtitle
authored
353 Gource - software version control visualization
a96ec4d @acaudwell Initial revision of Gource.
authored
354 Copyright (C) 2009 Andrew Caudwell <acaudwell@gmail.com>
355
356 This program is free software: you can redistribute it and/or modify
357 it under the terms of the GNU General Public License as published by
358 the Free Software Foundation, either version 3 of the License, or
359 (at your option) any later version.
360
361 This program is distributed in the hope that it will be useful,
362 but WITHOUT ANY WARRANTY; without even the implied warranty of
363 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
364 GNU General Public License for more details.
365
366 You should have received a copy of the GNU General Public License
367 along with this program. If not, see <http://www.gnu.org/licenses/>.
Something went wrong with that request. Please try again.