Each object is identified by a SHA1 hash calculated over both the object's header and the data stored in the object.

A loose object file begins with a header which specifies the type - of object as an ASCII string, followed by an ASCII space character, followed - by the object data's size encoded as an ASCII number string. The header is - terminated by a NUL character, and the remainder of the - file contains object data. Loose objects files are compressed with - deflate(3).

A loose object file begins with a header which specifies + the type of object as an ASCII string, followed by an ASCII space character, + followed by the object data's size encoded as an ASCII number string. The + header is terminated by a + NUL character, and + the remainder of the file contains object data. Loose objects files are + compressed with deflate(3).

Multiple objects can be bundled in a pack file for better disk space efficiency and increased run-time performance. The pack file format introduces two additional types of objects:

DESCRIPTION

A Got work tree stores a file hierarchy which - corresponds to a versioned snapshot stored in a Git repository. The work - tree's meta data is stored in the .got directory. A - work tree is created with got checkout and is - required to make changes to a Git repository with - got(1).

A work tree stores the path to its Git repository, the name of a - reference to the branch which files were checked out from, and the ID of a - commit on this branch known as the base commit.

File meta-data is stored in a structured file called the - file index which tracks the status of file modifications, - additions, and deletions, relative to the base commit in the repository. The - file index contains a series of records, and each such record contains the - following status information for a particular file:

A Got + work tree + stores a file hierarchy which corresponds to a versioned snapshot stored in + a Git repository. The work tree's meta data is stored in the + .got directory. A work tree is created with + got checkout and is required to make changes to a + Git repository with got(1).

A work tree stores the path to its Git repository, the + name of a reference to the branch which files were checked out from, and the + ID of a commit on this branch known as the + base commit.

File meta-data is stored in a structured file called the + file index which + tracks the status of file modifications, additions, and deletions, relative + to the base commit in the repository. The file index contains a series of + records, and each such record contains the following status information for + a particular file:

Copy of filesystem meta-data

Timestamp, file size, and file ownership information from @@ -174,8 +177,8 @@ - - + +

May 5, 2020

OpenBSD 6.6

July 23, 2020

OpenBSD 6.7

blob - 0e6883a20a149c898bb9d3d28ae22cd7a2f80613 blob + 39ba9dee00a41c6c57aba336efae0fda5d8d721b --- got.1.html +++ got.1.html @@ -65,24 +65,25 @@ version control system because every copy of a repository is writeable. Modifications made to files can be synchronized between repositories at any time.

Files managed by got must be checked out - from the repository for modification. Checked out files are stored in a - work tree which can be placed at an arbitrary directory in - the filesystem hierarchy. The on-disk format of this work tree is described - in got-worktree(5).

Files managed by got must be + checked out from the repository for modification. Checked out files are + stored in a work + tree which can be placed at an arbitrary directory in the filesystem + hierarchy. The on-disk format of this work tree is described in + got-worktree(5).

got provides global and command-specific options. Global options must precede the command name, and are as follows:

-h
-h: Display usage information and exit immediately.
-V, +
-V, --version: Display program version and exit immediately.

The commands for got are as follows:

init +
init repository-path: Create a new empty repository at the specified repository-path. @@ -91,9 +92,9 @@ empty repository before got checkout can be used.
in
in: Short alias for init.
import +
import [-b branch] [-m message] [-r repository-path] @@ -114,22 +115,22 @@ The options for got import are as follows: - -b + -b branch Create the specified branch instead of creating the default branch “main”. Use of this option is required if the “main” branch already exists. - -m + -m message Use the specified log message when creating the new commit. Without the -m option, got import opens a temporary file in an editor where a log message can be written. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. - -I + -I pattern Ignore files or directories with a name which matches the specified pattern. This option may be specified multiple @@ -138,9 +139,9 @@ glob(7).

im

Short alias for import.

clone +

