Blob


1 .\"
2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd $Mdocdate$
18 .Dt GOT 1
19 .Os
20 .Sh NAME
21 .Nm got
22 .Nd Game of Trees
23 .Sh SYNOPSIS
24 .Nm
25 .Op Fl hV
26 .Ar command
27 .Op Ar arg ...
28 .Sh DESCRIPTION
29 .Nm
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
34 .Pp
35 .Nm
36 is a
37 .Dq distributed
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
40 at any time.
41 .Pp
42 Files managed by
43 .Nm
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
46 .Em work tree
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
49 .Xr got-worktree 5 .
50 .Pp
51 .Nm
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
55 .It Fl h
56 Display usage information and exit immediately.
57 .It Fl V , -version
58 Display program version and exit immediately.
59 .El
60 .Pp
61 The commands for
62 .Nm
63 are as follows:
64 .Bl -tag -width checkout
65 .Tg im
66 .It Xo
67 .Cm import
68 .Op Fl b Ar branch
69 .Op Fl I Ar pattern
70 .Op Fl m Ar message
71 .Op Fl r Ar repository-path
72 .Ar directory
73 .Xc
74 .Dl Pq alias: Cm im
75 Create an initial commit in a repository from the file hierarchy
76 within the specified
77 .Ar directory .
78 The created commit will not have any parent commits, i.e. it will be a
79 root commit.
80 Also create a new reference which provides a branch name for the newly
81 created commit.
82 Show the path of each imported file to indicate progress.
83 .Pp
84 The
85 .Cm got import
86 command requires the
87 .Ev GOT_AUTHOR
88 environment variable to be set,
89 unless an author has been configured in
90 .Xr got.conf 5
91 or Git's
92 .Dv user.name
93 and
94 .Dv user.email
95 configuration settings can be obtained from the repository's
96 .Pa .git/config
97 file or from Git's global
98 .Pa ~/.gitconfig
99 configuration file.
100 .Pp
101 The options for
102 .Cm got import
103 are as follows:
104 .Bl -tag -width Ds
105 .It Fl b Ar branch
106 Create the specified
107 .Ar branch .
108 If this option is not specified, a branch corresponding to the repository's
109 HEAD reference will be used.
110 Use of this option is required if the branch resolved via the repository's
111 HEAD reference already exists.
112 .It Fl I Ar pattern
113 Ignore files or directories with a name which matches the specified
114 .Ar pattern .
115 This option may be specified multiple times to build a list of ignore patterns.
116 The
117 .Ar pattern
118 follows the globbing rules documented in
119 .Xr glob 7 .
120 Ignore patterns which end with a slash,
121 .Dq / ,
122 will only match directories.
123 .It Fl m Ar message
124 Use the specified log message when creating the new commit.
125 Without the
126 .Fl m
127 option,
128 .Cm got import
129 opens a temporary file in an editor where a log message can be written.
130 .It Fl r Ar repository-path
131 Use the repository at the specified path.
132 If not specified, assume the repository is located at or above the current
133 working directory.
134 .El
135 .Tg cl
136 .It Xo
137 .Cm clone
138 .Op Fl almqv
139 .Op Fl b Ar branch
140 .Op Fl R Ar reference
141 .Ar repository-URL
142 .Op Ar directory
143 .Xc
144 .Dl Pq alias: Cm cl
145 Clone a Git repository at the specified
146 .Ar repository-URL
147 into the specified
148 .Ar directory .
149 If no
150 .Ar directory
151 is specified, the directory name will be derived from the name of the
152 cloned repository.
153 .Cm got clone
154 will refuse to run if the
155 .Ar directory
156 already exists.
157 .Pp
158 The
159 .Ar repository-URL
160 specifies a protocol scheme, a server hostname, an optional port number
161 separated from the hostname by a colon, and a path to the repository on
162 the server:
163 .Lk scheme://hostname:port/path/to/repository
164 .Pp
165 The following protocol schemes are supported:
166 .Bl -tag -width git+ssh
167 .It git
168 The Git protocol as implemented by the
169 .Xr git-daemon 1
170 server.
171 Use of this protocol is discouraged since it supports neither authentication
172 nor encryption.
173 .It git+ssh
174 The Git protocol wrapped in an authenticated and encrypted
175 .Xr ssh 1
176 tunnel.
177 With this protocol the hostname may contain an embedded username for
178 .Xr ssh 1
179 to use:
180 .Mt user@hostname
181 .It ssh
182 Short alias for git+ssh.
183 .El
184 .Pp
185 Objects in the cloned repository are stored in a pack file which is downloaded
186 from the server.
187 This pack file will then be indexed to facilitate access to the objects stored
188 within.
189 If any objects in the pack file are stored in deltified form, all deltas will
190 be fully resolved in order to compute the ID of such objects.
191 This can take some time.
192 More details about the pack file format are documented in
193 .Xr git-repository 5 .
194 .Pp
195 .Cm got clone
196 creates a remote repository entry in the
197 .Xr got.conf 5
198 and
199 .Pa config
200 files of the cloned repository to store the
201 .Ar repository-url
202 and any
203 .Ar branch
204 or
205 .Ar reference
206 arguments for future use by
207 .Cm got fetch
208 or
209 .Xr git-fetch 1 .
210 .Pp
211 The options for
212 .Cm got clone
213 are as follows:
214 .Bl -tag -width Ds
215 .It Fl a
216 Fetch all branches from the remote repository's
217 .Dq refs/heads/
218 reference namespace and set
219 .Cm fetch_all_branches
220 in the cloned repository's
221 .Xr got.conf 5
222 file for future use by
223 .Cm got fetch .
224 If this option is not specified, a branch resolved via the remote
225 repository's HEAD reference will be fetched.
226 Cannot be used together with the
227 .Fl b
228 option.
229 .It Fl b Ar branch
230 Fetch the specified
231 .Ar branch
232 from the remote repository's
233 .Dq refs/heads/
234 reference namespace.
235 This option may be specified multiple times to build a list of branches
236 to fetch.
237 If the branch corresponding to the remote repository's HEAD reference is not
238 in this list, the cloned repository's HEAD reference will be set to the first
239 branch which was fetched.
240 If this option is not specified, a branch resolved via the remote
241 repository's HEAD reference will be fetched.
242 Cannot be used together with the
243 .Fl a
244 option.
245 .It Fl l
246 List branches and tags available for fetching from the remote repository
247 and exit immediately.
248 Cannot be used together with any of the other options except
249 .Fl q
250 and
251 .Fl v .
252 .It Fl m
253 Create the cloned repository as a mirror of the original repository.
254 This is useful if the cloned repository will not be used to store
255 locally created commits.
256 .Pp
257 The repository's
258 .Xr got.conf 5
259 and
260 .Pa config
261 files will be set up with the
262 .Dq mirror
263 option enabled, such that
264 .Cm got fetch
265 or
266 .Xr git-fetch 1
267 will write incoming changes directly to branches in the
268 .Dq refs/heads/
269 reference namespace, rather than to branches in the
270 .Dq refs/remotes/
271 namespace.
272 This avoids the usual requirement of having to run
273 .Cm got rebase
274 after
275 .Cm got fetch
276 in order to make incoming changes appear on branches in the
277 .Dq refs/heads/
278 namespace.
279 But maintaining custom changes in the cloned repository becomes difficult
280 since such changes will be at risk of being discarded whenever incoming
281 changes are fetched.
282 .It Fl q
283 Suppress progress reporting output.
284 The same option will be passed to
285 .Xr ssh 1
286 if applicable.
287 .It Fl R Ar reference
288 In addition to the branches and tags that will be fetched, fetch an arbitrary
289 .Ar reference
290 from the remote repository's
291 .Dq refs/
292 namespace.
293 This option may be specified multiple times to build a list of additional
294 references to fetch.
295 The specified
296 .Ar reference
297 may either be a path to a specific reference, or a reference namespace
298 which will cause all references in this namespace to be fetched.
299 .Pp
300 Each reference will be mapped into the cloned repository's
301 .Dq refs/remotes/
302 namespace, unless the
303 .Fl m
304 option is used to mirror references directly into the cloned repository's
305 .Dq refs/
306 namespace.
307 .Pp
308 .Cm got clone
309 will refuse to fetch references from the remote repository's
310 .Dq refs/remotes/
311 or
312 .Dq refs/got/
313 namespace.
314 .It Fl v
315 Verbose mode.
316 Causes
317 .Cm got clone
318 to print debugging messages to standard error output.
319 This option will be passed to
320 .Xr ssh 1
321 if applicable.
322 Multiple -v options increase the verbosity.
323 The maximum is 3.
324 .El
325 .Tg fe
326 .It Xo
327 .Cm fetch
328 .Op Fl adlqtvX
329 .Op Fl b Ar branch
330 .Op Fl R Ar reference
331 .Op Fl r Ar repository-path
332 .Op Ar remote-repository
333 .Xc
334 .Dl Pq alias: Cm fe
335 Fetch new changes from a remote repository.
336 If no
337 .Ar remote-repository
338 is specified,
339 .Dq origin
340 will be used.
341 The remote repository's URL is obtained from the corresponding entry in
342 .Xr got.conf 5
343 or Git's
344 .Pa config
345 file of the local repository, as created by
346 .Cm got clone .
347 .Pp
348 By default, any branches configured in
349 .Xr got.conf 5
350 for the
351 .Ar remote-repository
352 will be fetched.
353 If
354 .Cm got fetch
355 is invoked in a work tree then this work tree's current branch will be
356 fetched, too, provided it is present on the server.
357 This default behaviour can be overridden with the
358 .Fl a
359 and
360 .Fl b
361 options.
362 If no branches to fetch can be found in
363 .Xr got.conf 5 ,
364 on the command line, or via a work tree, a branch resolved via the remote
365 repository's HEAD reference will be fetched.
366 .Pp
367 New changes will be stored in a separate pack file downloaded from the server.
368 Optionally, separate pack files stored in the repository can be combined with
369 .Xr git-repack 1 .
370 .Pp
371 By default, branch references in the
372 .Dq refs/remotes/
373 reference namespace will be updated to point at the newly fetched commits.
374 The
375 .Cm got rebase
376 command can then be used to make new changes visible on branches in the
377 .Dq refs/heads/
378 namespace, merging incoming changes with the changes on those branches
379 as necessary.
380 .Pp
381 If the repository was created as a mirror with
382 .Cm got clone -m ,
383 then all branches in the
384 .Dq refs/heads/
385 namespace will be updated directly to match the corresponding branches in
386 the remote repository.
387 If those branches contained local commits, these commits will no longer be
388 reachable via a reference and will therefore be at risk of being discarded
389 by Git's garbage collector or
390 .Cm gotadmin cleanup .
391 Maintaining custom changes in a mirror repository is therefore discouraged.
392 .Pp
393 In any case, references in the
394 .Dq refs/tags/
395 namespace will always be fetched and mapped directly to local references
396 in the same namespace.
397 .Pp
398 The options for
399 .Cm got fetch
400 are as follows:
401 .Bl -tag -width Ds
402 .It Fl a
403 Fetch all branches from the remote repository's
404 .Dq refs/heads/
405 reference namespace.
406 This option can be enabled by default for specific repositories in
407 .Xr got.conf 5 .
408 Cannot be used together with the
409 .Fl b
410 option.
411 .It Fl b Ar branch
412 Fetch the specified
413 .Ar branch
414 from the remote repository's
415 .Dq refs/heads/
416 reference namespace.
417 This option may be specified multiple times to build a list of branches
418 to fetch.
419 Cannot be used together with the
420 .Fl a
421 option.
422 .It Fl d
423 Delete branches and tags from the local repository which are no longer
424 present in the remote repository.
425 Only references are deleted.
426 Any commit, tree, tag, and blob objects belonging to deleted branches or
427 tags remain in the repository and may be removed separately with
428 Git's garbage collector or
429 .Cm gotadmin cleanup .
430 .It Fl l
431 List branches and tags available for fetching from the remote repository
432 and exit immediately.
433 Cannot be used together with any of the other options except
434 .Fl v ,
435 .Fl q ,
436 and
437 .Fl r .
438 .It Fl q
439 Suppress progress reporting output.
440 The same option will be passed to
441 .Xr ssh 1
442 if applicable.
443 .It Fl R Ar reference
444 In addition to the branches and tags that will be fetched, fetch an arbitrary
445 .Ar reference
446 from the remote repository's
447 .Dq refs/
448 namespace.
449 This option may be specified multiple times to build a list of additional
450 references to fetch.
451 The specified
452 .Ar reference
453 may either be a path to a specific reference, or a reference namespace
454 which will cause all references in this namespace to be fetched.
455 .Pp
456 Each reference will be mapped into the local repository's
457 .Dq refs/remotes/
458 namespace, unless the local repository was created as a mirror with
459 .Cm got clone -m
460 in which case references will be mapped directly into the local repository's
461 .Dq refs/
462 namespace.
463 .Pp
464 Once a reference has been fetched, a branch based on it can be created with
465 .Cm got branch
466 if needed.
467 .Pp
468 .Cm got fetch
469 will refuse to fetch references from the remote repository's
470 .Dq refs/remotes/
471 or
472 .Dq refs/got/
473 namespace.
474 .It Fl r Ar repository-path
475 Use the repository at the specified path.
476 If not specified, assume the repository is located at or above the current
477 working directory.
478 If this directory is a
479 .Nm
480 work tree, use the repository path associated with this work tree.
481 .It Fl t
482 Allow existing references in the
483 .Dq refs/tags
484 namespace to be updated if they have changed on the server.
485 If not specified, only new tag references will be created.
486 .It Fl v
487 Verbose mode.
488 Causes
489 .Cm got fetch
490 to print debugging messages to standard error output.
491 The same option will be passed to
492 .Xr ssh 1
493 if applicable.
494 Multiple -v options increase the verbosity.
495 The maximum is 3.
496 .It Fl X
497 Delete all references which correspond to a particular
498 .Ar remote-repository
499 instead of fetching new changes.
500 This can be useful when a remote repository is being removed from
501 .Xr got.conf 5 .
502 .Pp
503 With
504 .Fl X ,
505 the
506 .Ar remote-repository
507 argument is mandatory and no other options except
508 .Fl r ,
509 .Fl v ,
510 and
511 .Fl q
512 are allowed.
513 .Pp
514 Only references are deleted.
515 Any commit, tree, tag, and blob objects fetched from a remote repository
516 will generally be stored in pack files and may be removed separately with
517 .Xr git-repack 1
518 and Git's garbage collector.
519 .El
520 .Tg co
521 .It Xo
522 .Cm checkout
523 .Op Fl Eq
524 .Op Fl b Ar branch
525 .Op Fl c Ar commit
526 .Op Fl p Ar path-prefix
527 .Ar repository-path
528 .Op Ar work-tree-path
529 .Xc
530 .Dl Pq alias: Cm co
531 Copy files from a repository into a new work tree.
532 Show the status of each affected file, using the following status codes:
533 .Bl -column YXZ description
534 .It A Ta new file was added
535 .It E Ta file already exists in work tree's meta-data
536 .El
537 .Pp
538 If the
539 .Ar work tree path
540 is not specified, either use the last component of
541 .Ar repository path ,
542 or if a
543 .Ar path prefix
544 was specified use the last component of
545 .Ar path prefix .
546 .Pp
547 The options for
548 .Cm got checkout
549 are as follows:
550 .Bl -tag -width Ds
551 .It Fl b Ar branch
552 Check out files from a commit on the specified
553 .Ar branch .
554 If this option is not specified, a branch resolved via the repository's HEAD
555 reference will be used.
556 .It Fl c Ar commit
557 Check out files from the specified
558 .Ar commit
559 on the selected branch.
560 The expected argument is a commit ID SHA1 hash or an existing reference
561 or tag name which will be resolved to a commit ID.
562 An abbreviated hash argument will be expanded to a full SHA1 hash
563 automatically, provided the abbreviation is unique.
564 If this option is not specified, the most recent commit on the selected
565 branch will be used.
566 .Pp
567 If the specified
568 .Ar commit
569 is not contained in the selected branch, a different branch which contains
570 this commit must be specified with the
571 .Fl b
572 option.
573 If no such branch is known, a new branch must be created for this
574 commit with
575 .Cm got branch
576 before
577 .Cm got checkout
578 can be used.
579 Checking out work trees with an unknown branch is intentionally not supported.
580 .It Fl E
581 Proceed with the checkout operation even if the directory at
582 .Ar work-tree-path
583 is not empty.
584 Existing files will be left intact.
585 .It Fl p Ar path-prefix
586 Restrict the work tree to a subset of the repository's tree hierarchy.
587 Only files beneath the specified
588 .Ar path-prefix
589 will be checked out.
590 .It Fl q
591 Silence progress output.
592 .El
593 .Tg up
594 .It Xo
595 .Cm update
596 .Op Fl q
597 .Op Fl b Ar branch
598 .Op Fl c Ar commit
599 .Op Ar path ...
600 .Xc
601 .Dl Pq alias: Cm up
602 Update an existing work tree to a different
603 .Ar commit .
604 Change existing files in the work tree as necessary to match file contents
605 of this commit.
606 Preserve any local changes in the work tree and merge them with the
607 incoming changes.
608 .Pp
609 Files which already contain merge conflicts will not be updated to avoid
610 further complications.
611 Such files will be updated when
612 .Cm got update
613 is run again after merge conflicts have been resolved.
614 If the conflicting changes are no longer needed, affected files can be
615 reverted with
616 .Cm got revert
617 before running
618 .Cm got update
619 again.
620 .Pp
621 Show the status of each affected file, using the following status codes:
622 .Bl -column YXZ description
623 .It U Ta file was updated and contained no local changes
624 .It G Ta file was updated and local changes were merged cleanly
625 .It C Ta file was updated and conflicts occurred during merge
626 .It D Ta file was deleted
627 .It A Ta new file was added
628 .It \(a~ Ta versioned file is obstructed by a non-regular file
629 .It ! Ta a missing versioned file was restored
630 .It # Ta file was not updated because it contains merge conflicts
631 .It ? Ta changes destined for an unversioned file were not merged
632 .El
633 .Pp
634 If no
635 .Ar path
636 is specified, update the entire work tree.
637 Otherwise, restrict the update operation to files at or within the
638 specified paths.
639 Each path is required to exist in the update operation's target commit.
640 Files in the work tree outside specified paths will remain unchanged and
641 will retain their previously recorded base commit.
642 Some
643 .Nm
644 commands may refuse to run while the work tree contains files from
645 multiple base commits.
646 The base commit of such a work tree can be made consistent by running
647 .Cm got update
648 across the entire work tree.
649 Specifying a
650 .Ar path
651 is incompatible with the
652 .Fl b
653 option.
654 .Pp
655 .Cm got update
656 cannot update paths with staged changes.
657 If changes have been staged with
658 .Cm got stage ,
659 these changes must first be committed with
660 .Cm got commit
661 or unstaged with
662 .Cm got unstage .
663 .Pp
664 The options for
665 .Cm got update
666 are as follows:
667 .Bl -tag -width Ds
668 .It Fl b Ar branch
669 Switch the work tree's branch reference to the specified
670 .Ar branch
671 before updating the work tree.
672 This option requires that all paths in the work tree are updated.
673 .Pp
674 As usual, any local changes in the work tree will be preserved.
675 This can be useful when switching to a newly created branch in order
676 to commit existing local changes to this branch.
677 .Pp
678 Any local changes must be dealt with separately in order to obtain a
679 work tree with pristine file contents corresponding exactly to the specified
680 .Ar branch .
681 Such changes could first be committed to a different branch with
682 .Cm got commit ,
683 or could be discarded with
684 .Cm got revert .
685 .It Fl c Ar commit
686 Update the work tree to the specified
687 .Ar commit .
688 The expected argument is a commit ID SHA1 hash or an existing reference
689 or tag name which will be resolved to a commit ID.
690 An abbreviated hash argument will be expanded to a full SHA1 hash
691 automatically, provided the abbreviation is unique.
692 If this option is not specified, the most recent commit on the work tree's
693 branch will be used.
694 .It Fl q
695 Silence progress output.
696 .El
697 .Tg st
698 .It Xo
699 .Cm status
700 .Op Fl I
701 .Op Fl S Ar status-codes
702 .Op Fl s Ar status-codes
703 .Op Ar path ...
704 .Xc
705 .Dl Pq alias: Cm st
706 Show the current modification status of files in a work tree,
707 using the following status codes:
708 .Bl -column YXZ description
709 .It M Ta modified file
710 .It A Ta file scheduled for addition in next commit
711 .It D Ta file scheduled for deletion in next commit
712 .It C Ta modified or added file which contains merge conflicts
713 .It ! Ta versioned file was expected on disk but is missing
714 .It \(a~ Ta versioned file is obstructed by a non-regular file
715 .It ? Ta unversioned item not tracked by
716 .Nm
717 .It m Ta modified file modes (executable bit only)
718 .It N Ta non-existent
719 .Ar path
720 specified on the command line
721 .El
722 .Pp
723 If no
724 .Ar path
725 is specified, show modifications in the entire work tree.
726 Otherwise, show modifications at or within the specified paths.
727 .Pp
728 If changes have been staged with
729 .Cm got stage ,
730 staged changes are shown in the second output column, using the following
731 status codes:
732 .Bl -column YXZ description
733 .It M Ta file modification is staged
734 .It A Ta file addition is staged
735 .It D Ta file deletion is staged
736 .El
737 .Pp
738 Changes created on top of staged changes are indicated in the first column:
739 .Bl -column YXZ description
740 .It MM Ta file was modified after earlier changes have been staged
741 .It MA Ta file was modified after having been staged for addition
742 .El
743 .Pp
744 The options for
745 .Cm got status
746 are as follows:
747 .Bl -tag -width Ds
748 .It Fl I
749 Show unversioned files even if they match an ignore pattern.
750 .It Fl S Ar status-codes
751 Suppress the output of files with a modification status matching any of the
752 single-character status codes contained in the
753 .Ar status-codes
754 argument.
755 Any combination of codes from the above list of possible status codes
756 may be specified.
757 For staged files, status codes displayed in either column will be matched.
758 Cannot be used together with the
759 .Fl s
760 option.
761 .It Fl s Ar status-codes
762 Only show files with a modification status matching any of the
763 single-character status codes contained in the
764 .Ar status-codes
765 argument.
766 Any combination of codes from the above list of possible status codes
767 may be specified.
768 For staged files, status codes displayed in either column will be matched.
769 Cannot be used together with the
770 .Fl S
771 option.
772 .El
773 .Pp
774 For compatibility with
775 .Xr cvs 1
776 and
777 .Xr git 1 ,
778 .Cm got status
779 reads
780 .Xr glob 7
781 patterns from
782 .Pa .cvsignore
783 and
784 .Pa .gitignore
785 files in each traversed directory and will not display unversioned files
786 which match these patterns.
787 As an extension to
788 .Xr glob 7
789 matching rules,
790 .Cm got status
791 supports consecutive asterisks,
792 .Dq ** ,
793 which will match an arbitrary amount of directories.
794 Unlike
795 .Xr cvs 1 ,
796 .Cm got status
797 only supports a single ignore pattern per line.
798 Unlike
799 .Xr git 1 ,
800 .Cm got status
801 does not support negated ignore patterns prefixed with
802 .Dq \&! ,
803 and gives no special significance to the location of path component separators,
804 .Dq / ,
805 in a pattern.
806 .It Xo
807 .Cm log
808 .Op Fl bdPpRs
809 .Op Fl C Ar number
810 .Op Fl c Ar commit
811 .Op Fl l Ar N
812 .Op Fl r Ar repository-path
813 .Op Fl S Ar search-pattern
814 .Op Fl x Ar commit
815 .Op Ar path
816 .Xc
817 Display history of a repository.
818 If a
819 .Ar path
820 is specified, show only commits which modified this path.
821 If invoked in a work tree, the
822 .Ar path
823 is interpreted relative to the current working directory,
824 and the work tree's path prefix is implicitly prepended.
825 Otherwise, the path is interpreted relative to the repository root.
826 .Pp
827 The options for
828 .Cm got log
829 are as follows:
830 .Bl -tag -width Ds
831 .It Fl b
832 Display individual commits which were merged into the current branch
833 from other branches.
834 By default,
835 .Cm got log
836 shows the linear history of the current branch only.
837 .It Fl C Ar number
838 Set the number of context lines shown in diffs with
839 .Fl p .
840 By default, 3 lines of context are shown.
841 .It Fl c Ar commit
842 Start traversing history at the specified
843 .Ar commit .
844 The expected argument is a commit ID SHA1 hash or an existing reference
845 or tag name which will be resolved to a commit ID.
846 An abbreviated hash argument will be expanded to a full SHA1 hash
847 automatically, provided the abbreviation is unique.
848 If this option is not specified, default to the work tree's current branch
849 if invoked in a work tree, or to the repository's HEAD reference.
850 .It Fl d
851 Display diffstat of changes introduced in each commit.
852 Cannot be used with the
853 .Fl s
854 option.
855 .It Fl l Ar N
856 Limit history traversal to a given number of commits.
857 If this option is not specified, a default limit value of zero is used,
858 which is treated as an unbounded limit.
859 The
860 .Ev GOT_LOG_DEFAULT_LIMIT
861 environment variable may be set to change this default value.
862 .It Fl P
863 Display the list of file paths changed in each commit, using the following
864 status codes:
865 .Bl -column YXZ description
866 .It M Ta modified file
867 .It D Ta file was deleted
868 .It A Ta new file was added
869 .It m Ta modified file modes (executable bit only)
870 .El
871 .Pp
872 Cannot be used with the
873 .Fl s
874 option.
875 .It Fl p
876 Display the patch of modifications made in each commit.
877 If a
878 .Ar path
879 is specified, only show the patch of modifications at or within this path.
880 Cannot be used with the
881 .Fl s
882 option.
883 .It Fl R
884 Determine a set of commits to display as usual, but display these commits
885 in reverse order.
886 .It Fl r Ar repository-path
887 Use the repository at the specified path.
888 If not specified, assume the repository is located at or above the current
889 working directory.
890 If this directory is a
891 .Nm
892 work tree, use the repository path associated with this work tree.
893 .It Fl S Ar search-pattern
894 If specified, show only commits with a log message, author name,
895 committer name, or ID SHA1 hash matched by the extended regular
896 expression
897 .Ar search-pattern .
898 Lines in committed patches will be matched if
899 .Fl p
900 is specified.
901 File paths changed by a commit will be matched if
902 .Fl P
903 is specified.
904 Regular expression syntax is documented in
905 .Xr re_format 7 .
906 .It Fl s
907 Display a short one-line summary of each commit, instead of the default
908 history format.
909 Cannot be used together with the
910 .Fl p
911 or
912 .Fl P
913 option.
914 .It Fl x Ar commit
915 Stop traversing commit history immediately after the specified
916 .Ar commit
917 has been traversed.
918 This option has no effect if the specified
919 .Ar commit
920 is never traversed.
921 .El
922 .Tg di
923 .It Xo
924 .Cm diff
925 .Op Fl adPsw
926 .Op Fl C Ar number
927 .Op Fl c Ar commit
928 .Op Fl r Ar repository-path
929 .Op Ar object1 Ar object2 | Ar path ...
930 .Xc
931 .Dl Pq alias: Cm di
932 When invoked within a work tree without any arguments, display all
933 local changes in the work tree.
934 If one or more
935 .Ar path
936 arguments are specified, only show changes within the specified paths.
937 .Pp
938 If two arguments are provided, treat each argument as a reference, a tag
939 name, or an object ID SHA1 hash, and display differences between the
940 corresponding objects.
941 Both objects must be of the same type (blobs, trees, or commits).
942 An abbreviated hash argument will be expanded to a full SHA1 hash
943 automatically, provided the abbreviation is unique.
944 If none of these interpretations produce a valid result or if the
945 .Fl P
946 option is used,
947 and if
948 .Cm got diff
949 is running in a work tree, attempt to interpret the two arguments as paths.
950 .Pp
951 The options for
952 .Cm got diff
953 are as follows:
954 .Bl -tag -width Ds
955 .It Fl a
956 Treat file contents as ASCII text even if binary data is detected.
957 .It Fl C Ar number
958 Set the number of context lines shown in the diff.
959 By default, 3 lines of context are shown.
960 .It Fl c Ar commit
961 Show differences between commits in the repository.
962 This option may be used up to two times.
963 When used only once, show differences between the specified
964 .Ar commit
965 and its first parent commit.
966 When used twice, show differences between the two specified commits.
967 .Pp
968 The expected argument is a commit ID SHA1 hash or an existing reference
969 or tag name which will be resolved to a commit ID.
970 An abbreviated hash argument will be expanded to a full SHA1 hash
971 automatically, provided the abbreviation is unique.
972 .Pp
973 If the
974 .Fl c
975 option is used, all non-option arguments will be interpreted as paths.
976 If one or more such
977 .Ar path
978 arguments are provided, only show differences for the specified paths.
979 .Pp
980 Cannot be used together with the
981 .Fl P
982 option.
983 .It Fl d
984 Display diffstat of changes before the actual diff by annotating each file path
985 or blob hash being diffed with the total number of lines added and removed.
986 A summary line will display the total number of changes across all files.
987 .It Fl P
988 Interpret all arguments as paths only.
989 This option can be used to resolve ambiguity in cases where paths
990 look like tag names, reference names, or object IDs.
991 This option is only valid when
992 .Cm got diff
993 is invoked in a work tree.
994 .It Fl r Ar repository-path
995 Use the repository at the specified path.
996 If not specified, assume the repository is located at or above the current
997 working directory.
998 If this directory is a
999 .Nm
1000 work tree, use the repository path associated with this work tree.
1001 .It Fl s
1002 Show changes staged with
1003 .Cm got stage
1004 instead of showing local changes in the work tree.
1005 This option is only valid when
1006 .Cm got diff
1007 is invoked in a work tree.
1008 .It Fl w
1009 Ignore whitespace-only changes.
1010 .El
1011 .Tg bl
1012 .It Xo
1013 .Cm blame
1014 .Op Fl c Ar commit
1015 .Op Fl r Ar repository-path
1016 .Ar path
1017 .Xc
1018 .Dl Pq alias: Cm bl
1019 Display line-by-line history of a file at the specified path.
1020 .Pp
1021 The options for
1022 .Cm got blame
1023 are as follows:
1024 .Bl -tag -width Ds
1025 .It Fl c Ar commit
1026 Start traversing history at the specified
1027 .Ar commit .
1028 The expected argument is a commit ID SHA1 hash or an existing reference
1029 or tag name which will be resolved to a commit ID.
1030 An abbreviated hash argument will be expanded to a full SHA1 hash
1031 automatically, provided the abbreviation is unique.
1032 .It Fl r Ar repository-path
1033 Use the repository at the specified path.
1034 If not specified, assume the repository is located at or above the current
1035 working directory.
1036 If this directory is a
1037 .Nm
1038 work tree, use the repository path associated with this work tree.
1039 .El
1040 .Tg tr
1041 .It Xo
1042 .Cm tree
1043 .Op Fl iR
1044 .Op Fl c Ar commit
1045 .Op Fl r Ar repository-path
1046 .Op Ar path
1047 .Xc
1048 .Dl Pq alias: Cm tr
1049 Display a listing of files and directories at the specified
1050 directory path in the repository.
1051 Entries shown in this listing may carry one of the following trailing
1052 annotations:
1053 .Bl -column YXZ description
1054 .It @ Ta entry is a symbolic link
1055 .It / Ta entry is a directory
1056 .It * Ta entry is an executable file
1057 .It $ Ta entry is a Git submodule
1058 .El
1059 .Pp
1060 Symbolic link entries are also annotated with the target path of the link.
1061 .Pp
1062 If no
1063 .Ar path
1064 is specified, list the repository path corresponding to the current
1065 directory of the work tree, or the root directory of the repository
1066 if there is no work tree.
1067 .Pp
1068 The options for
1069 .Cm got tree
1070 are as follows:
1071 .Bl -tag -width Ds
1072 .It Fl c Ar commit
1073 List files and directories as they appear in the specified
1074 .Ar commit .
1075 The expected argument is a commit ID SHA1 hash or an existing reference
1076 or tag name which will be resolved to a commit ID.
1077 An abbreviated hash argument will be expanded to a full SHA1 hash
1078 automatically, provided the abbreviation is unique.
1079 .It Fl i
1080 Show object IDs of files (blob objects) and directories (tree objects).
1081 .It Fl R
1082 Recurse into sub-directories in the repository.
1083 .It Fl r Ar repository-path
1084 Use the repository at the specified path.
1085 If not specified, assume the repository is located at or above the current
1086 working directory.
1087 If this directory is a
1088 .Nm
1089 work tree, use the repository path associated with this work tree.
1090 .El
1091 .It Xo
1092 .Cm ref
1093 .Op Fl dlt
1094 .Op Fl c Ar object
1095 .Op Fl r Ar repository-path
1096 .Op Fl s Ar reference
1097 .Op Ar name
1098 .Xc
1099 Manage references in a repository.
1100 .Pp
1101 References may be listed, created, deleted, and changed.
1102 When creating, deleting, or changing a reference the specified
1103 .Ar name
1104 must be an absolute reference name, i.e. it must begin with
1105 .Dq refs/ .
1106 .Pp
1107 The options for
1108 .Cm got ref
1109 are as follows:
1110 .Bl -tag -width Ds
1111 .It Fl c Ar object
1112 Create a reference or change an existing reference.
1113 The reference with the specified
1114 .Ar name
1115 will point at the specified
1116 .Ar object .
1117 The expected
1118 .Ar object
1119 argument is a ID SHA1 hash or an existing reference or tag name which will
1120 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1121 Cannot be used together with any other options except
1122 .Fl r .
1123 .It Fl d
1124 Delete the reference with the specified
1125 .Ar name
1126 from the repository.
1127 Any commit, tree, tag, and blob objects belonging to deleted references
1128 remain in the repository and may be removed separately with
1129 Git's garbage collector or
1130 .Cm gotadmin cleanup .
1131 Cannot be used together with any other options except
1132 .Fl r .
1133 .It Fl l
1134 List references in the repository.
1135 If no
1136 .Ar name
1137 is specified, list all existing references in the repository.
1139 .Ar name
1140 is a reference namespace, list all references in this namespace.
1141 Otherwise, show only the reference with the given
1142 .Ar name .
1143 Cannot be used together with any other options except
1144 .Fl r
1145 and
1146 .Fl t .
1147 .It Fl r Ar repository-path
1148 Use the repository at the specified path.
1149 If not specified, assume the repository is located at or above the current
1150 working directory.
1151 If this directory is a
1152 .Nm
1153 work tree, use the repository path associated with this work tree.
1154 .It Fl s Ar reference
1155 Create a symbolic reference, or change an existing symbolic reference.
1156 The symbolic reference with the specified
1157 .Ar name
1158 will point at the specified
1159 .Ar reference
1160 which must already exist in the repository.
1161 Care should be taken not to create loops between references when
1162 this option is used.
1163 Cannot be used together with any other options except
1164 .Fl r .
1165 .It Fl t
1166 Sort listed references by modification time (most recently modified first)
1167 instead of sorting by lexicographical order.
1168 Use of this option requires the
1169 .Fl l
1170 option to be used as well.
1171 .El
1172 .Tg br
1173 .It Xo
1174 .Cm branch
1175 .Op Fl lnt
1176 .Op Fl c Ar commit
1177 .Op Fl d Ar name
1178 .Op Fl r Ar repository-path
1179 .Op Ar name
1180 .Xc
1181 .Dl Pq alias: Cm br
1182 Create, list, or delete branches.
1183 .Pp
1184 Local branches are managed via references which live in the
1185 .Dq refs/heads/
1186 reference namespace.
1187 The
1188 .Cm got branch
1189 command creates references in this namespace only.
1190 .Pp
1191 When deleting branches, the specified
1192 .Ar name
1193 is searched in the
1194 .Dq refs/heads
1195 reference namespace first.
1196 If no corresponding branch is found, the
1197 .Dq refs/remotes
1198 namespace will be searched next.
1199 .Pp
1200 If invoked in a work tree without any arguments, print the name of the
1201 work tree's current branch.
1202 .Pp
1203 If a
1204 .Ar name
1205 argument is passed, attempt to create a branch reference with the given name.
1206 By default the new branch reference will point at the latest commit on the
1207 work tree's current branch if invoked in a work tree, and otherwise to a commit
1208 resolved via the repository's HEAD reference.
1209 .Pp
1210 If invoked in a work tree, once the branch was created successfully
1211 switch the work tree's head reference to the newly created branch and
1212 update files across the entire work tree, just like
1213 .Cm got update -b Ar name
1214 would do.
1215 Show the status of each affected file, using the following status codes:
1216 .Bl -column YXZ description
1217 .It U Ta file was updated and contained no local changes
1218 .It G Ta file was updated and local changes were merged cleanly
1219 .It C Ta file was updated and conflicts occurred during merge
1220 .It D Ta file was deleted
1221 .It A Ta new file was added
1222 .It \(a~ Ta versioned file is obstructed by a non-regular file
1223 .It ! Ta a missing versioned file was restored
1224 .El
1225 .Pp
1226 The options for
1227 .Cm got branch
1228 are as follows:
1229 .Bl -tag -width Ds
1230 .It Fl c Ar commit
1231 Make a newly created branch reference point at the specified
1232 .Ar commit .
1233 The expected
1234 .Ar commit
1235 argument is a commit ID SHA1 hash or an existing reference
1236 or tag name which will be resolved to a commit ID.
1237 .It Fl d Ar name
1238 Delete the branch with the specified
1239 .Ar name
1240 from the
1241 .Dq refs/heads
1243 .Dq refs/remotes
1244 reference namespace.
1245 .Pp
1246 Only the branch reference is deleted.
1247 Any commit, tree, and blob objects belonging to the branch
1248 remain in the repository and may be removed separately with
1249 Git's garbage collector or
1250 .Cm gotadmin cleanup .
1251 .It Fl l
1252 List all existing branches in the repository, including copies of remote
1253 repositories' branches in the
1254 .Dq refs/remotes/
1255 reference namespace.
1256 .Pp
1257 If invoked in a work tree, the work tree's current branch is shown
1258 with one the following annotations:
1259 .Bl -column YXZ description
1260 .It * Ta work tree's base commit matches the branch tip
1261 .It \(a~ Ta work tree's base commit is out-of-date
1262 .El
1263 .It Fl n
1264 Do not switch and update the work tree after creating a new branch.
1265 .It Fl r Ar repository-path
1266 Use the repository at the specified path.
1267 If not specified, assume the repository is located at or above the current
1268 working directory.
1269 If this directory is a
1270 .Nm
1271 work tree, use the repository path associated with this work tree.
1272 .It Fl t
1273 Sort listed branches by modification time (most recently modified first)
1274 instead of sorting by lexicographical order.
1275 Branches in the
1276 .Dq refs/heads/
1277 reference namespace are listed before branches in
1278 .Dq refs/remotes/
1279 regardless.
1280 Use of this option requires the
1281 .Fl l
1282 option to be used as well.
1283 .El
1284 .It Xo
1285 .Cm tag
1286 .Op Fl lVv
1287 .Op Fl c Ar commit
1288 .Op Fl m Ar message
1289 .Op Fl r Ar repository-path
1290 .Op Fl s Ar signer-id
1291 .Ar name
1292 .Xc
1293 Manage tags in a repository.
1294 .Pp
1295 Tags are managed via references which live in the
1296 .Dq refs/tags/
1297 reference namespace.
1298 The
1299 .Cm got tag
1300 command operates on references in this namespace only.
1301 References in this namespace point at tag objects which contain a pointer
1302 to another object, a tag message, as well as author and timestamp information.
1303 .Pp
1304 Attempt to create a tag with the given
1305 .Ar name ,
1306 and make this tag point at the given
1307 .Ar commit .
1308 If no commit is specified, default to the latest commit on the work tree's
1309 current branch if invoked in a work tree, and to a commit resolved via
1310 the repository's HEAD reference otherwise.
1311 .Pp
1312 The options for
1313 .Cm got tag
1314 are as follows:
1315 .Bl -tag -width Ds
1316 .It Fl c Ar commit
1317 Make the newly created tag reference point at the specified
1318 .Ar commit .
1319 The expected
1320 .Ar commit
1321 argument is a commit ID SHA1 hash or an existing reference or tag name which
1322 will be resolved to a commit ID.
1323 An abbreviated hash argument will be expanded to a full SHA1 hash
1324 automatically, provided the abbreviation is unique.
1325 .It Fl l
1326 List all existing tags in the repository instead of creating a new tag.
1327 If a
1328 .Ar name
1329 argument is passed, show only the tag with the given
1330 .Ar name .
1331 .It Fl m Ar message
1332 Use the specified tag message when creating the new tag.
1333 Without the
1334 .Fl m
1335 option,
1336 .Cm got tag
1337 opens a temporary file in an editor where a tag message can be written.
1338 .It Fl r Ar repository-path
1339 Use the repository at the specified path.
1340 If not specified, assume the repository is located at or above the current
1341 working directory.
1342 If this directory is a
1343 .Nm
1344 work tree, use the repository path associated with this work tree.
1345 .It Fl s Ar signer-id
1346 While creating a new tag, sign this tag with the identity given in
1347 .Ar signer-id .
1348 .Pp
1349 For SSH-based signatures,
1350 .Ar signer-id
1351 is the path to a file which may refer to either a private SSH key,
1352 or a public SSH key with the private half available via
1353 .Xr ssh-agent 1 .
1354 .Cm got tag
1355 will sign the tag object by invoking
1356 .Xr ssh-keygen 1
1357 with the
1358 .Fl Y Cm sign
1359 command, using the signature namespace
1360 .Dq git
1361 for compatibility with
1362 .Xr git 1 .
1363 .It Fl V
1364 Verify tag object signatures.
1365 If a
1366 .Ar name
1367 is specified, show and verify the tag object with the provided name.
1368 Otherwise, list all tag objects and verify signatures where present.
1369 .Pp
1370 .Cm got tag
1371 verifies SSH-based signatures by invoking
1372 .Xr ssh-keygen 1
1373 with the options
1374 .Fl Y Cm verify Fl f Ar allowed_signers .
1375 A path to the
1376 .Ar allowed_signers
1377 file must be set in
1378 .Xr got.conf 5 ,
1379 otherwise verification is impossible.
1380 .It Fl v
1381 Verbose mode.
1382 During SSH signature creation and verification this option will be passed to
1383 .Xr ssh-keygen 1 .
1384 Multiple -v options increase the verbosity.
1385 The maximum is 3.
1386 .El
1387 .Pp
1388 By design, the
1389 .Cm got tag
1390 command will not delete tags or change existing tags.
1391 If a tag must be deleted, the
1392 .Cm got ref
1393 command may be used to delete a tag's reference.
1394 This should only be done if the tag has not already been copied to
1395 another repository.
1396 .It Xo
1397 .Cm add
1398 .Op Fl IR
1399 .Ar path ...
1400 .Xc
1401 Schedule unversioned files in a work tree for addition to the
1402 repository in the next commit.
1403 By default, files which match a
1404 .Cm got status
1405 ignore pattern will not be added.
1406 .Pp
1407 The options for
1408 .Cm got add
1409 are as follows:
1410 .Bl -tag -width Ds
1411 .It Fl I
1412 Add files even if they match a
1413 .Cm got status
1414 ignore pattern.
1415 .It Fl R
1416 Permit recursion into directories.
1417 If this option is not specified,
1418 .Cm got add
1419 will refuse to run if a specified
1420 .Ar path
1421 is a directory.
1422 .El
1423 .Tg rm
1424 .It Xo
1425 .Cm remove
1426 .Op Fl fkR
1427 .Op Fl s Ar status-codes
1428 .Ar path ...
1429 .Xc
1430 .Dl Pq alias: Cm rm
1431 Remove versioned files from a work tree and schedule them for deletion
1432 from the repository in the next commit.
1433 .Pp
1434 The options for
1435 .Cm got remove
1436 are as follows:
1437 .Bl -tag -width Ds
1438 .It Fl f
1439 Perform the operation even if a file contains local modifications,
1440 and do not raise an error if a specified
1441 .Ar path
1442 does not exist on disk.
1443 .It Fl k
1444 Keep affected files on disk.
1445 .It Fl R
1446 Permit recursion into directories.
1447 If this option is not specified,
1448 .Cm got remove
1449 will refuse to run if a specified
1450 .Ar path
1451 is a directory.
1452 .It Fl s Ar status-codes
1453 Only delete files with a modification status matching one of the
1454 single-character status codes contained in the
1455 .Ar status-codes
1456 argument.
1457 The following status codes may be specified:
1458 .Bl -column YXZ description
1459 .It M Ta modified file (this implies the
1460 .Fl f
1461 option)
1462 .It ! Ta versioned file expected on disk but missing
1463 .El
1464 .El
1465 .Tg pa
1466 .It Xo
1467 .Cm patch
1468 .Op Fl nR
1469 .Op Fl c Ar commit
1470 .Op Fl p Ar strip-count
1471 .Op Ar patchfile
1472 .Xc
1473 .Dl Pq alias: Cm pa
1474 Apply changes from
1475 .Ar patchfile
1476 to files in a work tree.
1477 Files added or removed by a patch will be scheduled for addition or removal in
1478 the work tree.
1479 .Pp
1480 The patch must be in the unified diff format as produced by
1481 .Cm got diff ,
1482 .Xr git-diff 1 ,
1483 or by
1484 .Xr diff 1
1485 and
1486 .Xr cvs 1
1487 diff when invoked with their
1488 .Fl u
1489 options.
1490 If no
1491 .Ar patchfile
1492 argument is provided, read unified diff data from standard input instead.
1493 .Pp
1494 If the
1495 .Ar patchfile
1496 contains multiple patches, then attempt to apply each of them in sequence.
1497 .Pp
1498 Show the status of each affected file, using the following status codes:
1499 .Bl -column XYZ description
1500 .It M Ta file was modified
1501 .It G Ta file was merged using a merge-base found in the repository
1502 .It C Ta file was merged and conflicts occurred during merge
1503 .It D Ta file was deleted
1504 .It A Ta file was added
1505 .It # Ta failed to patch the file
1506 .El
1507 .Pp
1508 If a change does not match at its exact line number, attempt to
1509 apply it somewhere else in the file if a good spot can be found.
1510 Otherwise, the patch will fail to apply.
1511 .Pp
1512 .Nm
1513 .Cm patch
1514 will refuse to apply a patch if certain preconditions are not met.
1515 Files to be deleted must already be under version control, and must
1516 not have been scheduled for deletion already.
1517 Files to be added must not yet be under version control and must not
1518 already be present on disk.
1519 Files to be modified must already be under version control and may not
1520 contain conflict markers.
1521 .Pp
1522 If an error occurs, the
1523 .Cm patch
1524 operation will be aborted.
1525 Any changes made to the work tree up to this point will be left behind.
1526 Such changes can be viewed with
1527 .Cm got diff
1528 and can be reverted with
1529 .Cm got revert
1530 if needed.
1531 .Pp
1532 The options for
1533 .Cm got patch
1534 are as follows:
1535 .Bl -tag -width Ds
1536 .It Fl c Ar commit
1537 Attempt to locate files within the specified
1538 .Ar commit
1539 for use as a merge-base for 3-way merges.
1540 Ideally, the specified
1541 .Ar commit
1542 should contain versions of files which the changes contained in the
1543 .Ar patchfile
1544 were based on.
1545 Files will be located by path, relative to the repository root.
1546 If the
1547 .Fl p
1548 option is used then leading path components will be stripped
1549 before paths are looked up in the repository.
1550 .Pp
1551 If the
1552 .Fl c
1553 option is not used then
1554 .Cm got patch
1555 will attempt to locate merge-bases via object IDs found in
1556 .Ar patchfile
1557 meta-data, such as produced by
1558 .Cm got diff
1560 .Xr git-diff 1 .
1561 Use of the
1562 .Fl c
1563 option is only recommended in the absence of such meta-data.
1564 .Pp
1565 In case no merge-base is available for a file, changes will be applied
1566 without doing a 3-way merge.
1567 Changes which do not apply cleanly may then be rejected entirely, rather
1568 than producing merge conflicts in the patched target file.
1569 .It Fl n
1570 Do not make any modifications to the work tree.
1571 This can be used to check whether a patch would apply without issues.
1572 If the
1573 .Ar patchfile
1574 contains diffs that affect the same file multiple times, the results
1575 displayed may be incorrect.
1576 .It Fl p Ar strip-count
1577 Specify the number of leading path components to strip from paths
1578 parsed from
1579 .Ar patchfile .
1580 If the
1581 .Fl p
1582 option is not used,
1583 .Sq a/
1584 and
1585 .Sq b/
1586 path prefixes generated by
1587 .Xr git-diff 1
1588 will be recognized and stripped automatically.
1589 .It Fl R
1590 Reverse the patch before applying it.
1591 .El
1592 .Tg rv
1593 .It Xo
1594 .Cm revert
1595 .Op Fl pR
1596 .Op Fl F Ar response-script
1597 .Ar path ...
1598 .Xc
1599 .Dl Pq alias: Cm rv
1600 Revert any local changes in files at the specified paths in a work tree.
1601 File contents will be overwritten with those contained in the
1602 work tree's base commit.
1603 There is no way to bring discarded changes back after
1604 .Cm got revert !
1605 .Pp
1606 If a file was added with
1607 .Cm got add ,
1608 it will become an unversioned file again.
1609 If a file was deleted with
1610 .Cm got remove ,
1611 it will be restored.
1612 .Pp
1613 The options for
1614 .Cm got revert
1615 are as follows:
1616 .Bl -tag -width Ds
1617 .It Fl F Ar response-script
1618 With the
1619 .Fl p
1620 option, read
1621 .Dq y ,
1622 .Dq n ,
1623 and
1624 .Dq q
1625 responses line-by-line from the specified
1626 .Ar response-script
1627 file instead of prompting interactively.
1628 .It Fl p
1629 Instead of reverting all changes in files, interactively select or reject
1630 changes to revert based on
1631 .Dq y
1632 (revert change),
1633 .Dq n
1634 (keep change), and
1635 .Dq q
1636 (quit reverting this file) responses.
1637 If a file is in modified status, individual patches derived from the
1638 modified file content can be reverted.
1639 Files in added or deleted status may only be reverted in their entirety.
1640 .It Fl R
1641 Permit recursion into directories.
1642 If this option is not specified,
1643 .Cm got revert
1644 will refuse to run if a specified
1645 .Ar path
1646 is a directory.
1647 .El
1648 .Tg ci
1649 .It Xo
1650 .Cm commit
1651 .Op Fl NnS
1652 .Op Fl A Ar author
1653 .Op Fl F Ar path
1654 .Op Fl m Ar message
1655 .Op Ar path ...
1656 .Xc
1657 .Dl Pq alias: Cm ci
1658 Create a new commit in the repository from changes in a work tree
1659 and use this commit as the new base commit for the work tree.
1660 If no
1661 .Ar path
1662 is specified, commit all changes in the work tree.
1663 Otherwise, commit changes at or within the specified paths.
1664 .Pp
1665 If changes have been explicitly staged for commit with
1666 .Cm got stage ,
1667 only commit staged changes and reject any specified paths which
1668 have not been staged.
1669 .Pp
1670 .Cm got commit
1671 opens a temporary file in an editor where a log message can be written
1672 unless the
1673 .Fl m
1674 option is used
1675 or the
1676 .Fl F
1677 and
1678 .Fl N
1679 options are used together.
1680 .Pp
1681 Show the status of each affected file, using the following status codes:
1682 .Bl -column YXZ description
1683 .It M Ta modified file
1684 .It D Ta file was deleted
1685 .It A Ta new file was added
1686 .It m Ta modified file modes (executable bit only)
1687 .El
1688 .Pp
1689 Files which are not part of the new commit will retain their previously
1690 recorded base commit.
1691 Some
1692 .Nm
1693 commands may refuse to run while the work tree contains files from
1694 multiple base commits.
1695 The base commit of such a work tree can be made consistent by running
1696 .Cm got update
1697 across the entire work tree.
1698 .Pp
1699 The
1700 .Cm got commit
1701 command requires the
1702 .Ev GOT_AUTHOR
1703 environment variable to be set,
1704 unless an author has been configured in
1705 .Xr got.conf 5
1706 or Git's
1707 .Dv user.name
1708 and
1709 .Dv user.email
1710 configuration settings can be
1711 obtained from the repository's
1712 .Pa .git/config
1713 file or from Git's global
1714 .Pa ~/.gitconfig
1715 configuration file.
1716 .Pp
1717 The options for
1718 .Cm got commit
1719 are as follows:
1720 .Bl -tag -width Ds
1721 .It Fl A Ar author
1722 Set author information in the newly created commit to
1723 .Ar author .
1724 This is useful when committing changes which were written by someone
1725 else.
1726 The
1727 .Ar author
1728 argument must use the same format as the
1729 .Ev GOT_AUTHOR
1730 environment variable.
1731 .Pp
1732 In addition to storing author information, the newly created commit
1733 object will retain
1734 .Dq committer
1735 information which is obtained, as usual, from the
1736 .Ev GOT_AUTHOR
1737 environment variable, or
1738 .Xr got.conf 5 ,
1739 or Git configuration settings.
1740 .It Fl F Ar path
1741 Use the prepared log message stored in the file found at
1742 .Ar path
1743 when creating the new commit.
1744 .Cm got commit
1745 opens a temporary file in an editor where the prepared log message can be
1746 reviewed and edited further if needed.
1747 Cannot be used together with the
1748 .Fl m
1749 option.
1750 .It Fl m Ar message
1751 Use the specified log message when creating the new commit.
1752 Cannot be used together with the
1753 .Fl F
1754 option.
1755 .It Fl N
1756 This option prevents
1757 .Cm got commit
1758 from opening the commit message in an editor.
1759 It has no effect unless it is used together with the
1760 .Fl F
1761 option and is intended for non-interactive use such as scripting.
1762 .It Fl n
1763 This option prevents
1764 .Cm got commit
1765 from generating a diff of the to-be-committed changes in a temporary file
1766 which can be viewed while editing a commit message.
1767 .It Fl S
1768 Allow the addition of symbolic links which point outside of the path space
1769 that is under version control.
1770 By default,
1771 .Cm got commit
1772 will reject such symbolic links due to safety concerns.
1773 As a precaution,
1774 .Nm
1775 may decide to represent such a symbolic link as a regular file which contains
1776 the link's target path, rather than creating an actual symbolic link which
1777 points outside of the work tree.
1778 Use of this option is discouraged because external mechanisms such as
1779 .Dq make obj
1780 are better suited for managing symbolic links to paths not under
1781 version control.
1782 .El
1783 .Pp
1784 .Cm got commit
1785 will refuse to run if certain preconditions are not met.
1786 If the work tree's current branch is not in the
1787 .Dq refs/heads/
1788 reference namespace, new commits may not be created on this branch.
1789 Local changes may only be committed if they are based on file content
1790 found in the most recent commit on the work tree's branch.
1791 If a path is found to be out of date,
1792 .Cm got update
1793 must be used first in order to merge local changes with changes made
1794 in the repository.
1795 .Tg se
1796 .It Xo
1797 .Cm send
1798 .Op Fl afqTv
1799 .Op Fl b Ar branch
1800 .Op Fl d Ar branch
1801 .Op Fl r Ar repository-path
1802 .Op Fl t Ar tag
1803 .Op Ar remote-repository
1804 .Xc
1805 .Dl Pq alias: Cm se
1806 Send new changes to a remote repository.
1807 If no
1808 .Ar remote-repository
1809 is specified,
1810 .Dq origin
1811 will be used.
1812 The remote repository's URL is obtained from the corresponding entry in
1813 .Xr got.conf 5
1814 or Git's
1815 .Pa config
1816 file of the local repository, as created by
1817 .Cm got clone .
1818 .Pp
1819 All objects corresponding to new changes will be written to a temporary
1820 pack file which is then uploaded to the server.
1821 Upon success, references in the
1822 .Dq refs/remotes/
1823 reference namespace of the local repository will be updated to point at
1824 the commits which have been sent.
1825 .Pp
1826 By default, changes will only be sent if they are based on up-to-date
1827 copies of relevant branches in the remote repository.
1828 If any changes to be sent are based on out-of-date copies or would
1829 otherwise break linear history of existing branches, new changes must
1830 be fetched from the server with
1831 .Cm got fetch
1832 and local branches must be rebased with
1833 .Cm got rebase
1834 before
1835 .Cm got send
1836 can succeed.
1837 The
1838 .Fl f
1839 option can be used to make exceptions to these requirements.
1840 .Pp
1841 The options for
1842 .Cm got send
1843 are as follows:
1844 .Bl -tag -width Ds
1845 .It Fl a
1846 Send all branches from the local repository's
1847 .Dq refs/heads/
1848 reference namespace.
1849 The
1850 .Fl a
1851 option is equivalent to listing all branches with multiple
1852 .Fl b
1853 options.
1854 Cannot be used together with the
1855 .Fl b
1856 option.
1857 .It Fl b Ar branch
1858 Send the specified
1859 .Ar branch
1860 from the local repository's
1861 .Dq refs/heads/
1862 reference namespace.
1863 This option may be specified multiple times to build a list of branches
1864 to send.
1865 If this option is not specified, default to the work tree's current branch
1866 if invoked in a work tree, or to the repository's HEAD reference.
1867 Cannot be used together with the
1868 .Fl a
1869 option.
1870 .It Fl d Ar branch
1871 Delete the specified
1872 .Ar branch
1873 from the remote repository's
1874 .Dq refs/heads/
1875 reference namespace.
1876 This option may be specified multiple times to build a list of branches
1877 to delete.
1878 .Pp
1879 Only references are deleted.
1880 Any commit, tree, tag, and blob objects belonging to deleted branches
1881 may become subject to deletion by Git's garbage collector running on
1882 the server.
1883 .Pp
1884 Requesting deletion of branches results in an error if the server
1885 does not support this feature or disallows the deletion of branches
1886 based on its configuration.
1887 .It Fl f
1888 Attempt to force the server to overwrite existing branches or tags
1889 in the remote repository, even when
1890 .Cm got fetch
1891 and
1892 .Cm got rebase
1893 would usually be required before changes can be sent.
1894 The server may reject forced requests regardless, depending on its
1895 configuration.
1896 .Pp
1897 Any commit, tree, tag, and blob objects belonging to overwritten branches
1898 or tags may become subject to deletion by Git's garbage collector running
1899 on the server.
1900 .Pp
1901 The
1902 .Dq refs/tags
1903 reference namespace is globally shared between all repositories.
1904 Use of the
1905 .Fl f
1906 option to overwrite tags is discouraged because it can lead to
1907 inconsistencies between the tags present in different repositories.
1908 In general, creating a new tag with a different name is recommended
1909 instead of overwriting an existing tag.
1910 .Pp
1911 Use of the
1912 .Fl f
1913 option is particularly discouraged if changes being sent are based
1914 on an out-of-date copy of a branch in the remote repository.
1915 Instead of using the
1916 .Fl f
1917 option, new changes should
1918 be fetched with
1919 .Cm got fetch
1920 and local branches should be rebased with
1921 .Cm got rebase ,
1922 followed by another attempt to send the changes.
1923 .Pp
1924 The
1925 .Fl f
1926 option should only be needed in situations where the remote repository's
1927 copy of a branch or tag is known to be out-of-date and is considered
1928 disposable.
1929 The risks of creating inconsistencies between different repositories
1930 should also be taken into account.
1931 .It Fl q
1932 Suppress progress reporting output.
1933 The same option will be passed to
1934 .Xr ssh 1
1935 if applicable.
1936 .It Fl r Ar repository-path
1937 Use the repository at the specified path.
1938 If not specified, assume the repository is located at or above the current
1939 working directory.
1940 If this directory is a
1941 .Nm
1942 work tree, use the repository path associated with this work tree.
1943 .It Fl T
1944 Attempt to send all tags from the local repository's
1945 .Dq refs/tags/
1946 reference namespace.
1947 The
1948 .Fl T
1949 option is equivalent to listing all tags with multiple
1950 .Fl t
1951 options.
1952 Cannot be used together with the
1953 .Fl t
1954 option.
1955 .It Fl t Ar tag
1956 Send the specified
1957 .Ar tag
1958 from the local repository's
1959 .Dq refs/tags/
1960 reference namespace, in addition to any branches that are being sent.
1961 The
1962 .Fl t
1963 option may be specified multiple times to build a list of tags to send.
1964 No tags will be sent if the
1965 .Fl t
1966 option is not used.
1967 .Pp
1968 Raise an error if the specified
1969 .Ar tag
1970 already exists in the remote repository, unless the
1971 .Fl f
1972 option is used to overwrite the server's copy of the tag.
1973 In general, creating a new tag with a different name is recommended
1974 instead of overwriting an existing tag.
1975 .Pp
1976 Cannot be used together with the
1977 .Fl T
1978 option.
1979 .It Fl v
1980 Verbose mode.
1981 Causes
1982 .Cm got send
1983 to print debugging messages to standard error output.
1984 The same option will be passed to
1985 .Xr ssh 1
1986 if applicable.
1987 Multiple -v options increase the verbosity.
1988 The maximum is 3.
1989 .El
1990 .Tg cy
1991 .It Xo
1992 .Cm cherrypick
1993 .Op Fl lX
1994 .Op Ar commit
1995 .Xc
1996 .Dl Pq alias: Cm cy
1997 Merge changes from a single
1998 .Ar commit
1999 into the work tree.
2000 The specified
2001 .Ar commit
2002 should be on a different branch than the work tree's base commit.
2003 The expected argument is a reference or a commit ID SHA1 hash.
2004 An abbreviated hash argument will be expanded to a full SHA1 hash
2005 automatically, provided the abbreviation is unique.
2006 .Pp
2007 Show the status of each affected file, using the following status codes:
2008 .Bl -column YXZ description
2009 .It G Ta file was merged
2010 .It C Ta file was merged and conflicts occurred during merge
2011 .It ! Ta changes destined for a missing file were not merged
2012 .It D Ta file was deleted
2013 .It d Ta file's deletion was prevented by local modifications
2014 .It A Ta new file was added
2015 .It \(a~ Ta changes destined for a non-regular file were not merged
2016 .It ? Ta changes destined for an unversioned file were not merged
2017 .El
2018 .Pp
2019 The merged changes will appear as local changes in the work tree, which
2020 may be viewed with
2021 .Cm got diff ,
2022 amended manually or with further
2023 .Cm got cherrypick
2024 commands,
2025 committed with
2026 .Cm got commit .
2027 .Pp
2028 If invoked in a work tree where no
2029 .Cm rebase ,
2030 .Cm histedit ,
2032 .Cm merge
2033 operation is taking place,
2034 .Cm got cherrypick
2035 creates a record of commits which have been merged into the work tree.
2036 When a file changed by
2037 .Cm got cherrypick
2038 is committed with
2039 .Cm got commit ,
2040 the log messages of relevant merged commits will then appear in the editor,
2041 where the messages should be further adjusted to convey the reasons for
2042 cherrypicking the changes.
2043 Upon exiting the editor, if the time stamp of the log message file
2044 is unchanged or the log message is empty,
2045 .Cm got commit
2046 will fail with an unmodified or empty log message error.
2047 .Pp
2048 If all the changes in all files touched by a given commit are discarded,
2049 e.g. with
2050 .Cm got revert ,
2051 this commit's log message record will also disappear.
2052 .Pp
2053 .Cm got cherrypick
2054 will refuse to run if certain preconditions are not met.
2055 If the work tree contains multiple base commits, it must first be updated
2056 to a single base commit with
2057 .Cm got update .
2058 If any relevant files already contain merge conflicts, these
2059 conflicts must be resolved first.
2060 .Pp
2061 The options for
2062 .Nm
2063 .Cm cherrypick
2064 are as follows:
2065 .Bl -tag -width Ds
2066 .It Fl l
2067 Display a list of commit log messages recorded by cherrypick operations,
2068 represented by references in the
2069 .Dq refs/got/worktree
2070 reference namespace.
2071 If a
2072 .Ar commit
2073 is specified, only show the log message of the specified commit.
2074 .Pp
2075 If invoked in a work tree, only log messages recorded by cherrypick operations
2076 in the current work tree will be displayed.
2077 Otherwise, all commit log messages will be displayed irrespective of the
2078 work tree in which they were created.
2079 This option cannot be used with
2080 .Fl X .
2081 .It Fl X
2082 Delete log messages created by previous cherrypick operations, represented by
2083 references in the
2084 .Dq refs/got/worktree
2085 reference namespace.
2086 If a
2087 .Ar commit
2088 is specified, only delete the log message of the specified commit.
2089 .Pp
2090 If invoked in a work tree, only log messages recorded by cherrypick operations
2091 in the current work tree will be deleted.
2092 Otherwise, all commit log messages will be deleted irrespective of the
2093 work tree in which they were created.
2094 This option cannot be used with
2095 .Fl l .
2096 .El
2097 .Pp
2098 .Tg bo
2099 .It Xo
2100 .Cm backout
2101 .Op Fl lX
2102 .Op Ar commit
2103 .Xc
2104 .Dl Pq alias: Cm bo
2105 Reverse-merge changes from a single
2106 .Ar commit
2107 into the work tree.
2108 The specified
2109 .Ar commit
2110 should be on the same branch as the work tree's base commit.
2111 The expected argument is a reference or a commit ID SHA1 hash.
2112 An abbreviated hash argument will be expanded to a full SHA1 hash
2113 automatically, provided the abbreviation is unique.
2114 .Pp
2115 Show the status of each affected file, using the following status codes:
2116 .Bl -column YXZ description
2117 .It G Ta file was merged
2118 .It C Ta file was merged and conflicts occurred during merge
2119 .It ! Ta changes destined for a missing file were not merged
2120 .It D Ta file was deleted
2121 .It d Ta file's deletion was prevented by local modifications
2122 .It A Ta new file was added
2123 .It \(a~ Ta changes destined for a non-regular file were not merged
2124 .It ? Ta changes destined for an unversioned file were not merged
2125 .El
2126 .Pp
2127 The reverse-merged changes will appear as local changes in the work tree,
2128 which may be viewed with
2129 .Cm got diff ,
2130 amended manually or with further
2131 .Cm got backout
2132 commands,
2133 committed with
2134 .Cm got commit .
2135 .Pp
2136 If invoked in a work tree where no
2137 .Cm rebase ,
2138 .Cm histedit ,
2140 .Cm merge
2141 operation is taking place,
2142 .Cm got backout
2143 creates a record of commits which have been reverse-merged into the work tree.
2144 When a file changed by
2145 .Cm got backout
2146 is committed with
2147 .Cm got commit ,
2148 the log messages of relevant reverse-merged commits will then appear in
2149 the editor, where the messages should be further adjusted to convey the
2150 reasons for backing out the changes.
2151 Upon exiting the editor, if the time stamp of the log message file
2152 is unchanged or the log message is empty,
2153 .Cm got commit
2154 will fail with an unmodified or empty log message error.
2155 .Pp
2156 If all the changes in all files touched by a given commit are discarded,
2157 e.g. with
2158 .Cm got revert ,
2159 this commit's log message record will also disappear.
2160 .Pp
2161 .Cm got backout
2162 will refuse to run if certain preconditions are not met.
2163 If the work tree contains multiple base commits, it must first be updated
2164 to a single base commit with
2165 .Cm got update .
2166 If any relevant files already contain merge conflicts, these
2167 conflicts must be resolved first.
2168 .Pp
2169 The options for
2170 .Nm
2171 .Cm backout
2172 are as follows:
2173 .Bl -tag -width Ds
2174 .It Fl l
2175 Display a list of commit log messages recorded by backout operations,
2176 represented by references in the
2177 .Dq refs/got/worktree
2178 reference namespace.
2179 If a
2180 .Ar commit
2181 is specified, only show the log message of the specified commit.
2182 .Pp
2183 If invoked in a work tree, only log messages recorded by backout operations
2184 in the current work tree will be displayed.
2185 Otherwise, all commit log messages will be displayed irrespective of the
2186 work tree in which they were created.
2187 This option cannot be used with
2188 .Fl X .
2189 .It Fl X
2190 Delete log messages created by previous backout operations, represented by
2191 references in the
2192 .Dq refs/got/worktree
2193 reference namespace.
2194 If a
2195 .Ar commit
2196 is specified, only delete the log message of the specified commit.
2197 .Pp
2198 If invoked in a work tree, only log messages recorded by backout operations
2199 in the current work tree will be deleted.
2200 Otherwise, all commit log messages will be deleted irrespective of the
2201 work tree in which they were created.
2202 This option cannot be used with
2203 .Fl l .
2204 .El
2205 .Pp
2206 .Tg rb
2207 .It Xo
2208 .Cm rebase
2209 .Op Fl aclX
2210 .Op Ar branch
2211 .Xc
2212 .Dl Pq alias: Cm rb
2213 Rebase commits on the specified
2214 .Ar branch
2215 onto the tip of the current branch of the work tree.
2216 The
2217 .Ar branch
2218 must share common ancestry with the work tree's current branch.
2219 Rebasing begins with the first descendant commit of the youngest
2220 common ancestor commit shared by the specified
2221 .Ar branch
2222 and the work tree's current branch, and stops once the tip commit
2223 of the specified
2224 .Ar branch
2225 has been rebased.
2226 .Pp
2227 When
2228 .Cm got rebase
2229 is used as intended, the specified
2230 .Ar branch
2231 represents a local commit history and may already contain changes
2232 that are not yet visible in any other repositories.
2233 The work tree's current branch, which must be set with
2234 .Cm got update -b
2235 before starting the
2236 .Cm rebase
2237 operation, represents a branch from a remote repository which shares
2238 a common history with the specified
2239 .Ar branch
2240 but has progressed, and perhaps diverged, due to commits added to the
2241 remote repository.
2242 .Pp
2243 Rebased commits are accumulated on a temporary branch which the work tree
2244 will remain switched to throughout the entire rebase operation.
2245 Commits on this branch represent the same changes with the same log
2246 messages as their counterparts on the original
2247 .Ar branch ,
2248 but with different commit IDs.
2249 Once rebasing has completed successfully, the temporary branch becomes
2250 the new version of the specified
2251 .Ar branch
2252 and the work tree is automatically switched to it.
2253 If author information is available via the
2254 .Ev GOT_AUTHOR
2255 environment variable,
2256 .Xr got.conf 5
2257 or Git's
2258 .Dv user.name
2259 and
2260 .Dv user.email
2261 configuration settings, this author information will be used to identify
2262 the
2263 .Dq committer
2264 of rebased commits.
2265 .Pp
2266 Old commits in their pre-rebase state are automatically backed up in the
2267 .Dq refs/got/backup/rebase
2268 reference namespace.
2269 As long as these references are not removed older versions of rebased
2270 commits will remain in the repository and can be viewed with the
2271 .Cm got rebase -l
2272 command.
2273 Removal of these references makes objects which become unreachable via
2274 any reference subject to removal by Git's garbage collector or
2275 .Cm gotadmin cleanup .
2276 .Pp
2277 While rebasing commits, show the status of each affected file,
2278 using the following status codes:
2279 .Bl -column YXZ description
2280 .It G Ta file was merged
2281 .It C Ta file was merged and conflicts occurred during merge
2282 .It ! Ta changes destined for a missing file were not merged
2283 .It D Ta file was deleted
2284 .It d Ta file's deletion was prevented by local modifications
2285 .It A Ta new file was added
2286 .It \(a~ Ta changes destined for a non-regular file were not merged
2287 .It ? Ta changes destined for an unversioned file were not merged
2288 .El
2289 .Pp
2290 If merge conflicts occur, the rebase operation is interrupted and may
2291 be continued once conflicts have been resolved.
2292 If any files with destined changes are found to be missing or unversioned,
2293 or if files could not be deleted due to differences in deleted content,
2294 the rebase operation will be interrupted to prevent potentially incomplete
2295 changes from being committed to the repository without user intervention.
2296 The work tree may be modified as desired and the rebase operation can be
2297 continued once the changes present in the work tree are considered complete.
2298 Alternatively, the rebase operation may be aborted which will leave
2299 .Ar branch
2300 unmodified and the work tree switched back to its original branch.
2301 .Pp
2302 If a merge conflict is resolved in a way which renders the merged
2303 change into a no-op change, the corresponding commit will be elided
2304 when the rebase operation continues.
2305 .Pp
2306 .Cm got rebase
2307 will refuse to run if certain preconditions are not met.
2308 If the
2309 .Ar branch
2310 is not in the
2311 .Dq refs/heads/
2312 reference namespace, the branch may not be rebased.
2313 If the work tree is not yet fully updated to the tip commit of its
2314 branch, then the work tree must first be updated with
2315 .Cm got update .
2316 If changes have been staged with
2317 .Cm got stage ,
2318 these changes must first be committed with
2319 .Cm got commit
2320 or unstaged with
2321 .Cm got unstage .
2322 If the work tree contains local changes, these changes must first be
2323 committed with
2324 .Cm got commit
2325 or reverted with
2326 .Cm got revert .
2327 If the
2328 .Ar branch
2329 contains changes to files outside of the work tree's path prefix,
2330 the work tree cannot be used to rebase this branch.
2331 .Pp
2332 The
2333 .Cm got update ,
2334 .Cm got integrate ,
2335 .Cm got merge ,
2336 .Cm got commit ,
2337 and
2338 .Cm got histedit
2339 commands will refuse to run while a rebase operation is in progress.
2340 Other commands which manipulate the work tree may be used for
2341 conflict resolution purposes.
2342 .Pp
2343 If the specified
2344 .Ar branch
2345 is already based on the work tree's current branch, then no commits
2346 need to be rebased and
2347 .Cm got rebase
2348 will simply switch the work tree to the specified
2349 .Ar branch
2350 and update files in the work tree accordingly.
2351 .Pp
2352 The options for
2353 .Cm got rebase
2354 are as follows:
2355 .Bl -tag -width Ds
2356 .It Fl a
2357 Abort an interrupted rebase operation.
2358 If this option is used, no other command-line arguments are allowed.
2359 .It Fl c
2360 Continue an interrupted rebase operation.
2361 If this option is used, no other command-line arguments are allowed.
2362 .It Fl l
2363 Show a list of past rebase operations, represented by references in the
2364 .Dq refs/got/backup/rebase
2365 reference namespace.
2366 .Pp
2367 Display the author, date, and log message of each backed up commit,
2368 the object ID of the corresponding post-rebase commit, and
2369 the object ID of their common ancestor commit.
2370 Given these object IDs,
2371 the
2372 .Cm got log
2373 command with the
2374 .Fl c
2375 and
2376 .Fl x
2377 options can be used to examine the history of either version of the branch,
2378 and the
2379 .Cm got branch
2380 command with the
2381 .Fl c
2382 option can be used to create a new branch from a pre-rebase state if desired.
2383 .Pp
2384 If a
2385 .Ar branch
2386 is specified, only show commits which at some point in time represented this
2387 branch.
2388 Otherwise, list all backed up commits for any branches.
2389 .Pp
2390 If this option is used,
2391 .Cm got rebase
2392 does not require a work tree.
2393 None of the other options can be used together with
2394 .Fl l .
2395 .It Fl X
2396 Delete backups created by past rebase operations, represented by references
2397 in the
2398 .Dq refs/got/backup/rebase
2399 reference namespace.
2400 .Pp
2401 If a
2402 .Ar branch
2403 is specified, only delete backups which at some point in time represented
2404 this branch.
2405 Otherwise, delete all references found within
2406 .Dq refs/got/backup/rebase .
2407 .Pp
2408 Any commit, tree, tag, and blob objects belonging to deleted backups
2409 remain in the repository and may be removed separately with
2410 Git's garbage collector or
2411 .Cm gotadmin cleanup .
2412 .Pp
2413 If this option is used,
2414 .Cm got rebase
2415 does not require a work tree.
2416 None of the other options can be used together with
2417 .Fl X .
2418 .El
2419 .Tg he
2420 .It Xo
2421 .Cm histedit
2422 .Op Fl acdeflmX
2423 .Op Fl F Ar histedit-script
2424 .Op Ar branch
2425 .Xc
2426 .Dl Pq alias: Cm he
2427 Edit commit history between the work tree's current base commit and
2428 the tip commit of the work tree's current branch.
2429 .Pp
2430 The
2431 .Cm got histedit
2432 command requires the
2433 .Ev GOT_AUTHOR
2434 environment variable to be set,
2435 unless an author has been configured in
2436 .Xr got.conf 5
2437 or Git's
2438 .Dv user.name
2439 and
2440 .Dv user.email
2441 configuration settings can be obtained from the repository's
2442 .Pa .git/config
2443 file or from Git's global
2444 .Pa ~/.gitconfig
2445 configuration file.
2446 .Pp
2447 Before starting a
2448 .Cm histedit
2449 operation, the work tree's current branch must be set with
2450 .Cm got update -b
2451 to the branch which should be edited, unless this branch is already the
2452 current branch of the work tree.
2453 The tip of this branch represents the upper bound (inclusive) of commits
2454 touched by the
2455 .Cm histedit
2456 operation.
2457 .Pp
2458 Furthermore, the work tree's base commit
2459 must be set with
2460 .Cm got update -c
2461 to a point in this branch's commit history where editing should begin.
2462 This commit represents the lower bound (non-inclusive) of commits touched
2463 by the
2464 .Cm histedit
2465 operation.
2466 .Pp
2467 Editing of commit history is controlled via a
2468 .Ar histedit script
2469 which can be written in an editor based on a template, passed on the
2470 command line, or generated with the
2471 .Fl f
2473 .Fl m
2474 options.
2475 .Pp
2476 The format of the histedit script is line-based.
2477 Each line in the script begins with a command name, followed by
2478 whitespace and an argument.
2479 For most commands, the expected argument is a commit ID SHA1 hash.
2480 Any remaining text on the line is ignored.
2481 Lines which begin with the
2482 .Sq #
2483 character are ignored entirely.
2484 .Pp
2485 The available histedit script commands are as follows:
2486 .Bl -column YXZ pick-commit
2487 .It Cm pick Ar commit Ta Use the specified commit as it is.
2488 .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2489 merged into the work tree interrupt the histedit operation for amending.
2490 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2491 listed further below that will be used.
2492 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2493 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2494 a preceding
2495 .Cm pick
2497 .Cm edit
2498 command on the previous line of the histedit script.
2499 The optional
2500 .Ar log-message
2501 argument provides a new single-line log message to use.
2502 If the
2503 .Ar log-message
2504 argument is omitted, open an editor where a new log message can be written.
2505 .El
2506 .Pp
2507 Every commit in the history being edited must be mentioned in the script.
2508 Lines may be re-ordered to change the order of commits in the edited history.
2509 No commit may be listed more than once.
2510 .Pp
2511 Edited commits are accumulated on a temporary branch which the work tree
2512 will remain switched to throughout the entire histedit operation.
2513 Once history editing has completed successfully, the temporary branch becomes
2514 the new version of the work tree's branch and the work tree is automatically
2515 switched to it.
2516 .Pp
2517 Old commits in their pre-histedit state are automatically backed up in the
2518 .Dq refs/got/backup/histedit
2519 reference namespace.
2520 As long as these references are not removed older versions of edited
2521 commits will remain in the repository and can be viewed with the
2522 .Cm got histedit -l
2523 command.
2524 Removal of these references makes objects which become unreachable via
2525 any reference subject to removal by Git's garbage collector or
2526 .Cm gotadmin cleanup .
2527 .Pp
2528 While merging commits, show the status of each affected file,
2529 using the following status codes:
2530 .Bl -column YXZ description
2531 .It G Ta file was merged
2532 .It C Ta file was merged and conflicts occurred during merge
2533 .It ! Ta changes destined for a missing file were not merged
2534 .It D Ta file was deleted
2535 .It d Ta file's deletion was prevented by local modifications
2536 .It A Ta new file was added
2537 .It \(a~ Ta changes destined for a non-regular file were not merged
2538 .It ? Ta changes destined for an unversioned file were not merged
2539 .El
2540 .Pp
2541 If merge conflicts occur, the histedit operation is interrupted and may
2542 be continued once conflicts have been resolved.
2543 If any files with destined changes are found to be missing or unversioned,
2544 or if files could not be deleted due to differences in deleted content,
2545 the histedit operation will be interrupted to prevent potentially incomplete
2546 changes from being committed to the repository without user intervention.
2547 The work tree may be modified as desired and the histedit operation can be
2548 continued once the changes present in the work tree are considered complete.
2549 Alternatively, the histedit operation may be aborted which will leave
2550 the work tree switched back to its original branch.
2551 .Pp
2552 If a merge conflict is resolved in a way which renders the merged
2553 change into a no-op change, the corresponding commit will be elided
2554 when the histedit operation continues.
2555 .Pp
2556 .Cm got histedit
2557 will refuse to run if certain preconditions are not met.
2558 If the work tree's current branch is not in the
2559 .Dq refs/heads/
2560 reference namespace, the history of the branch may not be edited.
2561 If the work tree contains multiple base commits, it must first be updated
2562 to a single base commit with
2563 .Cm got update .
2564 If changes have been staged with
2565 .Cm got stage ,
2566 these changes must first be committed with
2567 .Cm got commit
2568 or unstaged with
2569 .Cm got unstage .
2570 If the work tree contains local changes, these changes must first be
2571 committed with
2572 .Cm got commit
2573 or reverted with
2574 .Cm got revert .
2575 If the edited history contains changes to files outside of the work tree's
2576 path prefix, the work tree cannot be used to edit the history of this branch.
2577 .Pp
2578 The
2579 .Cm got update ,
2580 .Cm got rebase ,
2581 .Cm got merge ,
2582 and
2583 .Cm got integrate
2584 commands will refuse to run while a histedit operation is in progress.
2585 Other commands which manipulate the work tree may be used, and the
2586 .Cm got commit
2587 command may be used to commit arbitrary changes to the temporary branch
2588 while the histedit operation is interrupted.
2589 .Pp
2590 The options for
2591 .Cm got histedit
2592 are as follows:
2593 .Bl -tag -width Ds
2594 .It Fl a
2595 Abort an interrupted histedit operation.
2596 If this option is used, no other command-line arguments are allowed.
2597 .It Fl c
2598 Continue an interrupted histedit operation.
2599 If this option is used, no other command-line arguments are allowed.
2600 .It Fl d
2601 Drop all commits.
2602 This option is a quick equivalent to a histedit script which drops all
2603 commits.
2604 The
2605 .Fl d
2606 option can only be used when starting a new histedit operation.
2607 If this option is used, no other command-line arguments are allowed.
2608 .It Fl e
2609 Interrupt the histedit operation for editing after merging each commit.
2610 This option is a quick equivalent to a histedit script which uses the
2611 .Cm edit
2612 command for all commits.
2613 The
2614 .Fl e
2615 option can only be used when starting a new histedit operation.
2616 If this option is used, no other command-line arguments are allowed.
2617 .It Fl F Ar histedit-script
2618 Use the specified
2619 .Ar histedit-script
2620 instead of opening a temporary file in an editor where a histedit script
2621 can be written.
2622 .It Fl f
2623 Fold all commits into a single commit.
2624 This option is a quick equivalent to a histedit script which folds all
2625 commits, combining them all into one commit.
2626 The
2627 .Fl f
2628 option can only be used when starting a new histedit operation.
2629 If this option is used, no other command-line arguments are allowed.
2630 .It Fl l
2631 Show a list of past histedit operations, represented by references in the
2632 .Dq refs/got/backup/histedit
2633 reference namespace.
2634 .Pp
2635 Display the author, date, and log message of each backed up commit,
2636 the object ID of the corresponding post-histedit commit, and
2637 the object ID of their common ancestor commit.
2638 Given these object IDs,
2639 the
2640 .Cm got log
2641 command with the
2642 .Fl c
2643 and
2644 .Fl x
2645 options can be used to examine the history of either version of the branch,
2646 and the
2647 .Cm got branch
2648 command with the
2649 .Fl c
2650 option can be used to create a new branch from a pre-histedit state if desired.
2651 .Pp
2652 If a
2653 .Ar branch
2654 is specified, only show commits which at some point in time represented this
2655 branch.
2656 Otherwise, list all backed up commits for any branches.
2657 .Pp
2658 If this option is used,
2659 .Cm got histedit
2660 does not require a work tree.
2661 None of the other options can be used together with
2662 .Fl l .
2663 .It Fl m
2664 Edit log messages only.
2665 This option is a quick equivalent to a histedit script which edits
2666 only log messages but otherwise leaves every picked commit as-is.
2667 The
2668 .Fl m
2669 option can only be used when starting a new histedit operation.
2670 If this option is used, no other command-line arguments are allowed.
2671 .It Fl X
2672 Delete backups created by past histedit operations, represented by references
2673 in the
2674 .Dq refs/got/backup/histedit
2675 reference namespace.
2676 .Pp
2677 If a
2678 .Ar branch
2679 is specified, only delete backups which at some point in time represented
2680 this branch.
2681 Otherwise, delete all references found within
2682 .Dq refs/got/backup/histedit .
2683 .Pp
2684 Any commit, tree, tag, and blob objects belonging to deleted backups
2685 remain in the repository and may be removed separately with
2686 Git's garbage collector or
2687 .Cm gotadmin cleanup .
2688 .Pp
2689 If this option is used,
2690 .Cm got histedit
2691 does not require a work tree.
2692 None of the other options can be used together with
2693 .Fl X .
2694 .El
2695 .Tg ig
2696 .It Cm integrate Ar branch
2697 .Dl Pq alias: Cm ig
2698 Integrate the specified
2699 .Ar branch
2700 into the work tree's current branch.
2701 Files in the work tree are updated to match the contents on the integrated
2702 .Ar branch ,
2703 and the reference of the work tree's branch is changed to point at the
2704 head commit of the integrated
2705 .Ar branch .
2706 .Pp
2707 Both branches can be considered equivalent after integration since they
2708 will be pointing at the same commit.
2709 Both branches remain available for future work, if desired.
2710 In case the integrated
2711 .Ar branch
2712 is no longer needed it may be deleted with
2713 .Cm got branch -d .
2714 .Pp
2715 Show the status of each affected file, using the following status codes:
2716 .Bl -column YXZ description
2717 .It U Ta file was updated
2718 .It D Ta file was deleted
2719 .It A Ta new file was added
2720 .It \(a~ Ta versioned file is obstructed by a non-regular file
2721 .It ! Ta a missing versioned file was restored
2722 .El
2723 .Pp
2724 .Cm got integrate
2725 will refuse to run if certain preconditions are not met.
2726 Most importantly, the
2727 .Ar branch
2728 must have been rebased onto the work tree's current branch with
2729 .Cm got rebase
2730 before it can be integrated, in order to linearize commit history and
2731 resolve merge conflicts.
2732 If the work tree contains multiple base commits, it must first be updated
2733 to a single base commit with
2734 .Cm got update .
2735 If changes have been staged with
2736 .Cm got stage ,
2737 these changes must first be committed with
2738 .Cm got commit
2739 or unstaged with
2740 .Cm got unstage .
2741 If the work tree contains local changes, these changes must first be
2742 committed with
2743 .Cm got commit
2744 or reverted with
2745 .Cm got revert .
2746 .Tg mg
2747 .It Xo
2748 .Cm merge
2749 .Op Fl acn
2750 .Op Ar branch
2751 .Xc
2752 .Dl Pq alias: Cm mg
2753 Create a merge commit based on the current branch of the work tree and
2754 the specified
2755 .Ar branch .
2756 If a linear project history is desired, then use of
2757 .Cm got rebase
2758 should be preferred over
2759 .Cm got merge .
2760 However, even strictly linear projects may require merge commits in order
2761 to merge in new versions of third-party code stored on vendor branches
2762 created with
2763 .Cm got import .
2764 .Pp
2765 Merge commits are commits based on multiple parent commits.
2766 The tip commit of the work tree's current branch, which must be set with
2767 .Cm got update -b
2768 before starting the
2769 .Cm merge
2770 operation, will be used as the first parent.
2771 The tip commit of the specified
2772 .Ar branch
2773 will be used as the second parent.
2774 .Pp
2775 No ancestral relationship between the two branches is required.
2776 If the two branches have already been merged previously, only new changes
2777 will be merged.
2778 .Pp
2779 It is not possible to create merge commits with more than two parents.
2780 If more than one branch needs to be merged, then multiple merge commits
2781 with two parents each can be created in sequence.
2782 .Pp
2783 While merging changes found on the
2784 .Ar branch
2785 into the work tree, show the status of each affected file,
2786 using the following status codes:
2787 .Bl -column YXZ description
2788 .It G Ta file was merged
2789 .It C Ta file was merged and conflicts occurred during merge
2790 .It ! Ta changes destined for a missing file were not merged
2791 .It D Ta file was deleted
2792 .It d Ta file's deletion was prevented by local modifications
2793 .It A Ta new file was added
2794 .It \(a~ Ta changes destined for a non-regular file were not merged
2795 .It ? Ta changes destined for an unversioned file were not merged
2796 .El
2797 .Pp
2798 If merge conflicts occur, the merge operation is interrupted and conflicts
2799 must be resolved before the merge operation can continue.
2800 If any files with destined changes are found to be missing or unversioned,
2801 or if files could not be deleted due to differences in deleted content,
2802 the merge operation will be interrupted to prevent potentially incomplete
2803 changes from being committed to the repository without user intervention.
2804 The work tree may be modified as desired and the merge can be continued
2805 once the changes present in the work tree are considered complete.
2806 Alternatively, the merge operation may be aborted which will leave
2807 the work tree's current branch unmodified.
2808 .Pp
2809 If a merge conflict is resolved in a way which renders all merged
2810 changes into no-op changes, the merge operation cannot continue
2811 and must be aborted.
2812 .Pp
2813 .Cm got merge
2814 will refuse to run if certain preconditions are not met.
2815 If history of the
2816 .Ar branch
2817 is based on the work tree's current branch, then no merge commit can
2818 be created and
2819 .Cm got integrate
2820 may be used to integrate the
2821 .Ar branch
2822 instead.
2823 If the work tree is not yet fully updated to the tip commit of its
2824 branch, then the work tree must first be updated with
2825 .Cm got update .
2826 If the work tree contains multiple base commits, it must first be updated
2827 to a single base commit with
2828 .Cm got update .
2829 If changes have been staged with
2830 .Cm got stage ,
2831 these changes must first be committed with
2832 .Cm got commit
2833 or unstaged with
2834 .Cm got unstage .
2835 If the work tree contains local changes, these changes must first be
2836 committed with
2837 .Cm got commit
2838 or reverted with
2839 .Cm got revert .
2840 If the
2841 .Ar branch
2842 contains changes to files outside of the work tree's path prefix,
2843 the work tree cannot be used to merge this branch.
2844 .Pp
2845 The
2846 .Cm got update ,
2847 .Cm got commit ,
2848 .Cm got rebase ,
2849 .Cm got histedit ,
2850 .Cm got integrate ,
2851 and
2852 .Cm got stage
2853 commands will refuse to run while a merge operation is in progress.
2854 Other commands which manipulate the work tree may be used for
2855 conflict resolution purposes.
2856 .Pp
2857 The options for
2858 .Cm got merge
2859 are as follows:
2860 .Bl -tag -width Ds
2861 .It Fl a
2862 Abort an interrupted merge operation.
2863 If this option is used, no other command-line arguments are allowed.
2864 .It Fl c
2865 Continue an interrupted merge operation.
2866 If this option is used, no other command-line arguments are allowed.
2867 .It Fl n
2868 Merge changes into the work tree as usual but do not create a merge
2869 commit immediately.
2870 The merge result can be adjusted as desired before a merge commit is
2871 created with
2872 .Cm got merge -c .
2873 Alternatively, the merge may be aborted with
2874 .Cm got merge -a .
2875 .El
2876 .Tg sg
2877 .It Xo
2878 .Cm stage
2879 .Op Fl lpS
2880 .Op Fl F Ar response-script
2881 .Op Ar path ...
2882 .Xc
2883 .Dl Pq alias: Cm sg
2884 Stage local changes for inclusion in the next commit.
2885 If no
2886 .Ar path
2887 is specified, stage all changes in the work tree.
2888 Otherwise, stage changes at or within the specified paths.
2889 Paths may be staged if they are added, modified, or deleted according to
2890 .Cm got status .
2891 .Pp
2892 Show the status of each affected file, using the following status codes:
2893 .Bl -column YXZ description
2894 .It A Ta file addition has been staged
2895 .It M Ta file modification has been staged
2896 .It D Ta file deletion has been staged
2897 .El
2898 .Pp
2899 Staged file contents are saved in newly created blob objects in the repository.
2900 These blobs will be referred to by tree objects once staged changes have been
2901 committed.
2902 .Pp
2903 Staged changes affect the behaviour of
2904 .Cm got commit ,
2905 .Cm got status ,
2906 and
2907 .Cm got diff .
2908 While paths with staged changes exist, the
2909 .Cm got commit
2910 command will refuse to commit any paths which do not have staged changes.
2911 Local changes created on top of staged changes can only be committed if
2912 the path is staged again, or if the staged changes are committed first.
2913 The
2914 .Cm got status
2915 command will show both local changes and staged changes.
2916 The
2917 .Cm got diff
2918 command is able to display local changes relative to staged changes,
2919 and to display staged changes relative to the repository.
2920 The
2921 .Cm got revert
2922 command cannot revert staged changes but may be used to revert
2923 local changes created on top of staged changes.
2924 .Pp
2925 The options for
2926 .Cm got stage
2927 are as follows:
2928 .Bl -tag -width Ds
2929 .It Fl F Ar response-script
2930 With the
2931 .Fl p
2932 option, read
2933 .Dq y ,
2934 .Dq n ,
2935 and
2936 .Dq q
2937 responses line-by-line from the specified
2938 .Ar response-script
2939 file instead of prompting interactively.
2940 .It Fl l
2941 Instead of staging new changes, list paths which are already staged,
2942 along with the IDs of staged blob objects and stage status codes.
2943 If paths were provided on the command line, show the staged paths
2944 among the specified paths.
2945 Otherwise, show all staged paths.
2946 .It Fl p
2947 Instead of staging the entire content of a changed file, interactively
2948 select or reject changes for staging based on
2949 .Dq y
2950 (stage change),
2951 .Dq n
2952 (reject change), and
2953 .Dq q
2954 (quit staging this file) responses.
2955 If a file is in modified status, individual patches derived from the
2956 modified file content can be staged.
2957 Files in added or deleted status may only be staged or rejected in
2958 their entirety.
2959 .It Fl S
2960 Allow staging of symbolic links which point outside of the path space
2961 that is under version control.
2962 By default,
2963 .Cm got stage
2964 will reject such symbolic links due to safety concerns.
2965 As a precaution,
2966 .Nm
2967 may decide to represent such a symbolic link as a regular file which contains
2968 the link's target path, rather than creating an actual symbolic link which
2969 points outside of the work tree.
2970 Use of this option is discouraged because external mechanisms such as
2971 .Dq make obj
2972 are better suited for managing symbolic links to paths not under
2973 version control.
2974 .El
2975 .Pp
2976 .Cm got stage
2977 will refuse to run if certain preconditions are not met.
2978 If a file contains merge conflicts, these conflicts must be resolved first.
2979 If a file is found to be out of date relative to the head commit on the
2980 work tree's current branch, the file must be updated with
2981 .Cm got update
2982 before it can be staged (however, this does not prevent the file from
2983 becoming out-of-date at some point after having been staged).
2984 .Pp
2985 The
2986 .Cm got update ,
2987 .Cm got rebase ,
2988 and
2989 .Cm got histedit
2990 commands will refuse to run while staged changes exist.
2991 If staged changes cannot be committed because a staged path
2992 is out of date, the path must be unstaged with
2993 .Cm got unstage
2994 before it can be updated with
2995 .Cm got update ,
2996 and may then be staged again if necessary.
2997 .Tg ug
2998 .It Xo
2999 .Cm unstage
3000 .Op Fl p
3001 .Op Fl F Ar response-script
3002 .Op Ar path ...
3003 .Xc
3004 .Dl Pq alias: Cm ug
3005 Merge staged changes back into the work tree and put affected paths
3006 back into non-staged status.
3007 If no
3008 .Ar path
3009 is specified, unstage all staged changes across the entire work tree.
3010 Otherwise, unstage changes at or within the specified paths.
3011 .Pp
3012 Show the status of each affected file, using the following status codes:
3013 .Bl -column YXZ description
3014 .It G Ta file was unstaged
3015 .It C Ta file was unstaged and conflicts occurred during merge
3016 .It ! Ta changes destined for a missing file were not merged
3017 .It D Ta file was staged as deleted and still is deleted
3018 .It d Ta file's deletion was prevented by local modifications
3019 .It \(a~ Ta changes destined for a non-regular file were not merged
3020 .El
3021 .Pp
3022 The options for
3023 .Cm got unstage
3024 are as follows:
3025 .Bl -tag -width Ds
3026 .It Fl F Ar response-script
3027 With the
3028 .Fl p
3029 option, read
3030 .Dq y ,
3031 .Dq n ,
3032 and
3033 .Dq q
3034 responses line-by-line from the specified
3035 .Ar response-script
3036 file instead of prompting interactively.
3037 .It Fl p
3038 Instead of unstaging the entire content of a changed file, interactively
3039 select or reject changes for unstaging based on
3040 .Dq y
3041 (unstage change),
3042 .Dq n
3043 (keep change staged), and
3044 .Dq q
3045 (quit unstaging this file) responses.
3046 If a file is staged in modified status, individual patches derived from the
3047 staged file content can be unstaged.
3048 Files staged in added or deleted status may only be unstaged in their entirety.
3049 .El
3050 .It Xo
3051 .Cm cat
3052 .Op Fl P
3053 .Op Fl c Ar commit
3054 .Op Fl r Ar repository-path
3055 .Ar arg ...
3056 .Xc
3057 Parse and print contents of objects to standard output in a line-based
3058 text format.
3059 Content of commit, tree, and tag objects is printed in a way similar
3060 to the actual content stored in such objects.
3061 Blob object contents are printed as they would appear in files on disk.
3062 .Pp
3063 Attempt to interpret each argument as a reference, a tag name, or
3064 an object ID SHA1 hash.
3065 References will be resolved to an object ID.
3066 Tag names will resolved to a tag object.
3067 An abbreviated hash argument will be expanded to a full SHA1 hash
3068 automatically, provided the abbreviation is unique.
3069 .Pp
3070 If none of the above interpretations produce a valid result, or if the
3071 .Fl P
3072 option is used, attempt to interpret the argument as a path which will
3073 be resolved to the ID of an object found at this path in the repository.
3074 .Pp
3075 The options for
3076 .Cm got cat
3077 are as follows:
3078 .Bl -tag -width Ds
3079 .It Fl c Ar commit
3080 Look up paths in the specified
3081 .Ar commit .
3082 If this option is not used, paths are looked up in the commit resolved
3083 via the repository's HEAD reference.
3084 The expected argument is a commit ID SHA1 hash or an existing reference
3085 or tag name which will be resolved to a commit ID.
3086 An abbreviated hash argument will be expanded to a full SHA1 hash
3087 automatically, provided the abbreviation is unique.
3088 .It Fl P
3089 Interpret all arguments as paths only.
3090 This option can be used to resolve ambiguity in cases where paths
3091 look like tag names, reference names, or object IDs.
3092 .It Fl r Ar repository-path
3093 Use the repository at the specified path.
3094 If not specified, assume the repository is located at or above the current
3095 working directory.
3096 If this directory is a
3097 .Nm
3098 work tree, use the repository path associated with this work tree.
3099 .El
3100 .It Cm info Op Ar path ...
3101 Display meta-data stored in a work tree.
3102 See
3103 .Xr got-worktree 5
3104 for details.
3105 .Pp
3106 The work tree to use is resolved implicitly by walking upwards from the
3107 current working directory.
3108 .Pp
3109 If one or more
3110 .Ar path
3111 arguments are specified, show additional per-file information for tracked
3112 files located at or within these paths.
3113 If a
3114 .Ar path
3115 argument corresponds to the work tree's root directory, display information
3116 for all tracked files.
3117 .El
3118 .Sh ENVIRONMENT
3119 .Bl -tag -width GOT_IGNORE_GITCONFIG
3120 .It Ev GOT_AUTHOR
3121 The author's name and email address, such as
3122 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3123 Used by the
3124 .Cm got commit ,
3125 .Cm got import ,
3126 .Cm got rebase ,
3127 and
3128 .Cm got histedit
3129 commands.
3130 Because
3131 .Xr git 1
3132 may fail to parse commits without an email address in author data,
3133 .Nm
3134 attempts to reject
3135 .Ev GOT_AUTHOR
3136 environment variables with a missing email address.
3137 .Pp
3138 .Ev GOT_AUTHOR will be overridden by configuration settings in
3139 .Xr got.conf 5
3140 or by Git's
3141 .Dv user.name
3142 and
3143 .Dv user.email
3144 configuration settings in the repository's
3145 .Pa .git/config
3146 file.
3147 The
3148 .Dv user.name
3149 and
3150 .Dv user.email
3151 configuration settings contained in Git's global
3152 .Pa ~/.gitconfig
3153 configuration file will only be used if neither
3154 .Xr got.conf 5
3155 nor the
3156 .Ev GOT_AUTHOR
3157 environment variable provide author information.
3158 .It Ev GOT_IGNORE_GITCONFIG
3159 If this variable is set then any remote repository definitions or author
3160 information found in Git configuration files will be ignored.
3161 .It Ev GOT_LOG_DEFAULT_LIMIT
3162 The default limit on the number of commits traversed by
3163 .Cm got log .
3164 If set to zero, the limit is unbounded.
3165 This variable will be silently ignored if it is set to a non-numeric value.
3166 .It Ev VISUAL , EDITOR
3167 The editor spawned by
3168 .Cm got commit ,
3169 .Cm got histedit ,
3170 .Cm got import ,
3172 .Cm got tag .
3173 If not set, the
3174 .Xr ed 1
3175 text editor will be spawned in order to give
3176 .Xr ed 1
3177 the attention it deserves.
3178 .El
3179 .Sh FILES
3180 .Bl -tag -width packed-refs -compact
3181 .It Pa got.conf
3182 Repository-wide configuration settings for
3183 .Nm .
3184 If present, a
3185 .Xr got.conf 5
3186 configuration file located in the root directory of a Git repository
3187 supersedes any relevant settings in Git's
3188 .Pa config
3189 file.
3190 .Pp
3191 .It Pa .got/got.conf
3192 Worktree-specific configuration settings for
3193 .Nm .
3194 If present, a
3195 .Xr got.conf 5
3196 configuration file in the
3197 .Pa .got
3198 meta-data directory of a work tree supersedes any relevant settings in
3199 the repository's
3200 .Xr got.conf 5
3201 configuration file and Git's
3202 .Pa config
3203 file.
3204 .El
3205 .Sh EXIT STATUS
3206 .Ex -std got
3207 .Sh EXAMPLES
3208 Enable tab-completion of
3209 .Nm
3210 command names in
3211 .Xr ksh 1 :
3212 .Pp
3213 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3214 .Pp
3215 Clone an existing Git repository for use with
3216 .Nm .
3217 .Pp
3218 .Dl $ cd /var/git/
3219 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3220 .Pp
3221 Use of HTTP URLs currently requires
3222 .Xr git 1 :
3223 .Pp
3224 .Dl $ cd /var/git/
3225 .Dl $ git clone --bare https://github.com/openbsd/src.git
3226 .Pp
3227 Alternatively, for quick and dirty local testing of
3228 .Nm
3229 a new Git repository could be created and populated with files,
3230 e.g. from a temporary CVS checkout located at
3231 .Pa /tmp/src :
3232 .Pp
3233 .Dl $ gotadmin init /var/git/src.git
3234 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3235 .Pp
3236 Check out a work tree from the Git repository to /usr/src:
3237 .Pp
3238 .Dl $ got checkout /var/git/src.git /usr/src
3239 .Pp
3240 View local changes in a work tree directory:
3241 .Pp
3242 .Dl $ got diff | less
3243 .Pp
3244 In a work tree, display files in a potentially problematic state:
3245 .Pp
3246 .Dl $ got status -s 'C!~?'
3247 .Pp
3248 Interactively revert selected local changes in a work tree directory:
3249 .Pp
3250 .Dl $ got revert -p -R\ .
3251 .Pp
3252 In a work tree or a git repository directory, list all branch references:
3253 .Pp
3254 .Dl $ got branch -l
3255 .Pp
3256 As above, but list the most recently modified branches only:
3257 .Pp
3258 .Dl $ got branch -lt | head
3259 .Pp
3260 In a work tree or a git repository directory, create a new branch called
3261 .Dq unified-buffer-cache
3262 which is forked off the
3263 .Dq master
3264 branch:
3265 .Pp
3266 .Dl $ got branch -c master unified-buffer-cache
3267 .Pp
3268 Switch an existing work tree to the branch
3269 .Dq unified-buffer-cache .
3270 Local changes in the work tree will be preserved and merged if necessary:
3271 .Pp
3272 .Dl $ got update -b unified-buffer-cache
3273 .Pp
3274 Create a new commit from local changes in a work tree directory.
3275 This new commit will become the head commit of the work tree's current branch:
3276 .Pp
3277 .Dl $ got commit
3278 .Pp
3279 In a work tree or a git repository directory, view changes committed in
3280 the 3 most recent commits to the work tree's branch, or the branch resolved
3281 via the repository's HEAD reference, respectively:
3282 .Pp
3283 .Dl $ got log -p -l 3
3284 .Pp
3285 As above, but display changes in the order in which
3286 .Xr patch 1
3287 could apply them in sequence:
3288 .Pp
3289 .Dl $ got log -p -l 3 -R
3290 .Pp
3291 In a work tree or a git repository directory, log the history of a subdirectory:
3292 .Pp
3293 .Dl $ got log sys/uvm
3294 .Pp
3295 While operating inside a work tree, paths are specified relative to the current
3296 working directory, so this command will log the subdirectory
3297 .Pa sys/uvm :
3298 .Pp
3299 .Dl $ cd sys/uvm && got log\ .
3300 .Pp
3301 And this command has the same effect:
3302 .Pp
3303 .Dl $ cd sys/dev/usb && got log ../../uvm
3304 .Pp
3305 And this command displays work tree meta-data about all tracked files:
3306 .Pp
3307 .Dl $ cd /usr/src
3308 .Dl $ got info\ . | less
3309 .Pp
3310 Add new files and remove obsolete files in a work tree directory:
3311 .Pp
3312 .Dl $ got add sys/uvm/uvm_ubc.c
3313 .Dl $ got remove sys/uvm/uvm_vnode.c
3314 .Pp
3315 Create a new commit from local changes in a work tree directory
3316 with a pre-defined log message.
3317 .Pp
3318 .Dl $ got commit -m 'unify the buffer cache'
3319 .Pp
3320 Alternatively, create a new commit from local changes in a work tree
3321 directory with a log message that has been prepared in the file
3322 .Pa /tmp/msg :
3323 .Pp
3324 .Dl $ got commit -F /tmp/msg
3325 .Pp
3326 Update any work tree checked out from the
3327 .Dq unified-buffer-cache
3328 branch to the latest commit on this branch:
3329 .Pp
3330 .Dl $ got update
3331 .Pp
3332 Roll file content on the unified-buffer-cache branch back by one commit,
3333 and then fetch the rolled-back change into the work tree as a local change
3334 to be amended and perhaps committed again:
3335 .Pp
3336 .Dl $ got backout unified-buffer-cache
3337 .Dl $ got commit -m 'roll back previous'
3338 .Dl $ # now back out the previous backout :-)
3339 .Dl $ got backout unified-buffer-cache
3340 .Pp
3341 Fetch new changes on the remote repository's
3342 .Dq master
3343 branch, making them visible on the local repository's
3344 .Dq origin/master
3345 branch:
3346 .Pp
3347 .Dl $ cd /usr/src
3348 .Dl $ got fetch
3349 .Pp
3350 In a repository created with a HTTP URL and
3351 .Cm git clone --bare
3352 the
3353 .Xr git-fetch 1
3354 command must be used instead:
3355 .Pp
3356 .Dl $ cd /var/git/src.git
3357 .Dl $ git fetch origin master:refs/remotes/origin/master
3358 .Pp
3359 Rebase the local
3360 .Dq master
3361 branch to merge the new changes that are now visible on the
3362 .Dq origin/master
3363 branch:
3364 .Pp
3365 .Dl $ cd /usr/src
3366 .Dl $ got update -b origin/master
3367 .Dl $ got rebase master
3368 .Pp
3369 Rebase the
3370 .Dq unified-buffer-cache
3371 branch on top of the new head commit of the
3372 .Dq master
3373 branch.
3374 .Pp
3375 .Dl $ got update -b master
3376 .Dl $ got rebase unified-buffer-cache
3377 .Pp
3378 Create a patch from all changes on the unified-buffer-cache branch.
3379 The patch can be mailed out for review and applied to
3380 .Ox Ns 's
3381 CVS tree:
3382 .Pp
3383 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3384 .Pp
3385 Edit the entire commit history of the
3386 .Dq unified-buffer-cache
3387 branch:
3388 .Pp
3389 .Dl $ got update -b unified-buffer-cache
3390 .Dl $ got update -c master
3391 .Dl $ got histedit
3392 .Pp
3393 Before working against existing branches in a repository cloned with
3394 .Cm git clone --bare
3395 instead of
3396 .Cm got clone ,
3397 a Git
3398 .Dq refspec
3399 must be configured to map all references in the remote repository
3400 into the
3401 .Dq refs/remotes
3402 namespace of the local repository.
3403 This can be achieved by setting Git's
3404 .Pa remote.origin.fetch
3405 configuration variable to the value
3406 .Dq +refs/heads/*:refs/remotes/origin/*
3407 with the
3408 .Cm git config
3409 command:
3410 .Pp
3411 .Dl $ cd /var/git/repo
3412 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3413 .Pp
3414 Additionally, the
3415 .Dq mirror
3416 option must be disabled:
3417 .Pp
3418 .Dl $ cd /var/git/repo
3419 .Dl $ git config remote.origin.mirror false
3420 .Pp
3421 Alternatively, the following
3422 .Xr git-fetch 1
3423 configuration item can be added manually to the Git repository's
3424 .Pa config
3425 file:
3426 .Pp
3427 .Dl [remote \&"origin\&"]
3428 .Dl url = ...
3429 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3430 .Dl mirror = false
3431 .Pp
3432 This configuration leaves the local repository's
3433 .Dq refs/heads
3434 namespace free for use by local branches checked out with
3435 .Cm got checkout
3436 and, if needed, created with
3437 .Cm got branch .
3438 Branches in the
3439 .Dq refs/remotes/origin
3440 namespace can now be updated with incoming changes from the remote
3441 repository with
3442 .Cm got fetch
3444 .Xr git-fetch 1
3445 without extra command line arguments.
3446 Newly fetched changes can be examined with
3447 .Cm got log .
3448 .Pp
3449 Display changes on the remote repository's version of the
3450 .Dq master
3451 branch, as of the last time
3452 .Cm got fetch
3453 was run:
3454 .Pp
3455 .Dl $ got log -c origin/master | less
3456 .Pp
3457 As shown here, most commands accept abbreviated reference names such as
3458 .Dq origin/master
3459 instead of
3460 .Dq refs/remotes/origin/master .
3461 The latter is only needed in case of ambiguity.
3462 .Pp
3463 .Cm got rebase
3464 must be used to merge changes which are visible on the
3465 .Dq origin/master
3466 branch into the
3467 .Dq master
3468 branch.
3469 This will also merge local changes, if any, with the incoming changes:
3470 .Pp
3471 .Dl $ got update -b origin/master
3472 .Dl $ got rebase master
3473 .Pp
3474 In order to make changes committed to the
3475 .Dq unified-buffer-cache
3476 visible on the
3477 .Dq master
3478 branch, the
3479 .Dq unified-buffer-cache
3480 branch must first be rebased onto the
3481 .Dq master
3482 branch:
3483 .Pp
3484 .Dl $ got update -b master
3485 .Dl $ got rebase unified-buffer-cache
3486 .Pp
3487 Changes on the
3488 .Dq unified-buffer-cache
3489 branch can now be made visible on the
3490 .Dq master
3491 branch with
3492 .Cm got integrate .
3493 Because the rebase operation switched the work tree to the
3494 .Dq unified-buffer-cache
3495 branch, the work tree must be switched back to the
3496 .Dq master
3497 branch first:
3498 .Pp
3499 .Dl $ got update -b master
3500 .Dl $ got integrate unified-buffer-cache
3501 .Pp
3502 On the
3503 .Dq master
3504 branch, log messages for local changes can now be amended with
3505 .Dq OK
3506 by other developers and any other important new information:
3507 .Pp
3508 .Dl $ got update -c origin/master
3509 .Dl $ got histedit -m
3510 .Pp
3511 If the remote repository offers write access, local changes on the
3512 .Dq master
3513 branch can be sent to the remote repository with
3514 .Cm got send .
3515 Usually,
3516 .Cm got send
3517 can be run without further arguments.
3518 The arguments shown here match defaults, provided the work tree's
3519 current branch is the
3520 .Dq master
3521 branch:
3522 .Pp
3523 .Dl $ got send -b master origin
3524 .Pp
3525 If the remote repository requires the HTTPS protocol, the
3526 .Xr git-push 1
3527 command must be used instead:
3528 .Pp
3529 .Dl $ cd /var/git/src.git
3530 .Dl $ git push origin master
3531 .Pp
3532 When making contributions to projects which use the
3533 .Dq pull request
3534 workflow, SSH protocol repository access needs to be set up first.
3535 Once an account has been created on a Git hosting site it should
3536 be possible to upload a public SSH key for repository access
3537 authentication.
3538 .Pp
3539 The
3540 .Dq pull request
3541 workflow will usually involve two remote repositories.
3542 In the real-life example below, the
3543 .Dq origin
3544 repository was forked from the
3545 .Dq upstream
3546 repository by using the Git hosting site's web interface.
3547 The
3548 .Xr got.conf 5
3549 file in the local repository describes both remote repositories:
3550 .Bd -literal -offset indent
3551 # Jelmers's repository, which accepts pull requests
3552 remote "upstream" {
3553 server git@github.com
3554 protocol ssh
3555 repository "/jelmer/dulwich"
3556 branch { "master" }
3559 # Stefan's fork, used as the default remote repository
3560 remote "origin" {
3561 server git@github.com
3562 protocol ssh
3563 repository "/stspdotname/dulwich"
3564 branch { "master" }
3566 .Ed
3567 .Pp
3568 With this configuration, Stefan can create commits on
3569 .Dq refs/heads/master
3570 and send them to the
3571 .Dq origin
3572 repository by running:
3573 .Pp
3574 .Dl $ got send -b master origin
3575 .Pp
3576 The changes can now be proposed to Jelmer by opening a pull request
3577 via the Git hosting site's web interface.
3578 If Jelmer requests further changes to be made, additional commits
3579 can be created on the
3580 .Dq master
3581 branch and be added to the pull request by running
3582 .Cd got send
3583 again.
3584 .Pp
3585 If Jelmer prefers additional commits to be
3586 .Dq squashed
3587 then the following commands can be used to achieve this:
3588 .Pp
3589 .Dl $ got update -b master
3590 .Dl $ got update -c origin/master
3591 .Dl $ got histedit -f
3592 .Dl $ got send -f -b master origin
3593 .Pp
3594 Once Jelmer has accepted the pull request, Stefan can fetch the
3595 merged changes, and possibly several other new changes, by running:
3596 .Pp
3597 .Dl $ got fetch upstream
3598 .Pp
3599 The merged changes will now be visible under the reference
3600 .Dq refs/remotes/upstream/master .
3601 The local
3602 .Dq master
3603 branch can now be rebased on top of the latest changes
3604 from upstream:
3605 .Pp
3606 .Dl $ got update -b upstream/master
3607 .Dl $ got rebase master
3608 .Pp
3609 As a final step, the forked repository's copy of the master branch needs
3610 to be kept in sync by sending the new changes there:
3611 .Pp
3612 .Dl $ got send -f -b master origin
3613 .Pp
3614 If multiple pull requests need to be managed in parallel, a separate branch
3615 must be created for each pull request with
3616 .Cm got branch .
3617 Each such branch can then be used as above, in place of
3618 .Dq refs/heads/master .
3619 Changes for any accepted pull requests will still appear under
3620 .Dq refs/remotes/upstream/master,
3621 regardless of which branch was used in the forked repository to
3622 create a pull request.
3623 .Sh SEE ALSO
3624 .Xr gotadmin 1 ,
3625 .Xr tog 1 ,
3626 .Xr git-repository 5 ,
3627 .Xr got-worktree 5 ,
3628 .Xr got.conf 5 ,
3629 .Xr gotwebd 8
3630 .Sh AUTHORS
3631 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3632 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3633 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3634 .An Josh Rickmar Aq Mt jrick@zettaport.com
3635 .An Joshua Stein Aq Mt jcs@openbsd.org
3636 .An Klemens Nanni Aq Mt kn@openbsd.org
3637 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3638 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3639 .An Omar Polo Aq Mt op@openbsd.org
3640 .An Ori Bernstein Aq Mt ori@openbsd.org
3641 .An Sebastien Marie Aq Mt semarie@openbsd.org
3642 .An Stefan Sperling Aq Mt stsp@openbsd.org
3643 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3644 .An Theo Buehler Aq Mt tb@openbsd.org
3645 .An Thomas Adam Aq Mt thomas@xteddy.org
3646 .An Tracey Emery Aq Mt tracey@traceyemery.net
3647 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3648 .Pp
3649 Parts of
3650 .Nm ,
3651 .Xr tog 1 ,
3652 and
3653 .Xr gotwebd 8
3654 were derived from code under copyright by:
3655 .Pp
3656 .An Caldera International
3657 .An Daniel Hartmeier
3658 .An Esben Norby
3659 .An Henning Brauer
3660 .An HÃ¥kan Olsson
3661 .An Ingo Schwarze
3662 .An Jean-Francois Brousseau
3663 .An Joris Vink
3664 .An Jyri J. Virkki
3665 .An Larry Wall
3666 .An Markus Friedl
3667 .An Niall O'Higgins
3668 .An Niklas Hallqvist
3669 .An Ray Lai
3670 .An Ryan McBride
3671 .An Theo de Raadt
3672 .An Todd C. Miller
3673 .An Xavier Santolaria
3674 .Pp
3675 .Nm
3676 contains code contributed to the public domain by
3677 .An Austin Appleby .
3678 .Sh CAVEATS
3679 .Nm
3680 is a work-in-progress and some features remain to be implemented.
3681 .Pp
3682 At present, the user has to fall back on
3683 .Xr git 1
3684 to perform some tasks.
3685 In particular:
3686 .Bl -bullet
3687 .It
3688 Reading from remote repositories over HTTP or HTTPS protocols requires
3689 .Xr git-clone 1
3690 and
3691 .Xr git-fetch 1 .
3692 .It
3693 Writing to remote repositories over HTTP or HTTPS protocols requires
3694 .Xr git-push 1 .
3695 .It
3696 The creation of merge commits with more than two parent commits requires
3697 .Xr git-merge 1 .
3698 .It
3699 In situations where files or directories were moved around
3700 .Cm got
3701 will not automatically merge changes to new locations and
3702 .Xr git 1
3703 will usually produce better results.
3704 .El