NAME

got — Game of - Trees

SYNOPSIS

@@ -47,7 +43,7 @@

got

DESCRIPTION

got is a version control system which stores the history of tracked files in a Git repository, as used by the Git version control system. This repository format is described in @@ -77,9 +73,9 @@

import [-b branch] + [-I pattern] [-m message] [-r repository-path] - [-I pattern] directory: (alias: @@ -105,6 +101,13 @@; Create the specified branch instead of creating the default branch “main”. Use of this option is required if the “main” branch already exists.
-I + pattern: Ignore files or directories with a name which matches the specified + pattern. This option may be specified multiple + times to build a list of ignore patterns. The + pattern follows the globbing rules documented in + glob(7).
-m message: Use the specified log message when creating the new commit. Without @@ -115,20 +118,11 @@ 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 - pattern: Ignore files or directories with a name which matches the specified - pattern. This option may be specified multiple - times to build a list of ignore patterns. The - pattern follows the globbing rules documented in - glob(7).


   
   clone
-    [-a] [-b
-    branch] [-l]
-    [-m] [-q]
-    [-v] [-R
+    [-almqv] [-b
+    branch] [-R
     reference] repository-URL
     [directory]
   
@@ -227,12 +221,6 @@
       
Suppress progress reporting output. The same option will be passed to
           ssh(1) if
         applicable.
-      -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
         reference
       In addition to the branches and tags that will be fetched, fetch an
@@ -252,16 +240,20 @@
             “refs/remotes/” or “refs/got/”
             namespace.
       
+      -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.
     
   
   fetch
-    [-a] [-b
-    branch] [-d]
-    [-l] [-r
-    repository-path] [-t]
-    [-q] [-v]
-    [-R reference]
-    [-X] [remote-repository]
+    [-adlqtvX] [-b
+    branch] [-R
+    reference] [-r
+    repository-path]
+    [remote-repository]
   
     (alias:
       fe)
@@ -324,26 +316,10 @@
           repository and exit immediately. Cannot be used together with any of
           the other options except -v,
           -q, and -r.
-      -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
-        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
       Suppress progress reporting output. The same option will be passed to
           ssh(1) if
         applicable.
-      -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
         reference
       In addition to the branches and tags that will be fetched, fetch an
@@ -366,6 +342,22 @@
             “refs/remotes/” or “refs/got/”
             namespace.
       
+      -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.
+      -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.
+      -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.
       -X
       Delete all references which correspond to a particular
           remote-repository instead of fetching new
@@ -385,11 +377,10 @@
     
   
   checkout
-    [-E] [-b
+    [-Eq] [-b
     branch] [-c
     commit] [-p
-    path-prefix] [-q]
-    repository-path
+    path-prefix] repository-path
     [work-tree-path]
   
     (alias:
@@ -413,10 +404,6 @@
     The options for got checkout are as
         follows:
     
-      -E
-      Proceed with the checkout operation even if the directory at
-          work-tree-path is not empty. Existing files will
-          be left intact.
       -b
         branch
       Check out files from a commit on the specified
@@ -439,6 +426,10 @@
             got checkout can be used. Checking out work
             trees with an unknown branch is intentionally not supported.
       
+      -E
+      Proceed with the checkout operation even if the directory at
+          work-tree-path is not empty. Existing files will
+          be left intact.
       -p
         path-prefix
       Restrict the work tree to a subset of the repository's tree hierarchy.
@@ -449,9 +440,9 @@
     
   

   update
-    [-b branch]
-    [-c commit]
-    [-q] [path ...]
+    [-q] [-b
+    branch] [-c
+    commit] [path ...]
   
     (alias:
       up)
@@ -553,8 +544,8 @@
     
   
   status
-    [-I] [-s
-    status-codes] [-S
+    [-I] [-S
+    status-codes] [-s
     status-codes] [path ...]
   
     (alias:
@@ -637,15 +628,6 @@
     
       -I
       Show unversioned files even if they match an ignore pattern.
-      -s
-        status-codes
-      Only show files with a modification status matching any of the
-          single-character status codes contained in the
-          status-codes argument. Any combination of codes
-          from the above list of possible status codes may be specified. For
-          staged files, status codes displayed in either column will be matched.
-          Cannot be used together with the -S
-        option.
       -S
         status-codes
       Suppress the output of files with a modification status matching any
@@ -655,6 +637,15 @@
           staged files, status codes displayed in either column will be matched.
           Cannot be used together with the -s
         option.
+      -s
+        status-codes
+      Only show files with a modification status matching any of the
+          single-character status codes contained in the
+          status-codes argument. Any combination of codes
+          from the above list of possible status codes may be specified. For
+          staged files, status codes displayed in either column will be matched.
+          Cannot be used together with the -S
+        option.
     
     For compatibility with cvs(1) and git(1),
@@ -674,14 +665,12 @@
         “/”, in a pattern.
   

   log
-    [-b] [-c
-    commit] [-C
-    number] [-l
-    N] [-p]
-    [-P] [-s]
-    [-S search-pattern]
-    [-r repository-path]
-    [-R] [-x
+    [-bPpRs] [-C
+    number] [-c
+    commit] [-l
+    N] [-r
+    repository-path] [-S
+    search-pattern] [-x
     commit] [path]
   Display history of a repository. If a path is
       specified, show only commits which modified this path. If invoked in a
@@ -696,6 +685,11 @@
       
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
+        number
+      Set the number of context lines shown in diffs with
+          -p. By default, 3 lines of context are
+        shown.
       -c
         commit
       Start traversing history at the specified
@@ -706,11 +700,6 @@
           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
-        number
-      Set the number of context lines shown in diffs with
-          -p. By default, 3 lines of context are
-        shown.
       -l
         N
       Limit history traversal to a given number of commits. If this option
@@ -718,11 +707,6 @@
           treated as an unbounded limit. The
           GOT_LOG_DEFAULT_LIMIT environment variable may
           be set to change this default value.
-      -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. Cannot be used with the
-          -s option.
       -P
       Display the list of file paths changed in each commit, using the
           following status codes:
@@ -747,10 +731,20 @@
         Cannot be used with the -s
           option.
       
-      -s
-      Display a short one-line summary of each commit, instead of the
-          default history format. Cannot be used together with the
-          -p or -P option.
+      -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. Cannot be used with the
+          -s option.
+      -R
+      Determine a set of commits to display as usual, but display these
+          commits in reverse order.
+      -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
         search-pattern
       If specified, show only commits with a log message, author name,
@@ -761,15 +755,10 @@
           -P is specified. Regular expression syntax is
           documented in re_format(7).
-      -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
-      Determine a set of commits to display as usual, but display these
-          commits in reverse order.
+      -s
+      Display a short one-line summary of each commit, instead of the
+          default history format. Cannot be used together with the
+          -p or -P option.
       -x
         commit
       Stop traversing commit history immediately after the specified
@@ -779,13 +768,11 @@
     
   
   diff
-    [-a] [-c
-    commit] [-C
-    number] [-r
-    repository-path] [-s]
-    [-P] [-w]
-    [object1 object2 |
-    path ...]
+    [-aPsw] [-C
+    number] [-c
+    commit] [-r
+    repository-path] [object1
+    object2 | path ...]
   
     (alias:
       di)
@@ -807,10 +794,14 @@
       
-a
       Treat file contents as ASCII text even if binary data is
         detected.
+      -C
+        number
+      Set the number of context lines shown in the diff. By default, 3 lines
+          of context are shown.
       -c
         commit
-      Show differences between commits in the repository. This options may
-          be used up to two times. When used only once, show differences between
+      
Show differences between commits in the repository. This option may be
+          used up to two times. When used only once, show differences between
           the specified commit and its first parent
           commit. When used twice, show differences between the two specified
           commits.
@@ -825,10 +816,11 @@
         Cannot be used together with the
             -P option.
       
-      -C
-        number
-      Set the number of context lines shown in the diff. By default, 3 lines
-          of context are shown.
+      -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. This option is only valid when
+          got diff is invoked in a work tree.
       -r
         repository-path
       Use the repository at the specified path. If not specified, assume the
@@ -839,11 +831,6 @@
       
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.
-      -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. This option is only valid when
-          got diff is invoked in a work tree.
       -w
       Ignore whitespace-only changes.
     
@@ -876,10 +863,9 @@
     
   
   tree
-    [-c commit]
-    [-r repository-path]
-    [-i] [-R]
-    [path]
+    [-iR] [-c
+    commit] [-r
+    repository-path] [path]
   
     (alias:
       tr)
@@ -920,25 +906,24 @@
           to a commit ID. An abbreviated hash argument will be expanded to a
           full SHA1 hash automatically, provided the abbreviation is
         unique.
+      -i
+      Show object IDs of files (blob objects) and directories (tree
+          objects).
+      -R
+      Recurse into sub-directories in the repository.
       -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
-      Show object IDs of files (blob objects) and directories (tree
-          objects).
-      -R
-      Recurse into sub-directories in the repository.
     
   
   ref
-    [-r repository-path]
-    [-l] [-t]
-    [-c object]
-    [-s reference]
-    [-d] [name]
+    [-dlt] [-c
+    object] [-r
+    repository-path] [-s
+    reference] [name]
   Manage references in a repository.
     References may be listed, created, deleted, and changed. When
         creating, deleting, or changing a reference the specified
@@ -947,25 +932,6 @@
     
The options for got ref are as
         follows:
     
-      -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
-      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 and
-          -t.
-      -t
-      Sort listed references by modification time (most recently modified
-          first) instead of sorting by lexicographical order. Use of this option
-          requires the -l option to be used as
-        well.
       -c
         object
       Create a reference or change an existing reference. The reference with
@@ -976,6 +942,27 @@
           corresponding commit, tree, tag, or blob object. Cannot be used
           together with any other options except
         -r.
+      -d
+      Delete the reference with the specified name
+          from the repository. Any commit, tree, tag, and blob objects belonging
+          to deleted references remain in the repository and may be removed
+          separately with Git's garbage collector or gotadmin
+          cleanup. Cannot be used together with any other options except
+          -r.
+      -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 and
+          -t.
+      -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
         reference
       Create a symbolic reference, or change an existing symbolic reference.
@@ -985,21 +972,18 @@
           loops between references when this option is used. Cannot be used
           together with any other options except
         -r.
-      -d
-      Delete the reference with the specified name
-          from the repository. Any commit, tree, tag, and blob objects belonging
-          to deleted references remain in the repository and may be removed
-          separately with Git's garbage collector or gotadmin
-          cleanup. Cannot be used together with any other options except
-          -r.
+      -t
+      Sort listed references by modification time (most recently modified
+          first) instead of sorting by lexicographical order. Use of this option
+          requires the -l option to be used as
+        well.
     
   
   branch
-    [-c commit]
-    [-r repository-path]
-    [-l] [-t]
-    [-d name]
-    [-n] [name]
+    [-lnt] [-c
+    commit] [-d
+    name] [-r
+    repository-path] [name]
   
     (alias:
       br)
@@ -1065,12 +1049,16 @@
           commit argument is a commit ID SHA1 hash or an
           existing reference or tag name which will be resolved to a commit
         ID.
-      -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.
+      -d
+        name
+      Delete the branch with the specified name from
+          the “refs/heads” or “refs/remotes”
+          reference namespace.
+        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 or
+            gotadmin cleanup.
+      
       -l
       List all existing branches in the repository, including copies of
           remote repositories' branches in the “refs/remotes/”
@@ -1088,6 +1076,15 @@
           
         
       
+      -n
+      Do not switch and update the work tree after creating a new
+        branch.
+      -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.
       -t
       Sort listed branches by modification time (most recently modified
           first) instead of sorting by lexicographical order. Branches in the
@@ -1095,28 +1092,14 @@
           branches in “refs/remotes/” regardless. Use of this
           option requires the -l option to be used as
           well.
-      -d
-        name
-      Delete the branch with the specified name from
-          the “refs/heads” or “refs/remotes”
-          reference namespace.
-        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 or
-            gotadmin cleanup.
-      
-      -n
-      Do not switch and update the work tree after creating a new
-        branch.
     
   
   tag
-    [-c commit]
-    [-m message]
-    [-r repository-path]
-    [-l] [-s
-    signer-id] [-v]
-    [-V] name
+    [-lVv] [-c
+    commit] [-m
+    message] [-r
+    repository-path] [-s
+    signer-id] name
   Manage tags in a repository.
     Tags are managed via references which live in the
         “refs/tags/” reference namespace. The got
@@ -1141,6 +1124,10 @@
           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.

+      -l
+      List all existing tags in the repository instead of creating a new
+          tag. If a name argument is passed, show only the
+          tag with the given name.
       -m
         message
       Use the specified tag message when creating the new tag. Without the
@@ -1153,10 +1140,6 @@
           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
-      List all existing tags in the repository instead of creating a new
-          tag. If a name argument is passed, show only the
-          tag with the given name.
       -s
         signer-id
       While creating a new tag, sign this tag with the identity given in
@@ -1167,16 +1150,11 @@
             ssh-agent(1).
             got tag will sign the tag object by invoking
             ssh-keygen(1)
-            with the -Y sign
+            with the -Y sign
             command, using the signature namespace “git” for
             compatibility with git(1).
       
-      -v
-      Verbose mode. During SSH signature creation and verification this
-          option will be passed to ssh-keygen(1). Multiple -v options increase the verbosity. The
-          maximum is 3.
       -V
       Verify tag object signatures. If a name is
           specified, show and verify the tag object with the provided name.
@@ -1184,12 +1162,17 @@
         got tag verifies SSH-based
             signatures by invoking ssh-keygen(1) with the options -Y
-            verify -f
+            verify -f
             allowed_signers. A path to the
             allowed_signers file must be set in
             got.conf(5),
             otherwise verification is impossible.
       
+      -v
+      Verbose mode. During SSH signature creation and verification this
+          option will be passed to ssh-keygen(1). Multiple -v options increase the verbosity. The
+          maximum is 3.
     
     By design, the got tag command will
         not delete tags or change existing tags. If a tag must be deleted, the
@@ -1198,26 +1181,24 @@
         copied to another repository.
   
   add
-    [-R] [-I]
-    path ...
+    [-IR] path ...
   Schedule unversioned files in a work tree for addition to the repository
       in the next commit. By default, files which match a got
       status ignore pattern will not be added.
     The options for got add are as
         follows:
     
+      -I
+      Add files even if they match a got status
+          ignore pattern.
       -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
-      Add files even if they match a got status
-          ignore pattern.
     
   
   remove
-    [-f] [-k]
-    [-R] [-s
+    [-fkR] [-s
     status-codes] path ...
   
     (alias:
@@ -1258,9 +1239,9 @@
     
   

   patch
-    [-n] [-p
-    strip-count] [-R]
-    [patchfile]
+    [-nR] [-c
+    commit] [-p
+    strip-count] [patchfile]
   
     (alias:
       pa)
@@ -1322,6 +1303,28 @@
     The options for got patch are as
         follows:
     
+      -c
+        commit
+      Attempt to locate files within the specified
+          commit for use as a merge-base for 3-way merges.
+          Ideally, the specified commit should contain
+          versions of files which the changes contained in the
+          patchfile were based on. Files will be located
+          by path, relative to the repository root. If the
+          -p option is used then leading path components
+          will be stripped before paths are looked up in the repository.
+        If the -c option is not used then
+            got patch will attempt to locate merge-bases
+            via object IDs found in patchfile meta-data,
+            such as produced by got diff or
+            git-diff(1). Use
+            of the -c option is only recommended in the
+            absence of such meta-data.
+        In case no merge-base is available for a file, changes
+            will be applied without doing a 3-way merge. Changes which do not
+            apply cleanly may then be rejected entirely, rather than producing
+            merge conflicts in the patched target file.
+      
       -n
       Do not make any modifications to the work tree. This can be used to
           check whether a patch would apply without issues. If the
@@ -1340,9 +1343,8 @@
     
   
   revert
-    [-p] [-F
-    response-script] [-R]
-    path ...
+    [-pR] [-F
+    response-script] path ...
   
     (alias:
       rv)
@@ -1356,6 +1358,12 @@
     The options for got revert are as
         follows:
     
+      -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.
       -p
       Instead of reverting all changes in files, interactively select or
           reject changes to revert based on “y” (revert change),
@@ -1364,12 +1372,6 @@
           patches derived from the modified file content can be reverted. Files
           in added or deleted status may only be reverted in their
         entirety.
-      -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
       Permit recursion into directories. If this option is not specified,
           got revert will refuse to run if a specified
@@ -1377,10 +1379,10 @@
     
   
   commit
-    [-F path]
-    [-m message]
-    [-N] [-S]
-    [path ...]
+    [-NS] [-A
+    author] [-F
+    path] [-m
+    message] [path ...]
   
     (alias:
       ci)
@@ -1433,6 +1435,20 @@
     The options for got commit are as
         follows:
     
+      -A
+        author
+      Set author information in the newly created commit to
+          author. This is useful when committing changes
+          which were written by someone else. The author
+          argument must use the same format as the
+          GOT_AUTHOR environment variable.
+        In addition to storing author information, the newly
+            created commit object will retain “committer”
+            information which is obtained, as usual, from the
+            GOT_AUTHOR environment variable, or
+            got.conf(5), or
+            Git configuration settings.
+      
       -F
         path
       Use the prepared log message stored in the file found at
@@ -1471,13 +1487,11 @@
         local changes with changes made in the repository.
   
   send
-    [-a] [-b
+    [-afqTv] [-b
     branch] [-d
-    branch] [-f]
-    [-r repository-path]
-    [-t tag]
-    [-T] [-q]
-    [-v] [remote-repository]
+    branch] [-r
+    repository-path] [-t
+    tag] [remote-repository]
   
     (alias:
       se)
@@ -1562,12 +1576,22 @@
             risks of creating inconsistencies between different repositories
             should also be taken into account.
       
+      -q
+      Suppress progress reporting output. The same option will be passed to
+          ssh(1) if
+        applicable.
       -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.
+      -T
+      Attempt to send all tags from the local repository's
+          “refs/tags/” reference namespace. The
+          -T option is equivalent to listing all tags
+          with multiple -t options. Cannot be used
+          together with the -t option.
       -t
         tag
       Send the specified tag from the local
@@ -1584,16 +1608,6 @@
         Cannot be used together with the
             -T option.
       
-      -T
-      Attempt to send all tags from the local repository's
-          “refs/tags/” reference namespace. The
-          -T option is equivalent to listing all tags
-          with multiple -t options. Cannot be used
-          together with the -t option.
-      -q
-      Suppress progress reporting output. The same option will be passed to
-          ssh(1) if
-        applicable.
       -v
       Verbose mode. Causes got send to print
           debugging messages to standard error output. The same option will be
@@ -1718,9 +1732,7 @@
         contain merge conflicts, these conflicts must be resolved first.
   
   rebase
-    [-a] [-c]
-    [-l] [-X]
-    [branch]
+    [-aclX] [branch]
   
     (alias:
       rb)
@@ -1747,7 +1759,12 @@
         branch, but with different commit IDs. Once
         rebasing has completed successfully, the temporary branch becomes the
         new version of the specified branch and the work
-        tree is automatically switched to it.
+        tree is automatically switched to it. If author information is available
+        via the GOT_AUTHOR environment variable,
+        got.conf(5) or Git's
+        user.name and user.email
+        configuration settings, this author information will be used to identify
+        the “committer” of rebased commits.
     Old commits in their pre-rebase state are automatically backed
         up in the “refs/got/backup/rebase” reference namespace. As
         long as these references are not removed older versions of rebased
@@ -1807,11 +1824,13 @@
         merged change into a no-op change, the corresponding commit will be
         elided when the rebase operation continues.
     got rebase will refuse to run if
-        certain preconditions are not met. If the work tree is not yet fully
-        updated to the tip commit of its branch, then the work tree must first
-        be updated with got update. If changes have been
-        staged with got stage, these changes must first
-        be committed with got commit or unstaged with
+        certain preconditions are not met. If the branch
+        is not in the “refs/heads/” reference namespace, the
+        branch may not be rebased. If the work tree is not yet fully updated to
+        the tip commit of its branch, then the work tree must first be updated
+        with got update. If changes have been staged
+        with got stage, these changes must first be
+        committed with got commit or unstaged with
         got unstage. If the work tree contains local
         changes, these changes must first be committed with got
         commit or reverted with got revert. If
@@ -1833,7 +1852,7 @@
       
-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.
       -l
@@ -1874,16 +1893,21 @@
     
   
   histedit
-    [-a] [-c]
-    [-e] [-f]
-    [-F histedit-script]
-    [-m] [-l]
-    [-X] [branch]
+    [-aceflmX] [-F
+    histedit-script] [branch]
   
     (alias:
       he)
     Edit commit history between the work tree's current base commit and the tip
       commit of the work tree's current branch.
+    The got histedit command requires the
+        GOT_AUTHOR environment variable to be set,
+        unless an author has been configured in
+        got.conf(5) or Git's
+        user.name and user.email
+        configuration settings can be obtained from the repository's
+        .git/config file or from Git's global
+        ~/.gitconfig configuration file.
     Before starting a histedit operation,
         the work tree's current branch must be set with got
         update -b to the branch which should be edited, unless this
@@ -2032,7 +2056,7 @@
       
-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.
       -e
@@ -2042,21 +2066,15 @@
           -e option can only be used when starting a new
           histedit operation. If this option is used, no other command-line
           arguments are allowed.
-      -f
-      Fold all commits into a single commit. This option is a quick
-          equivalent to a histedit script which folds all commits, combining
-          them all into one commit. The -f option can
-          only be used when starting a new histedit operation. If this option is
-          used, no other command-line arguments are allowed.
       -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
-      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
+      
-f
+      Fold all commits into a single commit. This option is a quick
+          equivalent to a histedit script which folds all commits, combining
+          them all into one commit. The -f option can
           only be used when starting a new histedit operation. If this option is
           used, no other command-line arguments are allowed.
       -l
@@ -2078,6 +2096,12 @@
             histedit does not require a work tree. None of the other
             options can be used together with -l.
       
+      -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
+          only be used when starting a new histedit operation. If this option is
+          used, no other command-line arguments are allowed.
       -X
       Delete backups created by past histedit operations, represented by
           references in the “refs/got/backup/histedit” reference
@@ -2150,8 +2174,7 @@
         reverted with got revert.
   
   merge
-    [-a] [-c]
-    [-n] [branch]
+    [-acn] [branch]
   
     (alias:
       mg)
@@ -2254,7 +2277,7 @@
       
-a
       Abort an interrupted merge operation. If this option is used, no other
           command-line arguments are allowed.
-      -c
+      -c
       Continue an interrupted merge operation. If this option is used, no
           other command-line arguments are allowed.
       -n
@@ -2266,9 +2289,8 @@
     
   
   stage
-    [-l] [-p]
-    [-F response-script]
-    [-S] [path ...]
+    [-lpS] [-F
+    response-script] [path ...]
   
     (alias:
       sg)
@@ -2312,6 +2334,12 @@
     The options for got stage are as
         follows:
     
+      -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.
       -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
@@ -2325,12 +2353,6 @@
           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
-        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.
       -S
       Allow staging of symbolic links which point outside of the path space
           that is under version control. By default, got
@@ -2398,6 +2420,12 @@
     The options for got unstage are as
         follows:
     
+      -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.
       -p
       Instead of unstaging the entire content of a changed file,
           interactively select or reject changes for unstaging based on
@@ -2406,18 +2434,12 @@
           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
-        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.
     
   

   cat
-    [-c commit]
-    [-r repository-path]
-    [-P] arg ...
+    [-P] [-c
+    commit] [-r
+    repository-path] arg ...
   Parse and print contents of objects to standard output in a line-based
       text format. Content of commit, tree, and tag objects is printed in a way
       similar to the actual content stored in such objects. Blob object contents
@@ -2434,7 +2456,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
@@ -2442,16 +2464,16 @@
           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.
+      -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.
       -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
-      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.
     
   
   info
@@ -2470,15 +2492,17 @@


 
-ENVIRONMENT
+ENVIRONMENT
 
   GOT_AUTHOR
-  The author's name and email address for got commit
-      and got import, for example:
-      “Flan Hacker
+  
The author's name and email address, such as “Flan
+      Hacker
       <flan_hacker@openbsd.org>”.
-      Because git(1) may fail to
-      parse commits without an email address in author data,
+      Used by the got commit, got
+      import, got rebase, and
+      got histedit commands. Because
+      git(1) may fail to parse
+      commits without an email address in author data,
       got attempts to reject
       GOT_AUTHOR environment variables with a missing
       email address.
@@ -2507,10 +2531,13 @@
       got log. If set to zero, the limit is unbounded.
       This variable will be silently ignored if it is set to a non-numeric
       value.
+  GOT_IGNORE_GITCONFIG
+  If this variable is set then any remote repository definitions or author
+      information found in Git configuration files will be ignored.
 
 
 
-FILES
+FILES
 
   got.conf
   Repository-wide configuration settings for got. If
@@ -2531,13 +2558,13 @@
 
 
 
-EXIT
-  STATUS
+EXIT
+  STATUS
 The got utility exits 0 on success,
     and >0 if an error occurs.
 
 
-EXAMPLES
+EXAMPLES
 Enable tab-completion of got command names
     in ksh(1):
 
@@ -2800,10 +2827,84 @@
 
 $ cd /var/git/src.git
 $ git push origin master
+When making contributions to projects which use the “pull
+    request” workflow, SSH protocol repository access needs to be set up
+    first. Once an account has been created on a Git hosting site it should be
+    possible to upload a public SSH key for repository access
+  authentication.
+The “pull request” workflow will usually involve two
+    remote repositories. In the real-life example below, the
+    “origin” repository was forked from the
+    “upstream” repository by using the Git hosting site's web
+    interface. The got.conf(5) file in the local repository describes both remote
+    repositories:
+
+# Jelmers's repository, which accepts pull requests
+remote "upstream" {
+	server git@github.com
+	protocol ssh
+	repository "/jelmer/dulwich"
+	branch { "master" }
+}
+
+# Stefan's fork, used as the default remote repository
+remote "origin" {
+	server git@github.com
+	protocol ssh
+	repository "/stspdotname/dulwich"
+	branch { "master" }
+}
+
+With this configuration, Stefan can create commits on
+    “refs/heads/master” and send them to the
+    “origin” repository by running:
+
+$ got send -b master
+  origin
+The changes can now be proposed to Jelmer by opening a pull
+    request via the Git hosting site's web interface. If Jelmer requests further
+    changes to be made, additional commits can be created on the
+    “master” branch and be added to the pull request by running
+    got send again.
+If Jelmer prefers additional commits to be
+    “squashed” then the following commands can be used to achieve
+    this:
+
+$ got update -b master
+$ got update -c
+  origin/master
+$ got histedit -f
+$ got send -f -b master
+  origin
+Once Jelmer has accepted the pull request, Stefan can fetch the
+    merged changes, and possibly several other new changes, by running:
+
+$ got fetch upstream
+The merged changes will now be visible under the reference
+    “refs/remotes/upstream/master”. The local
+    “master” branch can now be rebased on top of the latest
+    changes from upstream:
+
+$ got update -b
+  upstream/master
+$ got rebase master
+As a final step, the forked repository's copy of the master branch
+    needs to be kept in sync by sending the new changes there:
+
+$ got send -f -b master
+  origin
+If multiple pull requests need to be managed in parallel, a
+    separate branch must be created for each pull request with
+    got branch. Each such branch can then be used as
+    above, in place of “refs/heads/master”. Changes for any
+    accepted pull requests will still appear under
+    “refs/remotes/upstream/master,” regardless of which branch was
+    used in the forked repository to create a pull request.
 
 
-SEE
-  ALSO
+SEE
+  ALSO
 gotadmin(1),
     tog(1),
     git-repository(5),
@@ -2812,7 +2913,7 @@
     gotweb(8)
 
 
-AUTHORS
+AUTHORS
 Anthony J. Bentley
     <bentley@openbsd.org>
   

@@ -2869,7 +2970,7 @@
     code under copyright by:
 
   

-  Caldera International Inc.
+  Caldera International
   

   Daniel Hartmeier
   

@@ -2910,7 +3011,7 @@
   Austin Appleby
 
 
-CAVEATS
+CAVEATS
 got is a work-in-progress and some
     features remain to be implemented.
 At present, the user has to fall back on
@@ -2930,12 +3031,9 @@
       usually produce better results.
 
 
-

NAME

gotwebd.conf — + gotwebd configuration file

DESCRIPTION

gotwebd.conf is the run-time configuration + file for gotwebd(8).

The file format is line-based, with one configuration directive + per line. Any lines beginning with a ‘#’ are treated as + comments and ignored.

Paths mentioned in gotwebd.conf must be + relative to /var/www, the + chroot(2) environment of + httpd(8).

GLOBAL + CONFIGURATION

The available global configuration directives are as follows:

chroot + path: Set the path to the the chroot(2) environment of httpd(8). If not specified then /var/www + will be used.
prefork + number: Run the specified number of server processes.
unix_socket + on | off: Controls whether the servers will listen on unix sockets by default.
unix_socket_name + path: Set the path to the default unix socket.

At least one server context must exist for + gotwebd(8) to function. In + case no server context is defined in the configuration file, a default + server context will be used, which listens on a unix socket at + /var/www/run/gotweb.sock and uses default parameters + for all applicable settings.

A server context is declared with a unique + name, followed by server-specific configuration + directives inside curly braces:

server name + {...}

gotwebd(8) is + compatible with TLS Server Name Indication (SNI), provided the + name of a server defined in + gotwebd.conf corresponds to the name of a server + defined in httpd.conf(5).

The available server configuration directives are as follows:

custom_css + path

Set the path to a custom Cascading Style Sheet (CSS) to be used. If this + option is not specified then a default style sheet will be used.

listen + on address port + number

Configure an address and port for incoming FCGI TCP connections. Valid + address arguments are hostnames, IP4 addresses, IPv6 + addresses, and network interface names. The port + argument may be number or a service name defined in + services(5). +

May be specified multiple times to build up a list of + listening sockets. However, a given combination of address and port may + only be used by one server.

logo + path

Set the path to an image file containing a logo to be displayed.

logo_url + url

Set a hyperlink for the logo.

max_commits_display + number

Set the maximum amount of commits displayed per page.

max_repos + number

Set the maximum amount of repositories gotwebd(8) will work with.

max_repos_display + number

Set the maximum amount of repositories displayed on the index screen.

repos_path + path

Set the path to the directory which contains Git repositories that the + server should publish.

show_repo_age + on | off

Toggle display of last repository modification date.

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.

show_repo_description + on | off

Toggle display of the repository description. The + description file in the repository should be + updated with an appropriate description.

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 + in the repository. gotwebd(8) will parse owner information from either a [gotweb] or a + [gitweb] section. For example: +

[gotweb]
+owner = "Your Name"

site_link + string

Set the displayed site link name for the index page.

site_name + string

Set the displayed site name title.

site_owner + string

Set the displayed site owner.

show_site_owner + on | off

Toggle display of the site owner.

unix_socket + on | off

Enable or disable use of unix sockets.

unix_socket_name + path

Set the path to the unix socket used by the server.

EXAMPLES

These are the currently configurable items for + gotwebd(8) with their + default values.

#
+# gotwebd options
+# all paths relative to /var/www (httpd chroot jail)
+#
+
+prefork 1
+
+server "localhost-unix" {
+	repos_path "/got/public"
+	unix_socket_name "/run/gotweb.sock"
+
+	got_site_name   "my public repos"
+	got_site_owner   "Got Owner"
+	got_site_link   "repos"
+
+	logo   "got.png"
+	logo_url   "https://gameoftrees.org"
+
+	# on by default
+	#show_site_owner  off
+	#show_repo_owner  off
+	#show_repo_age  false
+	#show_repo_description no
+	#show_repo_cloneurl  off
+
+	#max_repos   100
+	#max_repos_display  25
+	#max_commits_display  50
+}
+
+# Example server context for FCGI over TCP connections:
+#server "localhost-tcp" {
+#	repos_path "/got/public"
+#	unix_socket		off
+#	listen on 127.0.0.1 port 9000
+#	listen on ::1 port 9000
+#}

FILES

/var/www/etc/gotweb.conf: Location of the gotwebd.conf configuration + file.

SEE + ALSO

got(1), + httpd.conf(5), + services(5), + gotwebd(8), + httpd(8)