clone [-a] [-b branch] [-l] [-m] [-q] @@ -186,13 +187,13 @@ The options for got clone are as follows: - -a + -a Fetch all branches from the remote repository's “refs/heads/” reference namespace. If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the -b option. - -b + -b branch Fetch the specified branch from the remote repository's “refs/heads/” reference namespace. This @@ -203,11 +204,11 @@ not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the -a option. - -l + -l List branches and tags available for fetching from the remote repository and exit immediately. Cannot be used together with any of the other options except -v. - -m + -m Create the cloned repository as a mirror of the original repository. This is useful if the cloned repository will not be used to store locally created commits. @@ -225,15 +226,15 @@ changes will be at risk of being discarded whenever incoming changes are fetched. - -q + -q Suppress progress reporting output. The same option will be passed to ssh(1) if applicable. - -v + -v Verbose mode. Causes got clone to print debugging messages to standard error output. This option will be passed to ssh(1) if applicable. Multiple -v options increase the verbosity. The maximum is 3. - -R + -R reference In addition to the branches and tags that will be fetched, fetch an arbitrary reference from the remote repository's @@ -254,9 +255,9 @@ -

cl

Short alias for clone.

fetch +

fetch [-a] [-b branch] [-d] [-l] [-r @@ -293,13 +294,13 @@ The options for got fetch are as follows: - -a + -a Fetch all branches from the remote repository's “refs/heads/” reference namespace. If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the -b option. - -b + -b branch Fetch the specified branch from the remote repository's “refs/heads/” reference namespace. This @@ -307,36 +308,36 @@ fetch. If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the -a option. - -d + -d Delete branches and tags from the local repository which are no longer present in the remote repository. Only references are deleted. Any commit, tree, tag, and blob objects belonging to deleted branches or tags remain in the repository and may be removed separately with Git's garbage collector. - -l + -l List branches and tags available for fetching from the remote repository and exit immediately. Cannot be used together with any of the other options except -v and -r. - -t + -t Allow existing references in the “refs/tags” namespace to be updated if they have changed on the server. If not specified, only new tag references will be created. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -q + -q Suppress progress reporting output. The same option will be passed to ssh(1) if applicable. - -v + -v Verbose mode. Causes got fetch to print debugging messages to standard error output. The same option will be passed to ssh(1) if applicable. Multiple -v options increase the verbosity. The maximum is 3. - -R + -R reference In addition to the branches and tags that will be fetched, fetch an arbitrary reference from the remote repository's @@ -360,9 +361,9 @@ -

fe

Short alias for fetch.

checkout +

checkout [-E] [-b branch] [-c commit] [-p @@ -387,16 +388,16 @@ The options for got checkout are as follows: - -E + -E Proceed with the checkout operation even if the directory at work-tree-path is not empty. Existing files will be left intact. - -b + -b branch Check out files from a commit on the specified branch. If this option is not specified, a branch resolved via the repository's HEAD reference will be used. - -c + -c commit Check out files from the specified commit on the selected branch. The expected argument is a commit ID SHA1 hash or an @@ -413,16 +414,16 @@ got checkout can be used. Checking out work trees with an unknown branch is intentionally not supported. - -p + -p path-prefix Restrict the work tree to a subset of the repository's tree hierarchy. Only files beneath the specified path-prefix will be checked out. -

co

Short alias for checkout.

update +

update [-b branch] [-c commit] [path ...]

The options for got update are as follows:

-b +
-b branch: Switch the work tree's branch reference to the specified branch before updating the work tree. This @@ -506,7 +507,7 @@ got commit, or could be discarded with got revert.
-c +
-c commit: Update the work tree to the specified commit. The expected argument is a commit ID SHA1 hash or an existing @@ -517,9 +518,9 @@ be used.

up

Short alias for update.

status +

status [path ...]

Show the current modification status of files in a work tree, using the following status codes: @@ -610,9 +611,9 @@ gives no special significance to the location of path component separators, “/”, in a pattern.

st

Short alias for status.

log +

log [-b] [-c commit] [-C number] [-l @@ -631,11 +632,11 @@ The options for got log are as follows: - -b + -b Display individual commits which were merged into the current branch from other branches. By default, got log shows the linear history of the current branch only. - -c + -c commit Start traversing history at the specified commit. The expected argument is a commit ID @@ -645,23 +646,23 @@ this option is not specified, default to the work tree's current branch if invoked in a work tree, or to the repository's HEAD reference. - -C + -C number Set the number of context lines shown in diffs with -p. By default, 3 lines of context are shown. - -l + -l N Limit history traversal to a given number of commits. If this option is not specified, a default limit value of zero is used, which is treated as an unbounded limit. The GOT_LOG_DEFAULT_LIMIT environment variable may be set to change this default value. - -p + -p Display the patch of modifications made in each commit. If a path is specified, only show the patch of modifications at or within this path. - -P + -P Display the list of file paths changed in each commit, using the following status codes: @@ -683,23 +684,23 @@ - -s + -s search-pattern If specified, show only commits with a log message matched by the extended regular expression search-pattern. When used together with -P then the file paths changed by a commit can be matched as well. Regular expression syntax is documented in re_format(7). - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -R + -R Determine a set of commits to display as usual, but display these commits in reverse order. - -x + -x commit Stop traversing commit history as soon as the specified commit has been traversed. This option has no @@ -707,7 +708,7 @@ traversed. -

diff +

diff [-C number] [-r repository-path] [-s] [-w] @@ -725,27 +726,27 @@ The options for got diff are as follows: - -C + -C number Set the number of context lines shown in the diff. By default, 3 lines of context are shown. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -s + -s Show changes staged with got stage instead of showing local changes in the work tree. This option is only valid when got diff is invoked in a work tree. - -w + -w Ignore whitespace-only changes. -

di

Short alias for diff.

blame +

blame [-c commit] [-r repository-path] path

The options for got blame are as follows:

-c +
-c commit: Start traversing history at the specified commit. The expected argument is a commit ID @@ -761,7 +762,7 @@ to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique.
-r +
-r repository-path: Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If @@ -769,9 +770,9 @@ repository path associated with this work tree.

bl

Short alias for blame.

tree +

tree [-c commit] [-r repository-path] [-i] [-R] @@ -797,13 +798,15 @@ entry is a Git submodule + Symbolic link entries are also annotated with the target path + of the link. If no path is specified, list the repository path corresponding to the current directory of the work tree, or the root directory of the repository if there is no work tree. The options for got tree are as follows: - -c + -c commit List files and directories as they appear in the specified commit. The expected argument is a commit ID @@ -811,22 +814,22 @@ to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -i + -i Show object IDs of files (blob objects) and directories (tree objects). - -R + -R Recurse into sub-directories in the repository. -

tr

Short alias for tree.

ref +

ref [-r repository-path] [-l] [-c object] [-s @@ -840,20 +843,20 @@ The options for got ref are as follows: - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -l + -l List references in the repository. If no name is specified, list all existing references in the repository. If name is a reference namespace, list all references in this namespace. Otherwise, show only the reference with the given name. Cannot be used together with any other options except -r. - -c + -c object Create a reference or change an existing reference. The reference with the specified name will point at the specified @@ -863,7 +866,7 @@ corresponding commit, tree, tag, or blob object. Cannot be used together with any other options except -r. - -s + -s reference Create a symbolic reference, or change an existing symbolic reference. The symbolic reference with the specified name @@ -872,13 +875,13 @@ loops between references when this option is used. Cannot be used together with any other options except -r. - -d + -d Delete the reference with the specified name from the repository. Cannot be used together with any other options except -r. -

branch +

branch [-c commit] [-r repository-path] [-l] [-d @@ -935,20 +938,20 @@ The options for got branch are as follows: - -c + -c commit Make a newly created branch reference point at the specified commit. The expected commit argument is a commit ID SHA1 hash or an existing reference or tag name which will be resolved to a commit ID. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -l + -l List all existing branches in the repository. If invoked in a work tree, the work tree's current branch is shown with one the following annotations: @@ -963,20 +966,20 @@ - -d + -d name Delete the branch with the specified name from the repository. Only the branch reference is deleted. Any commit, tree, and blob objects belonging to the branch remain in the repository and may be removed separately with Git's garbage collector. - -n + -n Do not switch and update the work tree after creating a new branch. -

br

Short alias for branch.

tag +

tag [-c commit] [-m message] [-r repository-path] @@ -997,7 +1000,7 @@ The options for got tag are as follows: - -c + -c commit Make the newly created tag reference point at the specified commit. The expected @@ -1005,19 +1008,19 @@ existing reference or tag name which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. - -m + -m message Use the specified tag message when creating the new tag. Without the -m option, got tag opens a temporary file in an editor where a tag message can be written. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -l + -l List all existing tags in the repository instead of creating a new tag. If this option is used, no other command-line arguments are allowed. @@ -1028,7 +1031,7 @@ reference. This should only be done if the tag has not already been copied to another repository. - add + add [-R] [-I] path ... Schedule unversioned files in a work tree for addition to the repository @@ -1036,16 +1039,16 @@ The options for got add are as follows: - -R + -R Permit recursion into directories. If this option is not specified, got add will refuse to run if a specified path is a directory. - -I + -I With -R, add files even if they match a got status ignore pattern. - remove + remove [-f] [-k] [-R] path ... Remove versioned files from a work tree and schedule them for deletion @@ -1053,20 +1056,20 @@ The options for got remove are as follows: - -f + -f Perform the operation even if a file contains local modifications. - -k + -k Keep affected files on disk. - -R + -R Permit recursion into directories. If this option is not specified, got remove will refuse to run if a specified path is a directory. - rm + rm Short alias for remove. - revert + revert [-p] [-F response-script] [-R] path ... @@ -1080,7 +1083,7 @@ The options for got revert are as follows: - -p + -p Instead of reverting all changes in files, interactively select or reject changes to revert based on “y” (revert change), “n” (keep change), and “q” (quit reverting @@ -1088,21 +1091,21 @@ patches derived from the modified file content can be reverted. Files in added or deleted status may only be reverted in their entirety. - -F + -F response-script With the -p option, read “y”, “n”, and “q” responses line-by-line from the specified response-script file instead of prompting interactively. - -R + -R Permit recursion into directories. If this option is not specified, got revert will refuse to run if a specified path is a directory. - rv + rv Short alias for revert. - commit + commit [-m message] [path ...] Create a new commit in the repository from changes in a work tree and use @@ -1148,7 +1151,7 @@ The options for got commit are as follows: - -m + -m message Use the specified log message when creating the new commit. Without the -m option, got @@ -1164,9 +1167,9 @@ got update must be used first in order to merge local changes with changes made in the repository. - ci + ci Short alias for commit. - cherrypick + cherrypick commit Merge changes from a single commit into the work tree. The specified commit must be on a different @@ -1217,9 +1220,9 @@ got update. If the work tree already contains files with merge conflicts, these conflicts must be resolved first. - cy + cy Short alias for cherrypick. - backout + backout commit Reverse-merge changes from a single commit into the work tree. The specified commit must be on the same @@ -1270,9 +1273,9 @@ got update. If the work tree already contains files with merge conflicts, these conflicts must be resolved first. - bo + bo Short alias for backout. - rebase + rebase [-a] [-c] [branch] Rebase commits on the specified branch onto the tip @@ -1358,17 +1361,17 @@ The options for got rebase are as follows: - -a + -a Abort an interrupted rebase operation. If this option is used, no other command-line arguments are allowed. - -c + -c Continue an interrupted rebase operation. If this option is used, no other command-line arguments are allowed. - rb + rb Short alias for rebase. - histedit + histedit [-a] [-c] [-F histedit-script] [-m] @@ -1492,18 +1495,18 @@ The options for got histedit are as follows: - -a + -a Abort an interrupted histedit operation. If this option is used, no other command-line arguments are allowed. - -c + -c Continue an interrupted histedit operation. If this option is used, no other command-line arguments are allowed. - -F + -F histedit-script Use the specified histedit-script instead of opening a temporary file in an editor where a histedit script can be written. - -m + -m Edit log messages only. This option is a quick equivalent to a histedit script which edits only log messages but otherwise leaves every picked commit as-is. The -m option can @@ -1511,9 +1514,9 @@ used, no other command-line arguments are allowed. - he + he Short alias for histedit. - integrate + integrate branch Integrate the specified branch into the work tree's current branch. Files in the work tree are updated to match the contents @@ -1563,9 +1566,9 @@ must first be committed with got commit or reverted with got revert. - ig + ig Short alias for integrate. - stage + stage [-l] [-p] [-F response-script] [path ...] @@ -1609,12 +1612,12 @@ The options for got stage are as follows: - -l + -l Instead of staging new changes, list paths which are already staged, along with the IDs of staged blob objects and stage status codes. If paths were provided in the command line show the staged paths among the specified paths. Otherwise, show all staged paths. - -p + -p Instead of staging the entire content of a changed file, interactively select or reject changes for staging based on “y” (stage change), “n” (reject change), and “q” @@ -1622,7 +1625,7 @@ individual patches derived from the modified file content can be staged. Files in added or deleted status may only be staged or rejected in their entirety. - -F + -F response-script With the -p option, read “y”, “n”, and “q” responses line-by-line from @@ -1644,9 +1647,9 @@ updated with got update, and may then be staged again if necessary. - sg + sg Short alias for stage. - unstage + unstage [-p] [-F response-script] [path ...] Merge staged changes back into the work tree and put affected paths back @@ -1684,7 +1687,7 @@ The options for got unstage are as follows: - -p + -p Instead of unstaging the entire content of a changed file, interactively select or reject changes for unstaging based on “y” (unstage change), “n” (keep change @@ -1692,7 +1695,7 @@ If a file is staged in modified status, individual patches derived from the staged file content can be unstaged. Files staged in added or deleted status may only be unstaged in their entirety. - -F + -F response-script With the -p option, read “y”, “n”, and “q” responses line-by-line from @@ -1700,9 +1703,9 @@ prompting interactively. - ug + ug Short alias for unstage. - cat + cat [-c commit] [-r repository-path] [-P] arg ... @@ -1722,7 +1725,7 @@ The options for got cat are as follows: - -c + -c commit Look up paths in the specified commit. If this option is not used, paths are looked up in the commit resolved via the @@ -1730,13 +1733,13 @@ hash or an existing reference or tag name which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got work tree, use the repository path associated with this work tree. - -P + -P Interpret all arguments as paths only. This option can be used to resolve ambiguity in cases where paths look like tag names, reference names, or object IDs. @@ -1747,7 +1750,7 @@ ENVIRONMENT - GOT_AUTHOR + GOT_AUTHOR The author's name and email address for got commit and got import, for example: “Flan Hacker @@ -1756,22 +1759,22 @@ email address in author data, got attempts to reject GOT_AUTHOR environment variables with a missing email address. - If present, Git's user.name and - user.email configuration settings in the + If present, Git's user.name + and user.email configuration settings in the repository's .git/config file will override the value of GOT_AUTHOR. However, the user.name and user.email configuration settings contained in Git's global ~/.gitconfig configuration file will be used only if the GOT_AUTHOR environment variable is - not set. + not set. - VISUAL, + VISUAL, EDITOR The editor spawned by got commit, got import, or got tag. - GOT_LOG_DEFAULT_LIMIT + GOT_LOG_DEFAULT_LIMIT The default limit on the number of commits traversed by got log. If set to zero, the limit is unbounded. This variable will be silently ignored if it is set to a non-numeric @@ -1875,6 +1878,14 @@ $ got commit -m 'unify the buffer cache' +Alternatively, create a new commit from local changes in a work + tree directory with a log message that has been prepared in the file + /tmp/msg. If vi(1) is set as the + EDITOR, /tmp/msg can be read + into the buffer for review: + +$ got commit +:r /tmp/msg Update any work tree checked out from the “unified-buffer-cache” branch to the latest commit on this branch: @@ -1975,7 +1986,8 @@ configuration item can be added manually to the Git repository's config file: -[remote origin] +[remote origin +] url = ... fetch = +refs/heads/*:refs/remotes/origin/* @@ -2043,8 +2055,8 @@ - - + + May 5, 2020 OpenBSD 6.6 July 23, 2020 OpenBSD 6.7 blob - 4bafa2e8e8a942eb273f9cb4f529af5883ff06c9 blob + 8e24084b69795bf5b365d17b16088f605eebfa8e --- gotweb.8.html +++ gotweb.8.html @@ -82,11 +82,12 @@ Optionally, the run-time behaviour of gotweb can be configured via the gotweb.conf(5) configuration file. - Git repositories must be created at a suitable location inside the web - server's chroot(2) environment. These repositories - should not be writable by the user ID of the - httpd(8) server. The default location for repositories - published by gotweb is + Git repositories must be created at a suitable location inside + the web server's chroot(2) environment. These + repositories should + not be writable by + the user ID of the httpd(8) server. The default location + for repositories published by gotweb is /var/www/got/public. Git repositories served by gotweb should be kept up-to-date with a mechanism such as got fetch, @@ -157,8 +158,8 @@ - - + + May 5, 2020 OpenBSD 6.6 July 23, 2020 OpenBSD 6.7 blob - 3bdbf126d6e02a5167d5d70397275d3981a2ed91 blob + 1d9d21da5d452df4192207d08cc232a6d9c06ca3 --- gotweb.conf.5.html +++ gotweb.conf.5.html @@ -60,40 +60,40 @@ CONFIGURATION The available configuration directives are as follows: - got_max_commits_display + got_max_commits_display number Set the maximum amount of commits displayed per page. - got_logo + got_logo path Set the path to an image file containing a logo to be displayed. - got_logo_url + got_logo_url url Set a hyperlink for the logo. - got_max_repos + got_max_repos number Set the maximum amount of repositories gotweb(8) will work with. - got_max_repos_display + got_max_repos_display number Set the maximum amount of repositories displayed on the index screen. - got_show_repo_age + got_show_repo_age on | off Toggle display of last repository modification date. - got_show_repo_cloneurl + got_show_repo_cloneurl on | off Toggle display of clone URLs for a repository. This requires the creation of a cloneurl file inside the repository which contains one URL per line. - got_show_repo_description + got_show_repo_description on | off Toggle display of the repository description. The description file in the repository should be updated with an appropriate description. - got_repos_path + got_repos_path path Set the path to the directory which contains Git repositories that gotweb(8) should publish. - got_show_repo_owner + got_show_repo_owner on | off Set whether to display the repository owner. Displaying the owner requires owner information to be added to the config file @@ -106,16 +106,16 @@ owner = "Your Name" - got_site_link + got_site_link string Set the displayed site link name for the index page. - got_site_name + got_site_name string Set the displayed site name title. - got_site_owner + got_site_owner string Set the displayed site owner. - got_show_site_owner + got_show_site_owner on | off Toggle display of the site owner. @@ -170,8 +170,8 @@ got_logo_url "https://gameoftrees.org" - - + + May 5, 2020 OpenBSD 6.6 July 23, 2020 OpenBSD 6.7 blob - b8fbc18ccb321b780dc60abd12db7fdcd0899665 blob + 49d7df21a8bb721956dbf43237aab1e2a61f3467 --- tog.1.html +++ tog.1.html @@ -84,13 +84,13 @@ tog provides global and command-specific key bindings and options. The global key bindings are: - Q + Q Quit tog. - q + q Quit the view which is in focus. - Tab + Tab Switch focus between views. - f + f Toggle fullscreen mode for a split-screen view. tog will automatically use split-screen views if the size of the terminal window is sufficiently large. @@ -98,15 +98,15 @@ Global options must precede the command name, and are as follows: - -h + -h Display usage information. - -V, + -V, --version Display program version and exit immediately. The commands for tog are as follows: - log + log [-b] [-c commit] [-r repository-path] [path] @@ -121,46 +121,46 @@ The key bindings for tog log are as follows: - Down-arrow, + Down-arrow, j, >, Full stop Move the selection cursor down. - Up-arrow, + Up-arrow, k, <, Comma Move the selection cursor up. - Page-down, + Page-down, Ctrl+f Move the selection cursor down one page. - Page-up, + Page-up, Ctrl+b Move the selection cursor up one page. - Enter, + Enter, Space Open a diff view showing file changes made in the currently selected commit. - t + t Open a tree view showing the tree for the currently selected commit. - Backspace + Backspace Show log entries for the parent directory of the currently selected path, unless an active search is in progress in which case Backspace aborts the search. - / + / Prompt for a search pattern and start searching for matching commits. The search pattern is an extended regular expression which is matched against a commit's author name, committer name, log message, and commit ID SHA1 hash. Regular expression syntax is documented in re_format(7). - n + n Find the next commit which matches the current search pattern. Searching continues until either a match is found or the Backspace key is pressed. - N + N Find the previous commit which matches the current search pattern. Searching continues until either a match is found or the Backspace key is pressed. - Ctrl+l + Ctrl+l Reload the log view with new commits found in the repository. - B + B Reload the log view and toggle display of merged commits. The -b option determines whether merged commits are displayed initially. @@ -168,13 +168,13 @@ The options for tog log are as follows: - -b + -b Display individual commits which were merged into the current branch from other branches. By default, tog log shows the linear history of the current branch only. The B key binding can be used to toggle display of merged commits at run-time. - -c + -c commit Start traversing history at the specified commit. The expected argument is the name of a @@ -183,7 +183,7 @@ is unique. If this option is not specified, default to the work tree's current branch if invoked in a work tree, or to the repository's HEAD reference. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If @@ -191,7 +191,7 @@ repository path associated with this work tree. - diff + diff [-r repository-path] object1 object2 Display the differences between two objects in the repository. Each @@ -202,43 +202,43 @@ The key bindings for tog diff are as follows: - Down-arrow, + Down-arrow, j Scroll down. - Up-arrow, + Up-arrow, k Scroll up. - Page-down, + Page-down, Space, Ctrl+f Scroll down one page. - Page-up, + Page-up, Ctrl+b Scroll up one page. - [ + [ Reduce the amount of diff context lines. - ] + ] Increase the amount of diff context lines. - <, + <, Comma If the diff view was opened via the log view, move to the previous (younger) commit. - >, + >, Full stop If the diff view was opened via the log view, move to the next (older) commit. - / + / Prompt for a search pattern and start searching for matching line. The search pattern is an extended regular expression. Regular expression syntax is documented in re_format(7). - n + n Find the next line which matches the current search pattern. - N + N Find the previous line which matches the current search pattern. The options for tog diff are as follows: - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If @@ -246,7 +246,7 @@ repository path associated with this work tree. - blame + blame [-c commit] [-r repository-path] path @@ -254,51 +254,51 @@ The key bindings for tog blame are as follows: - Down-arrow, + Down-arrow, j Move the selection cursor down. - Up-arrow, + Up-arrow, k Move the selection cursor up. - Page-down, + Page-down, Space, Ctrl+f Move the selection cursor down one page. - Page-up, + Page-up, Ctrl+b Move the selection cursor up one page. - Enter + Enter Open a diff view for the currently selected line's commit. - b + b Reload the blame view with the version of the file as found in the currently selected line's commit. - p + p Reload the blame view with the version of the file as found in the parent commit of the currently selected line's commit. - B + B Reload the blame view with the previously blamed commit. - / + / Prompt for a search pattern and start searching for matching line. The search pattern is an extended regular expression. Regular expression syntax is documented in re_format(7). - n + n Find the next line which matches the current search pattern. - N + N Find the previous line which matches the current search pattern. The options for tog blame are as follows: - -c + -c commit Start traversing history at the specified commit. The expected argument is the name of a branch or a commit ID SHA1 hash. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If @@ -306,7 +306,7 @@ repository path associated with this work tree. - tree + tree [-c commit] [-r repository-path] [path] @@ -332,56 +332,58 @@ entry is a Git submodule + Symbolic link entries are also annotated with the target path + of the link. The key bindings for tog tree are as follows: - Down-arrow, + Down-arrow, j Move the selection cursor down. - Up-arrow, + Up-arrow, k Move the selection cursor up. - Page-down, + Page-down, Ctrl+f Move the selection cursor down one page. - Page-up, + Page-up, Ctrl+b Move the selection cursor up one page. - Enter + Enter Enter the currently selected directory, or switch to the blame view for the currently selected file. - l + l Open a log view for the currently selected tree entry. - Backspace + Backspace Move back to the parent directory. - i + i Show object IDs for all objects displayed in the tree view. - / + / Prompt for a search pattern and start searching for matching tree entries. The search pattern is an extended regular expression which is matched against the tree entry's name. Regular expression syntax is documented in re_format(7). - n + n Find the next tree entry which matches the current search pattern. - N + N Find the previous tree entry which matches the current search pattern. The options for tog tree are as follows: - -c + -c commit Start traversing history at the specified commit. The expected argument is the name of a branch or a commit ID SHA1 hash. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. - -r + -r repository-path Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If @@ -394,7 +396,7 @@ ENVIRONMENT - TOG_COLORS + TOG_COLORS tog shows colorized output if this variable is set to a non-empty value. The default color scheme can be modified by setting the environment variables documented below. The colors available in color @@ -402,37 +404,37 @@ “green”, “yellow”, “blue”, “megenta”, “cyan”, and “default” which maps to the terminal's default foreground color. - TOG_COLOR_DIFF_MINUS + TOG_COLOR_DIFF_MINUS The color used to mark up removed lines in diffs. If not set, the default value “magenta” is used. - TOG_COLOR_DIFF_PLUS + TOG_COLOR_DIFF_PLUS The color used to mark up added lines in diffs. If not set, the default value “cyan” is used. - TOG_COLOR_DIFF_CHUNK_HEADER + TOG_COLOR_DIFF_CHUNK_HEADER The color used to mark up chunk header lines in diffs. If not set, the default value “yellow” is used. - TOG_COLOR_DIFF_META + TOG_COLOR_DIFF_META The color used to mark up meta data in diffs. If not set, the default value “green” is used. - TOG_COLOR_TREE_SUBMODULE + TOG_COLOR_TREE_SUBMODULE The color used to mark up sobmodules tree entries. If not set, the default value “magenta” is used. - TOG_COLOR_TREE_SYMLINK + TOG_COLOR_TREE_SYMLINK The color used to mark up symbolic link tree entries. If not set, the default value “magenta” is used. - TOG_COLOR_TREE_DIRECTORY + TOG_COLOR_TREE_DIRECTORY The color used to mark up directory tree entries. If not set, the default value “cyan” is used. - TOG_COLOR_TREE_EXECUTABLE + TOG_COLOR_TREE_EXECUTABLE The color used to mark up executable file tree entries. If not set, the default value “green” is used. - TOG_COLOR_COMMIT + TOG_COLOR_COMMIT The color used to mark up commit IDs. If not set, the default value “green” is used. - TOG_COLOR_AUTHOR + TOG_COLOR_AUTHOR The color used to mark up author information. If not set, the default value “cyan” is used. - TOG_COLOR_DATE + TOG_COLOR_DATE The color used to mark up date information. If not set, the default value “yellow” is used. @@ -460,8 +462,8 @@ - - + + May 5, 2020 OpenBSD 6.6 July 23, 2020 OpenBSD 6.7