### Gource Command-Line Usage Syntax Source: https://github.com/acaudwell/gource/blob/master/README.md Illustrates the basic command-line syntax for running Gource, including placeholders for optional parameters and the target repository path. ```Shell gource [options] [path] ``` -------------------------------- ### Gource CLI Options Source: https://github.com/acaudwell/gource/blob/master/README.md A complete list of command-line arguments for Gource, detailing their purpose, accepted values, and effects on the visualization. ```APIDOC --git-branch description: Get the git log of a branch other than the current one. ``` ```APIDOC --follow-user USER description: Have the camera automatically follow a particular user. ``` ```APIDOC --highlight-dirs description: Highlight the names of all directories. ``` ```APIDOC --highlight-user USER description: Highlight the names of a particular user. ``` ```APIDOC --highlight-users description: Highlight the names of all users. ``` ```APIDOC --highlight-colour FFFFFF description: Font colour for highlighted users in hex. ``` ```APIDOC --selection-colour FFFFFF description: Font colour for selected users and files. ``` ```APIDOC --filename-colour FFFFFF description: Font colour for filenames. ``` ```APIDOC --dir-colour FFFFFF description: Font colour for directories. ``` ```APIDOC --dir-name-depth DEPTH description: Draw names of directories down to a specific depth in the tree. ``` ```APIDOC --dir-name-position FLOAT description: Position along edge of the directory name (between 0.1 and 1.0, default is 0.5). ``` ```APIDOC --filename-time SECONDS description: Duration to keep filenames on screen (>= 2.0). ``` ```APIDOC --file-extensions description: Show filename extensions only. ``` ```APIDOC --file-extension-fallback description: Use filename as extension if the extension is missing or empty. ``` ```APIDOC --file-filter REGEX description: Filter out file paths matching the specified regular expression. ``` ```APIDOC --file-show-filter REGEX description: Show only file paths matching the specified regular expression. ``` ```APIDOC --user-filter REGEX description: Filter usernames matching the specified regular expression. ``` ```APIDOC --user-show-filter REGEX description: Show only usernames matching the specified regular expression. ``` ```APIDOC --user-image-dir DIRECTORY description: Directory containing .jpg or .png images of users (eg "Full Name.png") to use as avatars. ``` ```APIDOC --default-user-image IMAGE description: Path of .jpg or .png to use as the default user image. ``` ```APIDOC --fixed-user-size description: Forces the size of the user image to remain fixed throughout. ``` ```APIDOC --colour-images description: Colourize user images. ``` ```APIDOC --crop AXIS description: Crop view on an axis (vertical,horizontal). ``` ```APIDOC --padding FLOAT description: Camera view padding. ``` ```APIDOC --multi-sampling description: Enable multi-sampling. ``` ```APIDOC --no-vsync description: Disable vsync. ``` ```APIDOC --bloom-multiplier FLOAT description: Adjust the amount of bloom. ``` ```APIDOC --bloom-intensity FLOAT description: Adjust the intensity of the bloom. ``` ```APIDOC --max-files NUMBER description: Set the maximum number of files or 0 for no limit. Excess files will be discarded. ``` ```APIDOC --max-file-lag SECONDS description: Max time files of a commit can take to appear. Use -1 for no limit. ``` ```APIDOC --max-user-speed UNITS description: Max speed users can travel per second. ``` ```APIDOC --user-friction SECONDS description: Time users take to come to a halt. ``` ```APIDOC --user-scale SCALE description: Change scale of user avatars. ``` ```APIDOC --camera-mode MODE description: Camera mode (overview,track). ``` ```APIDOC --disable-auto-rotate description: Disable automatic camera rotation. ``` ```APIDOC --disable-input description: Disable keyboard and mouse input. ``` ```APIDOC --hide DISPLAY_ELEMENT description: Hide one or more display elements from the list below: DISPLAY_ELEMENT: bloom - bloom effect date - current date dirnames - names of directories files - file icons filenames - names of files mouse - mouse cursor progress - progress bar widget root - root directory of tree tree - animated tree structure users - user avatars usernames - names of users Note: Separate multiple elements with commas (eg "mouse,progress") ``` ```APIDOC --hash-seed SEED description: Change the seed of hash function. ``` ```APIDOC --caption-file FILE description: Caption file (see Caption Log Format). ``` ```APIDOC --caption-size SIZE description: Caption size. ``` ```APIDOC --caption-colour FFFFFF description: Caption colour in hex. ``` ```APIDOC --caption-duration SECONDS description: Caption duration. ``` ```APIDOC --caption-offset X description: Caption horizontal offset (0 to centre captions). ``` ```APIDOC -o, --output-ppm-stream FILE description: Output a PPM image stream to a file ('-' for STDOUT). Note: This will automatically hide the progress bar initially and enable 'stop-at-end' unless other behaviour is specified. ``` ```APIDOC -r, --output-framerate FPS description: Framerate of output (25,30,60). Note: Used with --output-ppm-stream. ``` ```APIDOC --output-custom-log FILE description: Output a custom format log file ('-' for STDOUT). ``` ```APIDOC --load-config CONFIG_FILE description: Load a gource conf file. ``` ```APIDOC --save-config CONFIG_FILE description: Save a gource conf file with the current options. ``` ```APIDOC --path PATH description: Either a supported version control directory, a pre-generated log file (see log commands or the custom log format), a Gource conf file or '-' to read STDIN. ``` -------------------------------- ### Gource Command-Line Options Reference Source: https://github.com/acaudwell/gource/blob/master/README.md A comprehensive reference of all available command-line options for Gource, detailing their purpose, accepted values, and impact on the visualization. ```APIDOC gource [options] [path] options: -h, --help Help ('-H' for extended help). -WIDTHxHEIGHT, --viewport WIDTHxHEIGHT Set the viewport size. If -f is also supplied, will attempt to set the video mode to this also. Add ! to make the window non-resizable. --screen SCREEN Set the number of the screen to display on. --high-dpi Request a high DPI display when creating the window. On some platforms such as MacOS, the window resolution is specified in points instead of pixels. The --high-dpi flag may be required to access some higher resolutions. E.g. requesting a high DPI 800x600 window may produce a window that is 1600x1200 pixels. --window-position XxY Initial window position on your desktop which may be made up of multiple monitors. This will override the screen setting so don't specify both. --frameless Frameless window. -f, --fullscreen Fullscreen. -w, --windowed Windowed. --transparent Make the background transparent. Only really useful for screenshots. --start-date "YYYY-MM-DD hh:mm:ss +tz" Start with the first entry after the supplied date and optional time. If a time zone offset isn't specified the local time zone is used. Example accepted formats: "2012-06-30" "2012-06-30 12:00" "2012-06-30 12:00:00 +12" --stop-date "YYYY-MM-DD hh:mm:ss +tz" Stop after the last entry prior to the supplied date and optional time. Uses the same format as --start-date. -p, --start-position POSITION Begin at some position in the log (between 0.0 and 1.0 or 'random'). --stop-position POSITION Stop (exit) at some position in the log (does not work with STDIN). -t, --stop-at-time SECONDS Stop (exit) after a specified number of seconds. --stop-at-end Stop (exit) at the end of the log / stream. --loop Loop back to the start of the log when the end is reached. --loop-delay-seconds Seconds to delay before looping. -a, --auto-skip-seconds SECONDS Skip to next entry if nothing happens for a number of seconds. -s, --seconds-per-day SECONDS Speed of simulation in seconds per day. --realtime Realtime playback speed. --no-time-travel Use the time of the last commit if the time of a commit is in the past. --author-time Use the timestamp of the author instead of the timestamp of the committer. -c, --time-scale SCALE Change simulation time scale. This affects the movement speed of user avatars. E.g. 0.5 for half speed, 2 for double speed. -i, --file-idle-time SECONDS Time in seconds files remain idle before they are removed or 0 for no limit. --file-idle-time-at-end SECONDS Time in seconds files remain idle at the end before they are removed. -e, --elasticity FLOAT Elasticity of nodes. -b, --background-colour FFFFFF Background colour in hex. --background-image IMAGE Set a background image. --logo IMAGE Logo to display in the foreground. --logo-offset XxY Offset position of the logo. --title TITLE Set a title. --font-file FILE Specify the font. Should work with most font file formats supported by FreeType, such as TTF and OTF, among others. --font-scale SCALE Scale the size of all fonts. --font-size SIZE Font size used by the date and title. --file-font-size SIZE Font size of filenames. --dir-font-size SIZE Font size of directory names --user-font-size SIZE Font size of user names. --font-colour FFFFFF Font colour used by the date and title in hex. --key Show file extension key. --date-format FORMAT Specify display date string (strftime format). --log-command VCS Show the VCS log command used by gource (git,svn,hg,bzr,cvs2cl). --log-format VCS Specify the log format (git,svn,hg,bzr,cvs2cl,custom). ``` -------------------------------- ### Gource Interactive Keyboard Commands Source: https://github.com/acaudwell/gource/blob/master/README.md This section lists the keyboard shortcuts available during a Gource simulation for controlling the view, display options, and playback. These commands allow users to interact with the visualization in real-time. ```APIDOC (V) Toggle camera mode (C) Displays Gource logo (K) Toggle file extension key (M) Toggle mouse visibility (N) Jump forward in time to next log entry (S) Randomize colours (D) Toggle directory name display mode (F) Toggle file name display mode (U) Toggle user name display mode (G) Toggle display of users (T) Toggle display of directory tree edges (R) Toggle display of root directory edges (<>) Adjust time scale / user avatar movement speed (+\-) Adjust simulation speed (Keypad +\-) Adjust camera zoom (TAB) Cycle through visible users (F12) Screenshot (Alt+Enter) Fullscreen toggle (ESC) Quit ``` -------------------------------- ### Generate and View SVN Log with Gource Source: https://github.com/acaudwell/gource/blob/master/README.md For large SVN projects, generating the log directly can be slow or taxing on the server. This sequence of commands first generates a VCS-specific log file using Gource's `--log-command svn` option, saves it to `my-svn-project.log`, and then visualizes the saved log with Gource, enabling offline viewing and reducing server load. ```Shell cd my-svn-project `gource --log-command svn` > my-svn-project.log gource my-svn-project.log ``` -------------------------------- ### Generate and View CVS Log with Gource Source: https://github.com/acaudwell/gource/blob/master/README.md To use Gource with CVS, which is not directly supported, this command sequence first uses `cvs2cl` to generate a chronological, XML-formatted log, redirects it to `my-cvs-project.log`, and then visualizes that log file with Gource. ```Shell cvs2cl --chrono --stdout --xml -g-q > my-cvs-project.log gource my-cvs-project.log ``` -------------------------------- ### View Gource Log for a Specific Project Directory Source: https://github.com/acaudwell/gource/blob/master/README.md This command runs Gource to visualize the version control history of the repository found in the specified directory path, allowing you to visualize projects not in the current working directory. ```Shell gource my-project-dir ``` -------------------------------- ### View Gource Log in Current Directory Source: https://github.com/acaudwell/gource/blob/master/README.md This command runs Gource to visualize the version control history of the repository located in the current working directory. If no path is specified, Gource attempts to read a log from the current directory. ```Shell gource ``` -------------------------------- ### Output Gource Log in Custom Format Source: https://github.com/acaudwell/gource/blob/master/README.md This command instructs Gource to write a copy of the project's history log into a specified file (`my-project-custom.log`) using Gource's own internal log format. This can be useful for archiving or further processing. ```Shell gource --output-custom-log my-project-custom.log ``` -------------------------------- ### Gource Caption Log File Format Specification Source: https://github.com/acaudwell/gource/blob/master/README.md This section details the pipe-delimited format for caption files, which Gource uses to display text captions along the timeline. Captions are displayed at specific timestamps and can be used to highlight events or provide context during the visualization. ```APIDOC timestamp - An ISO 8601 or A unix timestamp of when to display the caption. caption - The caption ``` -------------------------------- ### Gource Custom Log File Format Specification Source: https://github.com/acaudwell/gource/blob/master/README.md This section describes the pipe-delimited custom log format that Gource can parse. It allows users to integrate Gource with unsupported version control systems or custom data sources by providing data in this specific structure. ```APIDOC timestamp - An ISO 8601 or unix timestamp of when the update occurred. username - The name of the user who made the update. type - initial for the update type - (A)dded, (M)odified or (D)eleted. file - Path of the file updated. colour - A colour for the file in hex (FFFFFF) format. Optional. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.