./ 0000775 0000000 0000000 00000000000 15214513225 0011213 5 ustar 00root root 0000000 0000000 ./man1/ 0000775 0000000 0000000 00000000000 15214513225 0012047 5 ustar 00root root 0000000 0000000 ./man1/git-add.1 0000664 0000000 0000000 00000050110 15214513225 0013437 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-add
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-ADD" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-add \- Add file contents to the index
.SH "SYNOPSIS"
.sp
.nf
\fBgit\fR \fBadd\fR [\fB\-\-verbose\fR | \fB\-v\fR] [\fB\-\-dry\-run\fR | \fB\-n\fR] [\fB\-\-force\fR | \fB\-f\fR] [\fB\-\-interactive\fR | \fB\-i\fR] [\fB\-\-patch\fR | \fB\-p\fR]
[\fB\-\-edit\fR | \fB\-e\fR] [\fB\-\-\fR[\fBno\-\fR]\fBall\fR | \fB\-A\fR | \fB\-\-\fR[\fBno\-\fR]\fBignore\-removal\fR | [\fB\-\-update\fR | \fB\-u\fR]] [\fB\-\-sparse\fR]
[\fB\-\-intent\-to\-add\fR | \fB\-N\fR] [\fB\-\-refresh\fR] [\fB\-\-ignore\-errors\fR] [\fB\-\-ignore\-missing\fR] [\fB\-\-renormalize\fR]
[\fB\-\-chmod=\fR(\fB+\fR|\fB\-\fR)\fBx\fR] [\fB\-\-pathspec\-from\-file=\fR\fI\fR [\fB\-\-pathspec\-file\-nul\fR]]
[\fB\-\-\fR] [\fI\fR\&...\:]
.fi
.SH "DESCRIPTION"
.sp
Add contents of new or changed files to the index\&. The "index" (also known as the "staging area") is what you use to prepare the contents of the next commit\&.
.sp
When you run \fBgit\fR \fBcommit\fR without any other arguments, it will only commit staged changes\&. For example, if you\(cqve edited \fBfile\&.c\fR and want to commit your changes to that file, you can run:
.sp
.if n \{\
.RS 4
.\}
.nf
git add file\&.c
git commit
.fi
.if n \{\
.RE
.\}
.sp
You can also add only part of your changes to a file with \fBgit\fR \fBadd\fR \fB\-p\fR\&.
.sp
This command can be performed multiple times before a commit\&. It only adds the content of the specified file(s) at the time the add command is run; if you want subsequent changes included in the next commit, then you must run \fBgit\fR \fBadd\fR again to add the new content to the index\&.
.sp
The \fBgit\fR \fBstatus\fR command can be used to obtain a summary of which files have changes that are staged for the next commit\&.
.sp
The \fBgit\fR \fBadd\fR command will not add ignored files by default\&. You can use the \fB\-\-force\fR option to add ignored files\&. If you specify the exact filename of an ignored file, \fBgit\fR \fBadd\fR will fail with a list of ignored files\&. Otherwise it will silently ignore the file\&.
.sp
Please see \fBgit-commit\fR(1) for alternative ways to add content to a commit\&.
.SH "OPTIONS"
.PP
\fI\fR\&.\&.\&.
.RS 4
Files to add content from\&. Fileglobs (e\&.g\&.
\fB*\&.c\fR) can be given to add all matching files\&. Also a leading directory name (e\&.g\&.
\fBdir\fR
to add
\fBdir/file1\fR
and
\fBdir/file2\fR) can be given to update the index to match the current state of the directory as a whole (e\&.g\&. specifying
\fBdir\fR
will record not just a file
\fBdir/file1\fR
modified in the working tree, a file
\fBdir/file2\fR
added to the working tree, but also a file
\fBdir/file3\fR
removed from the working tree)\&. Note that older versions of Git used to ignore removed files; use
\fB\-\-no\-all\fR
option if you want to add modified or new files but ignore removed ones\&.
.sp
For more details about the
\fI\fR
syntax, see the
\fIpathspec\fR
entry in
\fBgitglossary\fR(7)\&.
.RE
.PP
\fB\-n\fR, \fB\-\-dry\-run\fR
.RS 4
Don\(cqt actually add the file(s), just show if they exist and/or will be ignored\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Be verbose\&.
.RE
.PP
\fB\-f\fR, \fB\-\-force\fR
.RS 4
Allow adding otherwise ignored files\&. The option is also used when
\fBsubmodule\&.\fR\fI\fR\fB\&.ignore=all\fR
is set, but you want to stage an update of the submodule\&. The
\fBpath\fR
to the submodule must be explicitly specified\&.
.RE
.PP
\fB\-\-sparse\fR
.RS 4
Allow updating index entries outside of the sparse\-checkout cone\&. Normally,
\fBgit\fR
\fBadd\fR
refuses to update index entries whose paths do not fit within the sparse\-checkout cone, since those files might be removed from the working tree without warning\&. See
\fBgit-sparse-checkout\fR(1)
for more details\&.
.RE
.PP
\fB\-i\fR, \fB\-\-interactive\fR
.RS 4
Add modified contents in the working tree interactively to the index\&. Optional path arguments may be supplied to limit operation to a subset of the working tree\&. See
\(lqInteractive mode\(rq
for details\&.
.RE
.PP
\fB\-p\fR, \fB\-\-patch\fR
.RS 4
Interactively choose hunks of patch between the index and the work tree and add them to the index\&. This gives the user a chance to review the difference before adding modified contents to the index\&.
.sp
This effectively runs
\fBadd\fR
\fB\-\-interactive\fR, but bypasses the initial command menu and directly jumps to the
\fBpatch\fR
subcommand\&. See
\(lqInteractive mode\(rq
for details\&.
.RE
.PP
\fB\-U\fR\fI\fR, \fB\-\-unified=\fR\fI\fR
.RS 4
Generate diffs with
\fI\fR
lines of context\&. The number of context lines defaults to
\fBdiff\&.context\fR
or 3 if the configuration variable is unset\&. (\fB\-U\fR
without
\fI\fR
is silently accepted as a synonym for
\fB\-p\fR
due to a historical accident)\&.
.RE
.PP
\fB\-\-inter\-hunk\-context=\fR\fI\fR
.RS 4
Show the context between diff hunks, up to the specified
\fI\fR
of lines, thereby fusing hunks that are close to each other\&. Defaults to
\fBdiff\&.interHunkContext\fR
or 0 if the config option is unset\&.
.RE
.PP
\fB\-e\fR, \fB\-\-edit\fR
.RS 4
Open the diff vs\&. the index in an editor and let the user edit it\&. After the editor was closed, adjust the hunk headers and apply the patch to the index\&.
.sp
The intent of this option is to pick and choose lines of the patch to apply, or even to modify the contents of lines to be staged\&. This can be quicker and more flexible than using the interactive hunk selector\&. However, it is easy to confuse oneself and create a patch that does not apply to the index\&. See EDITING PATCHES below\&.
.RE
.PP
\fB\-u\fR, \fB\-\-update\fR
.RS 4
Update the index just where it already has an entry matching
\fI\fR\&. This removes as well as modifies index entries to match the working tree, but adds no new files\&.
.sp
If no
\fI\fR
is given when
\fB\-u\fR
option is used, all tracked files in the entire working tree are updated (old versions of Git used to limit the update to the current directory and its subdirectories)\&.
.RE
.PP
\fB\-A\fR, \fB\-\-all\fR, \fB\-\-no\-ignore\-removal\fR
.RS 4
Update the index not only where the working tree has a file matching
\fI\fR
but also where the index already has an entry\&. This adds, modifies, and removes index entries to match the working tree\&.
.sp
If no
\fI\fR
is given when
\fB\-A\fR
option is used, all files in the entire working tree are updated (old versions of Git used to limit the update to the current directory and its subdirectories)\&.
.RE
.PP
\fB\-\-no\-all\fR, \fB\-\-ignore\-removal\fR
.RS 4
Update the index by adding new files that are unknown to the index and files modified in the working tree, but ignore files that have been removed from the working tree\&. This option is a no\-op when no
\fI\fR
is used\&.
.sp
This option is primarily to help users who are used to older versions of Git, whose
\fBgit\fR
\fBadd\fR
\fI\fR\&.\&.\&. was a synonym for
\fBgit\fR
\fBadd\fR
\fB\-\-no\-all\fR
\fI\fR\&.\&.\&., i\&.e\&. ignored removed files\&.
.RE
.PP
\fB\-N\fR, \fB\-\-intent\-to\-add\fR
.RS 4
Record only the fact that the path will be added later\&. An entry for the path is placed in the index with no content\&. This is useful for, among other things, showing the unstaged content of such files with
\fBgit\fR
\fBdiff\fR
and committing them with
\fBgit\fR
\fBcommit\fR
\fB\-a\fR\&.
.RE
.PP
\fB\-\-refresh\fR
.RS 4
Don\(cqt add the file(s), but only refresh their stat() information in the index\&.
.RE
.PP
\fB\-\-ignore\-errors\fR
.RS 4
If some files could not be added because of errors indexing them, do not abort the operation, but continue adding the others\&. The command shall still exit with non\-zero status\&. The configuration variable
\fBadd\&.ignoreErrors\fR
can be set to true to make this the default behaviour\&.
.RE
.PP
\fB\-\-ignore\-missing\fR
.RS 4
This option can only be used together with
\fB\-\-dry\-run\fR\&. By using this option the user can check if any of the given files would be ignored, no matter if they are already present in the work tree or not\&.
.RE
.PP
\fB\-\-no\-warn\-embedded\-repo\fR
.RS 4
By default,
\fBgit\fR
\fBadd\fR
will warn when adding an embedded repository to the index without using
\fBgit\fR
\fBsubmodule\fR
\fBadd\fR
to create an entry in \&.\fBgitmodules\fR\&. This option will suppress the warning (e\&.g\&., if you are manually performing operations on submodules)\&.
.RE
.PP
\fB\-\-renormalize\fR
.RS 4
Apply the "clean" process freshly to all tracked files to forcibly add them again to the index\&. This is useful after changing
\fBcore\&.autocrlf\fR
configuration or the
\fBtext\fR
attribute in order to correct files added with wrong
\fICRLF/LF\fR
line endings\&. This option implies
\fB\-u\fR\&. Lone CR characters are untouched, thus while a
\fICRLF\fR
cleans to
\fILF\fR, a
\fICRCRLF\fR
sequence is only partially cleaned to
\fICRLF\fR\&.
.RE
.PP
\fB\-\-chmod=\fR(\fB+\fR|\fB\-\fR)\fBx\fR
.RS 4
Override the executable bit of the added files\&. The executable bit is only changed in the index, the files on disk are left unchanged\&.
.RE
.PP
\fB\-\-pathspec\-from\-file=\fR\fI\fR
.RS 4
Pathspec is passed in
\fI\fR
instead of commandline args\&. If
\fI\fR
is exactly
\fB\-\fR
then standard input is used\&. Pathspec elements are separated by
\fILF\fR
or
\fICR/LF\fR\&. Pathspec elements can be quoted as explained for the configuration variable
\fBcore\&.quotePath\fR
(see
\fBgit-config\fR(1))\&. See also
\fB\-\-pathspec\-file\-nul\fR
and global
\fB\-\-literal\-pathspecs\fR\&.
.RE
.PP
\fB\-\-pathspec\-file\-nul\fR
.RS 4
Only meaningful with
\fB\-\-pathspec\-from\-file\fR\&. Pathspec elements are separated with
\fINUL\fR
character and all other characters are taken literally (including newlines and quotes)\&.
.RE
.PP
\fB\-\-\fR
.RS 4
This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Adds content from all
\fB*\&.txt\fR
files under
\fBDocumentation\fR
directory and its subdirectories:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git add Documentation/\e*\&.txt
.fi
.if n \{\
.RE
.\}
.sp
Note that the asterisk
\fB*\fR
is quoted from the shell in this example; this lets the command include the files from subdirectories of
\fBDocumentation/\fR
directory\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Considers adding content from all
\fBgit\-*\&.sh\fR
scripts:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git add git\-*\&.sh
.fi
.if n \{\
.RE
.\}
.sp
Because this example lets the shell expand the asterisk (i\&.e\&. you are listing the files explicitly), it does not consider
\fBsubdir/git\-foo\&.sh\fR\&.
.RE
.SH "INTERACTIVE MODE"
.sp
When the command enters the interactive mode, it shows the output of the \fIstatus\fR subcommand, and then goes into its interactive command loop\&.
.sp
The command loop shows the list of subcommands available, and gives a prompt "What now> "\&. In general, when the prompt ends with a single \fI>\fR, you can pick only one of the choices given and type return, like this:
.sp
.if n \{\
.RS 4
.\}
.nf
*** Commands ***
1: status 2: update 3: revert 4: add untracked
5: patch 6: diff 7: quit 8: help
What now> 1
.fi
.if n \{\
.RE
.\}
.sp
You also could say \fBs\fR or \fBsta\fR or \fBstatus\fR above as long as the choice is unique\&.
.sp
The main command loop has 6 subcommands (plus help and quit)\&.
.PP
status
.RS 4
This shows the change between
\fBHEAD\fR
and index (i\&.e\&. what will be committed if you say
\fBgit\fR
\fBcommit\fR), and between index and working tree files (i\&.e\&. what you could stage further before
\fBgit\fR
\fBcommit\fR
using
\fBgit\fR
\fBadd\fR) for each path\&. A sample output looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
staged unstaged path
1: binary nothing foo\&.png
2: +403/\-35 +1/\-1 add\-interactive\&.c
.fi
.if n \{\
.RE
.\}
.sp
It shows that
\fBfoo\&.png\fR
has differences from
\fBHEAD\fR
(but that is binary so line count cannot be shown) and there is no difference between indexed copy and the working tree version (if the working tree version were also different,
\fIbinary\fR
would have been shown in place of
\fInothing\fR)\&. The other file,
\fBadd\-interactive\&.c\fR, has 403 lines added and 35 lines deleted if you commit what is in the index, but working tree file has further modifications (one addition and one deletion)\&.
.RE
.PP
update
.RS 4
This shows the status information and issues an "Update>>" prompt\&. When the prompt ends with double
\fI>>\fR, you can make more than one selection, concatenated with whitespace or comma\&. Also you can say ranges\&. E\&.g\&. "2\-5 7,9" to choose 2,3,4,5,7,9 from the list\&. If the second number in a range is omitted, all remaining patches are taken\&. E\&.g\&. "7\-" to choose 7,8,9 from the list\&. You can say
\fI*\fR
to choose everything\&.
.sp
What you chose are then highlighted with
\fI*\fR, like this:
.sp
.if n \{\
.RS 4
.\}
.nf
staged unstaged path
1: binary nothing foo\&.png
* 2: +403/\-35 +1/\-1 add\-interactive\&.c
.fi
.if n \{\
.RE
.\}
.sp
To remove selection, prefix the input with
\fB\-\fR
like this:
.sp
.if n \{\
.RS 4
.\}
.nf
Update>> \-2
.fi
.if n \{\
.RE
.\}
.sp
After making the selection, answer with an empty line to stage the contents of working tree files for selected paths in the index\&.
.RE
.PP
revert
.RS 4
This has a very similar UI to
\fIupdate\fR, and the staged information for selected paths are reverted to that of the HEAD version\&. Reverting new paths makes them untracked\&.
.RE
.PP
add untracked
.RS 4
This has a very similar UI to
\fIupdate\fR
and
\fIrevert\fR, and lets you add untracked paths to the index\&.
.RE
.PP
patch
.RS 4
This lets you choose one path out of a
\fIstatus\fR
like selection\&. After choosing the path, it presents the diff between the index and the working tree file and asks you if you want to stage the change of each hunk\&. You can select one of the following options and type return:
.sp
.if n \{\
.RS 4
.\}
.nf
y \- stage this hunk
n \- do not stage this hunk
q \- quit; do not stage this hunk or any of the remaining ones
a \- stage this hunk and all later hunks in the file
d \- do not stage this hunk or any of the later hunks in the file
g \- select a hunk to go to
/ \- search for a hunk matching the given regex
j \- go to the next undecided hunk, roll over at the bottom
J \- go to the next hunk, roll over at the bottom
k \- go to the previous undecided hunk, roll over at the top
K \- go to the previous hunk, roll over at the top
s \- split the current hunk into smaller hunks
e \- manually edit the current hunk
p \- print the current hunk
P \- print the current hunk using the pager
? \- print help
.fi
.if n \{\
.RE
.\}
.sp
After deciding the fate for all hunks, if there is any hunk that was chosen, the index is updated with the selected hunks\&.
.sp
You can omit having to type return here, by setting the configuration variable
\fBinteractive\&.singleKey\fR
to
\fBtrue\fR\&.
.RE
.PP
diff
.RS 4
This lets you review what will be committed (i\&.e\&. between
\fBHEAD\fR
and index)\&.
.RE
.SH "EDITING PATCHES"
.sp
Invoking \fBgit\fR \fBadd\fR \fB\-e\fR or selecting \fBe\fR from the interactive hunk selector will open a patch in your editor; after the editor exits, the result is applied to the index\&. You are free to make arbitrary changes to the patch, but note that some changes may have confusing results, or even result in a patch that cannot be applied\&. If you want to abort the operation entirely (i\&.e\&., stage nothing new in the index), simply delete all lines of the patch\&. The list below describes some common things you may see in a patch, and which editing operations make sense on them\&.
.PP
added content
.RS 4
Added content is represented by lines beginning with "+"\&. You can prevent staging any addition lines by deleting them\&.
.RE
.PP
removed content
.RS 4
Removed content is represented by lines beginning with "\-"\&. You can prevent staging their removal by converting the "\-" to a " " (space)\&.
.RE
.PP
modified content
.RS 4
Modified content is represented by "\-" lines (removing the old content) followed by "+" lines (adding the replacement content)\&. You can prevent staging the modification by converting "\-" lines to " ", and removing "+" lines\&. Beware that modifying only half of the pair is likely to introduce confusing changes to the index\&.
.RE
.sp
There are also more complex operations that can be performed\&. But beware that because the patch is applied only to the index and not the working tree, the working tree will appear to "undo" the change in the index\&. For example, introducing a new line into the index that is in neither the \fBHEAD\fR nor the working tree will stage the new line for commit, but the line will appear to be reverted in the working tree\&.
.sp
Avoid using these constructs, or do so with extreme caution\&.
.PP
removing untouched content
.RS 4
Content which does not differ between the index and working tree may be shown on context lines, beginning with a " " (space)\&. You can stage context lines for removal by converting the space to a "\-"\&. The resulting working tree file will appear to re\-add the content\&.
.RE
.PP
modifying existing content
.RS 4
One can also modify context lines by staging them for removal (by converting " " to "\-") and adding a "+" line with the new content\&. Similarly, one can modify "+" lines for existing additions or modifications\&. In all cases, the new modification will appear reverted in the working tree\&.
.RE
.PP
new content
.RS 4
You may also add new content that does not exist in the patch; simply add new lines, each starting with "+"\&. The addition will appear reverted in the working tree\&.
.RE
.sp
There are also several operations which should be avoided entirely, as they will make the patch impossible to apply:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
adding context (" ") or removal ("\-") lines
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
deleting context or removal lines
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
modifying the contents of context or removal lines
.RE
.SH "CONFIGURATION"
.sp
Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
.PP
\fBadd\&.ignoreErrors\fR, \fBadd\&.ignore\-errors\fR (deprecated)
.RS 4
Tells
\fBgit\fR
\fBadd\fR
to continue adding files when some files cannot be added due to indexing errors\&. Equivalent to the
\fB\-\-ignore\-errors\fR
option\&.
\fBadd\&.ignore\-errors\fR
is deprecated, as it does not follow the usual naming convention for configuration variables\&.
.RE
.SH "SEE ALSO"
.sp
\fBgit-status\fR(1) \fBgit-rm\fR(1) \fBgit-reset\fR(1) \fBgit-mv\fR(1) \fBgit-commit\fR(1) \fBgit-update-index\fR(1)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
./man1/git-am.1 0000664 0000000 0000000 00000040341 15214513225 0013311 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-am
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-AM" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-am \- Apply a series of patches from a mailbox
.SH "SYNOPSIS"
.sp
.nf
\fBgit\fR \fBam\fR [\fB\-\-signoff\fR] [\fB\-\-keep\fR] [\fB\-\-\fR[\fBno\-\fR]\fBkeep\-cr\fR] [\fB\-\-\fR[\fBno\-\fR]\fButf8\fR] [\fB\-\-\fR[\fBno\-\fR]\fBverify\fR]
[\fB\-\-\fR[\fBno\-\fR]\fB3way\fR] [\fB\-\-interactive\fR] [\fB\-\-committer\-date\-is\-author\-date\fR]
[\fB\-\-ignore\-date\fR] [\fB\-\-ignore\-space\-change\fR | \fB\-\-ignore\-whitespace\fR]
[\fB\-\-whitespace=\fR\fI\fR] [\fB\-C\fR\fI\fR] [\fB\-p\fR\fI\fR] [\fB\-\-directory=\fR\fI\fR]
[\fB\-\-exclude=\fR\fI\fR] [\fB\-\-include=\fR\fI\fR] [\fB\-\-reject\fR] [\fB\-q\fR | \fB\-\-quiet\fR]
[\fB\-\-\fR[\fBno\-\fR]\fBscissors\fR] [\fB\-S\fR[\fI\fR]] [\fB\-\-patch\-format=\fR\fI\fR]
[\fB\-\-quoted\-cr=\fR\fI\fR]
[\fB\-\-empty=\fR(\fBstop\fR|\fBdrop\fR|\fBkeep\fR)]
[(\fI\fR | \fI\fR)\&...\:]
\fBgit\fR \fBam\fR (\fB\-\-continue\fR | \fB\-\-skip\fR | \fB\-\-abort\fR | \fB\-\-quit\fR | \fB\-\-retry\fR | \fB\-\-show\-current\-patch\fR[\fB=\fR(\fBdiff\fR|\fBraw\fR)] | \fB\-\-allow\-empty\fR)
.fi
.SH "DESCRIPTION"
.sp
Splits mail messages in a mailbox into commit log messages, authorship information, and patches, and applies them to the current branch\&. You could think of it as a reverse operation of \fBgit-format-patch\fR(1) run on a branch with a straight history without merges\&.
.SH "OPTIONS"
.PP
(\fI\fR|\fI\fR)\&.\&.\&.
.RS 4
The list of mailbox files to read patches from\&. If you do not supply this argument, the command reads from the standard input\&. If you supply directories, they will be treated as Maildirs\&.
.RE
.PP
\fB\-s\fR, \fB\-\-signoff\fR
.RS 4
Add a
\fBSigned\-off\-by\fR
trailer to the commit message (see
\fBgit-interpret-trailers\fR(1)), using the committer identity of yourself\&. See the signoff option in
\fBgit-commit\fR(1)
for more information\&.
.RE
.PP
\fB\-k\fR, \fB\-\-keep\fR
.RS 4
Pass
\fB\-k\fR
flag to
\fBgit-mailinfo\fR(1)\&.
.RE
.PP
\fB\-\-keep\-non\-patch\fR
.RS 4
Pass
\fB\-b\fR
flag to
\fBgit-mailinfo\fR(1)\&.
.RE
.PP
\fB\-\-keep\-cr\fR, \fB\-\-no\-keep\-cr\fR
.RS 4
With
\fB\-\-keep\-cr\fR, call
\fBgit-mailsplit\fR(1)
with the same option, to prevent it from stripping CR at the end of lines\&.
\fBam\&.keepcr\fR
configuration variable can be used to specify the default behaviour\&.
\fB\-\-no\-keep\-cr\fR
is useful to override
\fBam\&.keepcr\fR\&.
.RE
.PP
\fB\-c\fR, \fB\-\-scissors\fR
.RS 4
Remove everything in body before a scissors line (see
\fBgit-mailinfo\fR(1))\&. Can be activated by default using the
\fBmailinfo\&.scissors\fR
configuration variable\&.
.RE
.PP
\fB\-\-no\-scissors\fR
.RS 4
Ignore scissors lines (see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\fB\-\-quoted\-cr=\fR\fI\fR
.RS 4
This flag will be passed down to
\fBgit-mailinfo\fR(1)\&.
.RE
.PP
\fB\-\-empty=\fR(\fBdrop\fR|\fBkeep\fR|\fBstop\fR)
.RS 4
How to handle an e\-mail message lacking a patch:
.PP
\fBdrop\fR
.RS 4
The e\-mail message will be skipped\&.
.RE
.PP
\fBkeep\fR
.RS 4
An empty commit will be created, with the contents of the e\-mail message as its log\&.
.RE
.PP
\fBstop\fR
.RS 4
The command will fail, stopping in the middle of the current
\fBam\fR
session\&. This is the default behavior\&.
.RE
.RE
.PP
\fB\-m\fR, \fB\-\-message\-id\fR
.RS 4
Pass the
\fB\-m\fR
flag to
\fBgit-mailinfo\fR(1), so that the
\fBMessage\-ID\fR
header is added to the commit message\&. The
\fBam\&.messageid\fR
configuration variable can be used to specify the default behaviour\&.
.RE
.PP
\fB\-\-no\-message\-id\fR
.RS 4
Do not add the Message\-ID header to the commit message\&.
\fB\-\-no\-message\-id\fR
is useful to override
\fBam\&.messageid\fR\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Be quiet\&. Only print error messages\&.
.RE
.PP
\fB\-u\fR, \fB\-\-utf8\fR
.RS 4
Pass
\fB\-u\fR
flag to
\fBgit-mailinfo\fR(1)\&. The proposed commit log message taken from the e\-mail is re\-coded into UTF\-8 encoding (configuration variable
\fBi18n\&.commitEncoding\fR
can be used to specify the project\(cqs preferred encoding if it is not UTF\-8)\&.
.sp
This was optional in prior versions of git, but now it is the default\&. You can use
\fB\-\-no\-utf8\fR
to override this\&.
.RE
.PP
\fB\-\-no\-utf8\fR
.RS 4
Pass
\fB\-n\fR
flag to
\fBgit-mailinfo\fR(1)\&.
.RE
.PP
\fB\-3\fR, \fB\-\-3way\fR, \fB\-\-no\-3way\fR
.RS 4
When the patch does not apply cleanly, fall back on 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally\&.
\fB\-\-no\-3way\fR
can be used to override
\fBam\&.threeWay\fR
configuration variable\&. For more information, see
\fBam\&.threeWay\fR
in
\fBgit-config\fR(1)\&.
.RE
.PP
\fB\-\-rerere\-autoupdate\fR, \fB\-\-no\-rerere\-autoupdate\fR
.RS 4
After the rerere mechanism reuses a recorded resolution on the current conflict to update the files in the working tree, allow it to also update the index with the result of resolution\&.
\fB\-\-no\-rerere\-autoupdate\fR
is a good way to double\-check what
\fBgit-rerere\fR(1)
did and catch potential mismerges, before committing the result to the index with a separate
\fBgit-add\fR(1)\&.
.RE
.PP
\fB\-\-ignore\-space\-change\fR, \fB\-\-ignore\-whitespace\fR, \fB\-\-whitespace=\fR\fI\fR, \fB\-C\fR\fI\fR, \fB\-p\fR\fI\fR, \fB\-\-directory=\fR\fI\fR, \fB\-\-exclude=\fR\fI\fR, \fB\-\-include=\fR\fI\fR, \fB\-\-reject\fR
.RS 4
These flags are passed to the
\fBgit-apply\fR(1)
program that applies the patch\&.
.sp
Valid
\fI\fR
for the
\fB\-\-whitespace\fR
option are:
\fBnowarn\fR,
\fBwarn\fR,
\fBfix\fR,
\fBerror\fR, and
\fBerror\-all\fR\&.
.RE
.PP
\fB\-\-patch\-format\fR
.RS 4
By default the command will try to detect the patch format automatically\&. This option allows the user to bypass the automatic detection and specify the patch format that the patch(es) should be interpreted as\&. Valid formats are mbox, mboxrd, stgit, stgit\-series, and hg\&.
.RE
.PP
\fB\-i\fR, \fB\-\-interactive\fR
.RS 4
Run interactively\&.
.RE
.PP
\fB\-\-verify\fR, \fB\-n\fR, \fB\-\-no\-verify\fR
.RS 4
Run the
\fBpre\-applypatch\fR
and
\fBapplypatch\-msg\fR
hooks\&. This is the default\&. Skip these hooks with
\fB\-n\fR
or
\fB\-\-no\-verify\fR\&. See also
\fBgithooks\fR(5)\&.
.sp
Note that
\fBpost\-applypatch\fR
cannot be skipped\&.
.RE
.PP
\fB\-\-committer\-date\-is\-author\-date\fR
.RS 4
By default the command records the date from the e\-mail message as the commit author date, and uses the time of commit creation as the committer date\&. This allows the user to lie about the committer date by using the same value as the author date\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBWarning\fR
.ps -1
.br
The history walking machinery assumes that commits have non\-decreasing commit timestamps\&. You should consider if you really need to use this option\&. Then you should only use this option to override the committer date when applying commits on top of a base which commit is older (in terms of the commit date) than the oldest patch you are applying\&.
.sp .5v
.RE
.RE
.PP
\fB\-\-ignore\-date\fR
.RS 4
By default the command records the date from the e\-mail message as the commit author date, and uses the time of commit creation as the committer date\&. This allows the user to lie about the author date by using the same value as the committer date\&.
.RE
.PP
\fB\-\-skip\fR
.RS 4
Skip the current patch\&. This is only meaningful when restarting an aborted patch\&.
.RE
.PP
\fB\-S\fR[\fI\fR], \fB\-\-gpg\-sign\fR[\fB=\fR\fI\fR], \fB\-\-no\-gpg\-sign\fR
.RS 4
GPG\-sign commits\&. The
\fI\fR
is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
\fB\-\-no\-gpg\-sign\fR
is useful to countermand both
\fBcommit\&.gpgSign\fR
configuration variable, and earlier
\fB\-\-gpg\-sign\fR\&.
.RE
.PP
\fB\-\-continue\fR, \fB\-r\fR, \fB\-\-resolved\fR
.RS 4
After a patch failure (e\&.g\&. attempting to apply conflicting patch), the user has applied it by hand and the index file stores the result of the application\&. Make a commit using the authorship and commit log extracted from the e\-mail message and the current index file, and continue\&.
.RE
.PP
\fB\-\-resolvemsg=\fR\fI\fR
.RS 4
When a patch failure occurs,
\fI\fR
will be printed to the screen before exiting\&. This overrides the standard message informing you to use
\fB\-\-continue\fR
or
\fB\-\-skip\fR
to handle the failure\&. This is solely for internal use between
\fBgit-rebase\fR(1)
and
\fBgit-am\fR(1)\&.
.RE
.PP
\fB\-\-abort\fR
.RS 4
Restore the original branch and abort the patching operation\&. Revert the contents of files involved in the am operation to their pre\-am state\&.
.RE
.PP
\fB\-\-quit\fR
.RS 4
Abort the patching operation but keep
\fBHEAD\fR
and the index untouched\&.
.RE
.PP
\fB\-\-retry\fR
.RS 4
Try to apply the last conflicting patch again\&. This is generally only useful for passing extra options to the retry attempt (e\&.g\&.,
\fB\-\-3way\fR), since otherwise you\(cqll just see the same failure again\&.
.RE
.PP
\fB\-\-show\-current\-patch\fR[\fB=\fR(\fBdiff\fR|\fBraw\fR)]
.RS 4
Show the message at which
\fBgit-am\fR(1)
has stopped due to conflicts\&. If
\fBraw\fR
is specified, show the raw contents of the e\-mail message; if
\fBdiff\fR, show the diff portion only\&. Defaults to
\fBraw\fR\&.
.RE
.PP
\fB\-\-allow\-empty\fR
.RS 4
After a patch failure on an input e\-mail message lacking a patch, create an empty commit with the contents of the e\-mail message as its log message\&.
.RE
.SH "DISCUSSION"
.sp
The commit author name is taken from the "From: " line of the message, and commit author date is taken from the "Date: " line of the message\&. The "Subject: " line is used as the title of the commit, after stripping common prefix "[PATCH ]"\&. The "Subject: " line is supposed to concisely describe what the commit is about in one line of text\&.
.sp
"From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers\&.
.sp
The commit message is formed by the title taken from the "Subject: ", a blank line and the body of the message up to where the patch begins\&. Excess whitespace at the end of each line is automatically stripped\&.
.sp
The patch is expected to be inline, directly following the message\&. Any line that is of the form:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
three\-dashes and end\-of\-line, or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a line that begins with
\fBdiff\fR
\fB\-\fR, or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a line that begins with `Index: `
.RE
.sp
is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line\&.
.sp
This means that the contents of the commit message can inadvertently interrupt the processing (see the CAVEATS section below)\&.
.sp
When initially invoking \fBgit-am\fR(1), you give it the names of the mailboxes to process\&. Upon seeing the first patch that does not apply, it aborts in the middle\&. You can recover from this in one of two ways:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
skip the current patch by re\-running the command with the
\fB\-\-skip\fR
option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
hand resolve the conflict in the working directory, and update the index file to bring it into a state that the patch should have produced\&. Then run the command with the
\fB\-\-continue\fR
option\&.
.RE
.sp
The command refuses to process new mailboxes until the current operation is finished, so if you decide to start over from scratch, run \fBgit\fR \fBam\fR \fB\-\-abort\fR before running the command with mailbox names\&.
.sp
Before any patches are applied, \fBORIG_HEAD\fR is set to the tip of the current branch\&. This is useful if you have problems with multiple commits, like running \fBgit-am\fR(1) on the wrong branch or an error in the commits that is more easily fixed by changing the mailbox (e\&.g\&. errors in the \fBFrom:\fR lines)\&.
.SH "CAVEATS"
.sp
The output from \fBgit-format-patch\fR(1) can lead to a different commit message when applied with \fBgit-am\fR(1)\&. The patch that is applied may also be different from the one that was generated, or patch application may fail outright\&. See the DISCUSSION section above for the syntactic rules\&.
.sp
Note that this is especially problematic for unindented diffs that occur in the commit message; the diff in the commit message might get applied along with the patch section, or the patch application machinery might trip up because the patch target doesn\(cqt apply\&. This could for example be caused by a diff in a Markdown code block\&.
.sp
The solution for this is to indent the diff or other text that could cause problems\&.
.sp
This loss of fidelity might be simple to notice if you are applying patches directly from a mailbox\&. However, changes originating from Git could be applied in bulk, in which case this would be much harder to notice\&. This could for example be a Linux distribution which uses patch files to apply changes on top of the commits from the upstream repositories\&. This goes to show that this behavior does not only impact email workflows\&.
.sp
Given these limitations, one might be tempted to use a general\-purpose utility like \fBpatch\fR(1) instead\&. However, \fBpatch\fR(1) will not only look for unindented diffs (like \fBgit-am\fR(1)) but will try to apply indented diffs as well\&.
.SH "HOOKS"
.sp
This command can run \fBapplypatch\-msg\fR, \fBpre\-applypatch\fR, and \fBpost\-applypatch\fR hooks\&. See \fBgithooks\fR(5) for more information\&.
.sp
See the \fB\-\-verify\fR/\fB\-n\fR/\fB\-\-no\-verify\fR options\&.
.SH "CONFIGURATION"
.sp
Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
.PP
\fBam\&.keepcr\fR
.RS 4
If true,
\fBgit-am\fR(1)
will call
\fBgit-mailsplit\fR(1)
for patches in mbox format with parameter
\fB\-\-keep\-cr\fR\&. In this case
\fBgit-mailsplit\fR(1)
will not remove
\fB\er\fR
from lines ending with
\fB\er\en\fR\&. Can be overridden by giving
\fB\-\-no\-keep\-cr\fR
from the command line\&.
.RE
.PP
\fBam\&.threeWay\fR
.RS 4
By default,
\fBgit-am\fR(1)
will fail if the patch does not apply cleanly\&. When set to true, this setting tells
\fBgit-am\fR(1)
to fall back on 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally (equivalent to giving the
\fB\-\-3way\fR
option from the command line)\&. Defaults to
\fBfalse\fR\&.
.RE
.PP
\fBam\&.messageId\fR
.RS 4
Add a
\fBMessage\-ID\fR
trailer based on the email header to the commit when using
\fBgit-am\fR(1)
(see
\fBgit-interpret-trailers\fR(1))\&. See also the
\fB\-\-message\-id\fR
and
\fB\-\-no\-message\-id\fR
options\&.
.RE
.SH "SEE ALSO"
.sp
\fBgit-apply\fR(1), \fBgit-format-patch\fR(1)\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
./man1/git-annotate.1 0000664 0000000 0000000 00000024634 15214513225 0014534 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-annotate
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-ANNOTATE" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-annotate \- Annotate file lines with commit information
.SH "SYNOPSIS"
.sp
.nf
\fIgit annotate\fR [] [] [] [\-\-]
.fi
.SH "DESCRIPTION"
.sp
Annotates each line in the given file with information from the commit which introduced the line\&. Optionally annotates from a given revision\&.
.sp
The only difference between this command and \fBgit-blame\fR(1) is that they use slightly different output formats, and this command exists only for backward compatibility to support existing scripts, and provide a more familiar command name for people coming from other SCM systems\&.
.SH "OPTIONS"
.PP
\fB\-b\fR
.RS 4
Show blank SHA\-1 for boundary commits\&. This can also be controlled via the
\fBblame\&.blankBoundary\fR
config option\&.
.RE
.PP
\fB\-\-root\fR
.RS 4
Do not treat root commits as boundaries\&. This can also be controlled via the
\fBblame\&.showRoot\fR
config option\&.
.RE
.PP
\fB\-\-show\-stats\fR
.RS 4
Include additional statistics at the end of blame output\&.
.RE
.PP
\fB\-L\fR \fI\fR\fB,\fR\fI\fR, \fB\-L\fR \fB:\fR\fI\fR
.RS 4
Annotate only the line range given by
\fI\fR\fB,\fR\fI\fR, or by the function name regex
\fI\fR\&. May be specified multiple times\&. Overlapping ranges are allowed\&.
.sp
\fI\fR
and
\fI\fR
are optional\&.
\fB\-L\fR
\fI\fR
or
\fB\-L\fR
\fI\fR\fB,\fR
spans from
\fI\fR
to end of file\&.
\fB\-L\fR
\fB,\fR\fI\fR
spans from start of file to
\fI\fR\&.
.sp
\fI\fR
and
\fI\fR
can take one of these forms:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fI\fR
.sp
If
\fI\fR
or
\fI\fR
is a number, it specifies an absolute line number (lines count from 1)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB/\fR\fI\fR\fB/\fR
.sp
This form will use the first line matching the given POSIX
\fI\fR\&. If
\fI\fR
is a regex, it will search from the end of the previous
\fB\-L\fR
range, if any, otherwise from the start of file\&. If
\fI\fR
is
\fB^/\fR\fI\fR\fB/\fR, it will search from the start of file\&. If
\fI\fR
is a regex, it will search starting at the line given by
\fI\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB+\fR\fI\fR
or
\fB\-\fR\fI\fR
.sp
This is only valid for
\fI\fR
and will specify a number of lines before or after the line given by
\fI\fR\&.
.RE
.sp
If
\fB:\fR\fI\fR
is given in place of
\fI\fR
and
\fI\fR, it is a regular expression that denotes the range from the first funcname line that matches
\fI\fR, up to the next funcname line\&.
\fB:\fR\fI\fR
searches from the end of the previous
\fB\-L\fR
range, if any, otherwise from the start of file\&.
\fB^:\fR\fI\fR
searches from the start of file\&. The function names are determined in the same way as
\fBgit\fR
\fBdiff\fR
works out patch hunk headers (see
\fIDefining a custom hunk\-header\fR
in
\fBgitattributes\fR(5))\&.
.RE
.PP
\fB\-l\fR
.RS 4
Show long rev (Default: off)\&.
.RE
.PP
\fB\-t\fR
.RS 4
Show raw timestamp (Default: off)\&.
.RE
.PP
\fB\-S\fR \fI\fR
.RS 4
Use revisions from
\fI\fR
instead of calling
\fBgit-rev-list\fR(1)\&.
.RE
.PP
\fB\-\-reverse\fR \fI\fR\fB\&.\&.\fR\fI\fR
.RS 4
Walk history forward instead of backward\&. Instead of showing the revision in which a line appeared, this shows the last revision in which a line has existed\&. This requires a range of revision like
\fI\fR\fB\&.\&.\fR\fI\fR
where the path to blame exists in
\fI\fR\&.
\fBgit\fR
\fBblame\fR
\fB\-\-reverse\fR
\fI\fR
is taken as
\fBgit\fR
\fBblame\fR
\fB\-\-reverse\fR
\fI\fR\fB\&.\&.\fR\fBHEAD\fR
for convenience\&.
.RE
.PP
\fB\-\-first\-parent\fR
.RS 4
Follow only the first parent commit upon seeing a merge commit\&. This option can be used to determine when a line was introduced to a particular integration branch, rather than when it was introduced to the history overall\&.
.RE
.PP
\fB\-p\fR, \fB\-\-porcelain\fR
.RS 4
Show in a format designed for machine consumption\&.
.RE
.PP
\fB\-\-line\-porcelain\fR
.RS 4
Show the porcelain format, but output commit information for each line, not just the first time a commit is referenced\&. Implies
\fB\-\-porcelain\fR\&.
.RE
.PP
\fB\-\-incremental\fR
.RS 4
Show the result incrementally in a format designed for machine consumption\&.
.RE
.PP
\fB\-\-encoding=\fR\fI\fR
.RS 4
Specify the encoding used to output author names and commit summaries\&. Setting it to
\fBnone\fR
makes blame output unconverted data\&. For more information see the discussion about encoding in the
\fBgit-log\fR(1)
manual page\&.
.RE
.PP
\fB\-\-contents\fR \fI\fR
.RS 4
Annotate using the contents from
\fI\fR, starting from
\fI\fR
if it is specified, and
\fBHEAD\fR
otherwise\&. You may specify
\fB\-\fR
to make the command read from the standard input for the file contents\&.
.RE
.PP
\fB\-\-date\fR \fI\fR
.RS 4
Specify the format used to output dates\&. If
\fB\-\-date\fR
is not provided, the value of the
\fBblame\&.date\fR
config variable is used\&. If the
\fBblame\&.date\fR
config variable is also not set, the iso format is used\&. For supported values, see the discussion of the
\fB\-\-date\fR
option at
\fBgit-log\fR(1)\&.
.RE
.PP
\fB\-\-progress\fR, \fB\-\-no\-progress\fR
.RS 4
Enable progress reporting on the standard error stream even if not attached to a terminal\&. By default, progress status is reported only when it is attached\&. You can\(cqt use
\fB\-\-progress\fR
together with
\fB\-\-porcelain\fR
or
\fB\-\-incremental\fR\&.
.RE
.PP
\fB\-M\fR[\fI\fR]
.RS 4
Detect moved or copied lines within a file\&. When a commit moves or copies a block of lines (e\&.g\&. the original file has
\fIA\fR
and then
\fIB\fR, and the commit changes it to
\fIB\fR
and then
\fIA\fR), the traditional
\fBblame\fR
algorithm notices only half of the movement and typically blames the lines that were moved up (i\&.e\&.
\fIB\fR) to the parent and assigns blame to the lines that were moved down (i\&.e\&.
\fIA\fR) to the child commit\&. With this option, both groups of lines are blamed on the parent by running extra passes of inspection\&.
.sp
\fI\fR
is optional, but it is the lower bound on the number of alphanumeric characters that Git must detect as moving/copying within a file for it to associate those lines with the parent commit\&. The default value is 20\&.
.RE
.PP
\fB\-C\fR[\fI\fR]
.RS 4
In addition to
\fB\-M\fR, detect lines moved or copied from other files that were modified in the same commit\&. This is useful when you reorganize your program and move code around across files\&. When this option is given twice, the command additionally looks for copies from other files in the commit that creates the file\&. When this option is given three times, the command additionally looks for copies from other files in any commit\&.
.sp
\fI\fR
is optional, but it is the lower bound on the number of alphanumeric characters that Git must detect as moving/copying between files for it to associate those lines with the parent commit\&. And the default value is 40\&. If there are more than one
\fB\-C\fR
options given, the
\fI\fR
argument of the last
\fB\-C\fR
will take effect\&.
.RE
.PP
\fB\-\-ignore\-rev\fR \fI\fR
.RS 4
Ignore changes made by the revision when assigning blame, as if the change never happened\&. Lines that were changed or added by an ignored commit will be blamed on the previous commit that changed that line or nearby lines\&. This option may be specified multiple times to ignore more than one revision\&. If the
\fBblame\&.markIgnoredLines\fR
config option is set, then lines that were changed by an ignored commit and attributed to another commit will be marked with a ? in the blame output\&. If the
\fBblame\&.markUnblamableLines\fR
config option is set, then those lines touched by an ignored commit that we could not attribute to another revision are marked with a
\fB*\fR\&. In the porcelain modes, we print
\fBignored\fR
and
\fBunblamable\fR
on a newline respectively\&.
.RE
.PP
\fB\-\-ignore\-revs\-file\fR \fI\fR
.RS 4
Ignore revisions listed in
\fI\fR, which must be in the same format as an
\fBfsck\&.skipList\fR\&. This option may be repeated, and these files will be processed after any files specified with the
\fBblame\&.ignoreRevsFile\fR
config option\&. An empty file name, "", will clear the list of revs from previously processed files\&.
.RE
.PP
\fB\-\-color\-lines\fR
.RS 4
Color line annotations in the default format differently if they come from the same commit as the preceding line\&. This makes it easier to distinguish code blocks introduced by different commits\&. The color defaults to cyan and can be adjusted using the
\fBcolor\&.blame\&.repeatedLines\fR
config option\&.
.RE
.PP
\fB\-\-color\-by\-age\fR
.RS 4
Color line annotations depending on the age of the line in the default format\&. The
\fBcolor\&.blame\&.highlightRecent\fR
config option controls what color is used for each range of age\&.
.RE
.PP
\fB\-h\fR
.RS 4
Show help message\&.
.RE
.SH "SEE ALSO"
.sp
\fBgit-blame\fR(1)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
./man1/git-apply.1 0000664 0000000 0000000 00000035120 15214513225 0014040 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-apply
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-APPLY" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-apply \- Apply a patch to files and/or to the index
.SH "SYNOPSIS"
.sp
.nf
\fBgit\fR \fBapply\fR [\fB\-\-stat\fR] [\fB\-\-numstat\fR] [\fB\-\-summary\fR] [\fB\-\-check\fR]
[\fB\-\-index\fR | \fB\-\-intent\-to\-add\fR] [\fB\-\-3way\fR] [\fB\-\-ours\fR | \fB\-\-theirs\fR | \fB\-\-union\fR]
[\fB\-\-apply\fR] [\fB\-\-no\-add\fR] [\fB\-\-build\-fake\-ancestor=\fR\fI\fR] [\fB\-R\fR | \fB\-\-reverse\fR]
[\fB\-\-allow\-binary\-replacement\fR | \fB\-\-binary\fR] [\fB\-\-reject\fR] [\fB\-z\fR]
[\fB\-p\fR\fI\fR] [\fB\-C\fR\fI\fR] [\fB\-\-inaccurate\-eof\fR] [\fB\-\-recount\fR] [\fB\-\-cached\fR]
[\fB\-\-ignore\-space\-change\fR | \fB\-\-ignore\-whitespace\fR]
[\fB\-\-whitespace=\fR(\fBnowarn\fR|\fBwarn\fR|\fBfix\fR|\fBerror\fR|\fBerror\-all\fR)]
[\fB\-\-exclude=\fR\fI\fR] [\fB\-\-include=\fR\fI\fR] [\fB\-\-directory=\fR\fI\fR]
[\fB\-\-verbose\fR | \fB\-\-quiet\fR] [\fB\-\-unsafe\-paths\fR] [\fB\-\-allow\-empty\fR] [\fI\fR\&...\:]
.fi
.SH "DESCRIPTION"
.sp
Reads the supplied diff output (i\&.e\&. "a patch") and applies it to files\&. When running from a subdirectory in a repository, patched paths outside the directory are ignored\&. With the \fB\-\-index\fR option, the patch is also applied to the index, and with the \fB\-\-cached\fR option, the patch is only applied to the index\&. Without these options, the command applies the patch only to files, and does not require them to be in a Git repository\&.
.sp
This command applies the patch but does not create a commit\&. Use \fBgit-am\fR(1) to create commits from patches generated by \fBgit-format-patch\fR(1) and/or received by email\&.
.SH "OPTIONS"
.PP
\fI\fR\&.\&.\&.
.RS 4
The files to read the patch from\&.
\fB\-\fR
can be used to read from the standard input\&.
.RE
.PP
\fB\-\-stat\fR
.RS 4
Instead of applying the patch, output diffstat for the input\&. Turns off "apply"\&.
.RE
.PP
\fB\-\-numstat\fR
.RS 4
Similar to
\fB\-\-stat\fR, but shows the number of added and deleted lines in decimal notation and the pathname without abbreviation, to make it more machine friendly\&. For binary files, outputs two
\fB\-\fR
instead of saying
\fB0\fR
\fB0\fR\&. Turns off "apply"\&.
.RE
.PP
\fB\-\-summary\fR
.RS 4
Instead of applying the patch, output a condensed summary of information obtained from git diff extended headers, such as creations, renames, and mode changes\&. Turns off "apply"\&.
.RE
.PP
\fB\-\-check\fR
.RS 4
Instead of applying the patch, see if the patch is applicable to the current working tree and/or the index file and detects errors\&. Turns off "apply"\&.
.RE
.PP
\fB\-\-index\fR
.RS 4
Apply the patch to both the index and the working tree (or merely check that it would apply cleanly to both if
\fB\-\-check\fR
is in effect)\&. Note that
\fB\-\-index\fR
expects index entries and working tree copies for relevant paths to be identical (their contents and metadata such as file mode must match), and will raise an error if they are not, even if the patch would apply cleanly to both the index and the working tree in isolation\&.
.RE
.PP
\fB\-\-cached\fR
.RS 4
Apply the patch to just the index, without touching the working tree\&. If
\fB\-\-check\fR
is in effect, merely check that it would apply cleanly to the index entry\&.
.RE
.PP
\fB\-N\fR, \fB\-\-intent\-to\-add\fR
.RS 4
When applying the patch only to the working tree, mark new files to be added to the index later (see
\fB\-\-intent\-to\-add\fR
option in
\fBgit-add\fR(1))\&. This option is ignored if
\fB\-\-index\fR
or
\fB\-\-cached\fR
are used, and has no effect outside a Git repository\&. Note that
\fB\-\-index\fR
could be implied by other options such as
\fB\-\-3way\fR\&.
.RE
.PP
\fB\-3\fR, \fB\-\-3way\fR
.RS 4
Attempt 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally, possibly leaving the conflict markers in the files in the working tree for the user to resolve\&. This option implies the
\fB\-\-index\fR
option unless the
\fB\-\-cached\fR
option is used, and is incompatible with the
\fB\-\-reject\fR
option\&. When used with the
\fB\-\-cached\fR
option, any conflicts are left at higher stages in the cache\&.
.RE
.PP
\fB\-\-ours\fR, \fB\-\-theirs\fR, \fB\-\-union\fR
.RS 4
Instead of leaving conflicts in the file, resolve conflicts favouring our (or their or both) side of the lines\&. Requires
\fB\-\-3way\fR\&.
.RE
.PP
\fB\-\-build\-fake\-ancestor=\fR\fI\fR
.RS 4
Newer
\fBgit\fR
\fBdiff\fR
output has embedded
\fIindex information\fR
for each blob to help identify the original version that the patch applies to\&. When this flag is given, and if the original versions of the blobs are available locally, builds a temporary index containing those blobs\&.
.sp
When a pure mode change is encountered (which has no index information), the information is read from the current index instead\&.
.RE
.PP
\fB\-R\fR, \fB\-\-reverse\fR
.RS 4
Apply the patch in reverse\&.
.RE
.PP
\fB\-\-reject\fR
.RS 4
For atomicity,
\fBgit\fR
\fBapply\fR
by default fails the whole patch and does not touch the working tree when some of the hunks do not apply\&. This option makes it apply the parts of the patch that are applicable, and leave the rejected hunks in corresponding
\fB*\&.rej\fR
files\&.
.RE
.PP
\fB\-z\fR
.RS 4
When
\fB\-\-numstat\fR
has been given, do not munge pathnames, but use a NUL\-terminated machine\-readable format\&.
.sp
Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
\fBcore\&.quotePath\fR
(see
\fBgit-config\fR(1))\&.
.RE
.PP
\fB\-p\fR\fI\fR
.RS 4
Remove
\fI\fR
leading path components (separated by slashes) from traditional diff paths\&. E\&.g\&., with
\fB\-p2\fR, a patch against
\fBa/dir/file\fR
will be applied directly to
\fBfile\fR\&. The default is 1\&.
.RE
.PP
\fB\-C\fR\fI\fR
.RS 4
Ensure at least
\fI\fR
lines of surrounding context match before and after each change\&. When fewer lines of surrounding context exist they all must match\&. By default no context is ever ignored\&.
.RE
.PP
\fB\-\-unidiff\-zero\fR
.RS 4
By default,
\fBgit\fR
\fBapply\fR
expects that the patch being applied is a unified diff with at least one line of context\&. This provides good safety measures, but breaks down when applying a diff generated with
\fB\-\-unified=0\fR\&. To bypass these checks use
\fB\-\-unidiff\-zero\fR\&.
.sp
Note, for the reasons stated above, the usage of context\-free patches is discouraged\&.
.RE
.PP
\fB\-\-apply\fR
.RS 4
If you use any of the options marked "Turns off
\fIapply\fR" above,
\fBgit\fR
\fBapply\fR
reads and outputs the requested information without actually applying the patch\&. Give this flag after those flags to also apply the patch\&.
.RE
.PP
\fB\-\-no\-add\fR
.RS 4
When applying a patch, ignore additions made by the patch\&. This can be used to extract the common part between two files by first running
\fBdiff\fR
on them and applying the result with this option, which would apply the deletion part but not the addition part\&.
.RE
.PP
\fB\-\-allow\-binary\-replacement\fR, \fB\-\-binary\fR
.RS 4
Historically we did not allow binary patch application without an explicit permission from the user, and this flag was the way to do so\&. Currently, we always allow binary patch application, so this is a no\-op\&.
.RE
.PP
\fB\-\-exclude=\fR\fI\fR
.RS 4
Don\(cqt apply changes to files matching
\fI\fR\&. This can be useful when importing patchsets, where you want to exclude certain files or directories\&.
.RE
.PP
\fB\-\-include=\fR\fI\fR
.RS 4
Apply changes to files matching the
\fI\fR\&. This can be useful when importing patchsets, where you want to include certain files or directories\&.
.sp
When
\fB\-\-exclude\fR
and
\fB\-\-include\fR
patterns are used, they are examined in the order they appear on the command line, and the first match determines if a patch to each path is used\&. A patch to a path that does not match any include/exclude pattern is used by default if there is no include pattern on the command line, and ignored if there is any include pattern\&.
.RE
.PP
\fB\-\-ignore\-space\-change\fR, \fB\-\-ignore\-whitespace\fR
.RS 4
When applying a patch, ignore changes in whitespace in context lines if necessary\&. Context lines will preserve their whitespace, and they will not undergo whitespace fixing regardless of the value of the
\fB\-\-whitespace\fR
option\&. New lines will still be fixed, though\&.
.RE
.PP
\fB\-\-whitespace=\fR\fI\fR
.RS 4
When applying a patch, detect a new or modified line that has whitespace errors\&. What are considered whitespace errors is controlled by
\fBcore\&.whitespace\fR
configuration\&. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors\&.
.sp
By default, the command outputs warning messages but applies the patch\&. When
\fBgit\-apply\fR
is used for statistics and not applying a patch, it defaults to
\fBnowarn\fR\&.
.sp
You can use different
\fI\fR
values to control this behavior:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBnowarn\fR
turns off the trailing whitespace warning\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBwarn\fR
outputs warnings for a few such errors, but applies the patch as\-is (default)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBfix\fR
outputs warnings for a few such errors, and applies the patch after fixing them (\fBstrip\fR
is a synonym \(em the tool used to consider only trailing whitespace characters as errors, and the fix involved
\fIstripping\fR
them, but modern Gits do more)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBerror\fR
outputs warnings for a few such errors, and refuses to apply the patch\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBerror\-all\fR
is similar to
\fBerror\fR
but shows all errors\&.
.RE
.RE
.PP
\fB\-\-inaccurate\-eof\fR
.RS 4
Under certain circumstances, some versions of
\fBdiff\fR
do not correctly detect a missing new\-line at the end of the file\&. As a result, patches created by such
\fBdiff\fR
programs do not record incomplete lines correctly\&. This option adds support for applying such patches by working around this bug\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Report progress to stderr\&. By default, only a message about the current patch being applied will be printed\&. This option will cause additional information to be reported\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Suppress stderr output\&. Messages about patch status and progress will not be printed\&.
.RE
.PP
\fB\-\-recount\fR
.RS 4
Do not trust the line counts in the hunk headers, but infer them by inspecting the patch (e\&.g\&. after editing the patch without adjusting the hunk headers appropriately)\&.
.RE
.PP
\fB\-\-directory=\fR\fI\fR
.RS 4
Prepend
\fI\fR
to all filenames\&. If a
\fB\-p\fR
argument was also passed, it is applied before prepending the new root\&.
.sp
For example, a patch that talks about updating
\fBa/git\-gui\&.sh\fR
to
\fBb/git\-gui\&.sh\fR
can be applied to the file in the working tree
\fBmodules/git\-gui/git\-gui\&.sh\fR
by running
\fBgit\fR
\fBapply\fR
\fB\-\-directory=modules/git\-gui\fR\&.
.RE
.PP
\fB\-\-unsafe\-paths\fR
.RS 4
By default, a patch that affects outside the working area (either a Git controlled working tree, or the current working directory when
\fBgit\fR
\fBapply\fR
is used as a replacement of GNU
\fBpatch\fR) is rejected as a mistake (or a mischief)\&.
.sp
When
\fBgit\fR
\fBapply\fR
is used as a "better GNU
\fBpatch\fR", the user can pass the
\fB\-\-unsafe\-paths\fR
option to override this safety check\&. This option has no effect when
\fB\-\-index\fR
or
\fB\-\-cached\fR
is in use\&.
.RE
.PP
\fB\-\-allow\-empty\fR
.RS 4
Don\(cqt return an error for patches containing no diff\&. This includes empty patches and patches with commit text only\&.
.RE
.SH "CONFIGURATION"
.sp
Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
.PP
\fBapply\&.ignoreWhitespace\fR
.RS 4
When set to
\fBchange\fR, tells
\fBgit\fR
\fBapply\fR
to ignore changes in whitespace, in the same way as the
\fB\-\-ignore\-space\-change\fR
option\&. When set to one of:
\fBno\fR,
\fBnone\fR,
\fBnever\fR,
\fBfalse\fR, it tells
\fBgit\fR
\fBapply\fR
to respect all whitespace differences\&.
.RE
.PP
\fBapply\&.whitespace\fR
.RS 4
Tells
\fBgit\fR
\fBapply\fR
how to handle whitespace, in the same way as the
\fB\-\-whitespace\fR
option\&.
.RE
.SH "SUBMODULES"
.sp
If the patch contains any changes to submodules then \fBgit\fR \fBapply\fR treats these changes as follows\&.
.sp
If \fB\-\-index\fR is specified (explicitly or implicitly), then the submodule commits must match the index exactly for the patch to apply\&. If any of the submodules are checked\-out, then these check\-outs are completely ignored, i\&.e\&., they are not required to be up to date or clean and they are not updated\&.
.sp
If \fB\-\-index\fR is not specified, then the submodule commits in the patch are ignored and only the absence or presence of the corresponding subdirectory is checked and (if possible) updated\&.
.SH "SEE ALSO"
.sp
\fBgit-am\fR(1)\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
./man1/git-archimport.1 0000664 0000000 0000000 00000012530 15214513225 0015063 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-archimport
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-ARCHIMPORT" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-archimport \- Import a GNU Arch repository into Git
.SH "SYNOPSIS"
.sp
.nf
\fIgit archimport\fR [\-h] [\-v] [\-o] [\-a] [\-f] [\-T] [\-D ] [\-t ]
/[:]\&...\:
.fi
.SH "DESCRIPTION"
.sp
Imports a project from one or more GNU Arch repositories\&. It will follow branches and repositories within the namespaces defined by the / parameters supplied\&. If it cannot find the remote branch a merge comes from it will just import it as a regular commit\&. If it can find it, it will mark it as a merge whenever possible (see discussion below)\&.
.sp
The script expects you to provide the key roots where it can start the import from an \fIinitial import\fR or \fItag\fR type of Arch commit\&. It will follow and import new branches within the provided roots\&.
.sp
It expects to be dealing with one project only\&. If it sees branches that have different roots, it will refuse to run\&. In that case, edit your / parameters to define clearly the scope of the import\&.
.sp
\fIgit archimport\fR uses \fBtla\fR extensively in the background to access the Arch repository\&. Make sure you have a recent version of \fBtla\fR available in the path\&. \fBtla\fR must know about the repositories you pass to \fIgit archimport\fR\&.
.sp
For the initial import, \fIgit archimport\fR expects to find itself in an empty directory\&. To follow the development of a project that uses Arch, rerun \fIgit archimport\fR with the same parameters as the initial import to perform incremental imports\&.
.sp
While \fIgit archimport\fR will try to create sensible branch names for the archives that it imports, it is also possible to specify Git branch names manually\&. To do so, write a Git branch name after each / parameter, separated by a colon\&. This way, you can shorten the Arch branch names and convert Arch jargon to Git jargon, for example mapping a "PROJECT\-\-devo\-\-VERSION" branch to "master"\&.
.sp
Associating multiple Arch branches to one Git branch is possible; the result will make the most sense only if no commits are made to the first branch, after the second branch is created\&. Still, this is useful to convert Arch repositories that had been rotated periodically\&.
.SH "MERGES"
.sp
Patch merge data from Arch is used to mark merges in Git as well\&. Git does not care much about tracking patches, and only considers a merge when a branch incorporates all the commits since the point they forked\&. The end result is that Git will have a good idea of how far branches have diverged\&. So the import process does lose some patch\-trading metadata\&.
.sp
Fortunately, when you try and merge branches imported from Arch, Git will find a good merge base, and it has a good chance of identifying patches that have been traded out\-of\-sequence between the branches\&.
.SH "OPTIONS"
.PP
\-h
.RS 4
Display usage\&.
.RE
.PP
\-v
.RS 4
Verbose output\&.
.RE
.PP
\-T
.RS 4
Many tags\&. Will create a tag for every commit, reflecting the commit name in the Arch repository\&.
.RE
.PP
\-f
.RS 4
Use the fast patchset import strategy\&. This can be significantly faster for large trees, but cannot handle directory renames or permissions changes\&. The default strategy is slow and safe\&.
.RE
.PP
\-o
.RS 4
Use this for compatibility with old\-style branch names used by earlier versions of
\fIgit archimport\fR\&. Old\-style branch names were category\-\-branch, whereas new\-style branch names are archive,category\-\-branch\-\-version\&. In both cases, names given on the command\-line will override the automatically\-generated ones\&.
.RE
.PP
\-D
.RS 4
Follow merge ancestry and attempt to import trees that have been merged from\&. Specify a depth greater than 1 if patch logs have been pruned\&.
.RE
.PP
\-a
.RS 4
Attempt to auto\-register archives at
\fBhttp://mirrors\&.sourcecontrol\&.net\fR
This is particularly useful with the \-D option\&.
.RE
.PP
\-t
.RS 4
Override the default tempdir\&.
.RE
.PP
/
.RS 4
/ identifier in a format that
\fBtla\fR
\fBlog\fR
understands\&.
.RE
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
./man1/git-archive.1 0000664 0000000 0000000 00000025733 15214513225 0014345 0 ustar 00root root 0000000 0000000 '\" t
.\" Title: git-archive
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2
.\" Date: 2026-06-17
.\" Manual: Git Manual
.\" Source: Git 2.55.0.rc1
.\" Language: English
.\"
.TH "GIT\-ARCHIVE" "1" "2026-06-17" "Git 2\&.55\&.0\&.rc1" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-archive \- Create an archive of files from a named tree
.SH "SYNOPSIS"
.sp
.nf
\fIgit archive\fR [\-\-format=] [\-\-list] [\-\-prefix=/] []
[\-o | \-\-output=] [\-\-worktree\-attributes]
[\-\-remote= [\-\-exec=]]
[\&...\:]
.fi
.SH "DESCRIPTION"
.sp
Creates an archive of the specified format containing the tree structure for the named tree, and writes it out to the standard output\&. If is specified it is prepended to the filenames in the archive\&.
.sp
\fIgit archive\fR behaves differently when given a tree ID as opposed to a commit ID or tag ID\&. When a tree ID is provided, the current time is used as the modification time of each file in the archive\&. On the other hand, when a commit ID or tag ID is provided, the commit time as recorded in the referenced commit object is used instead\&. Additionally the commit ID is stored in a global extended pax header if the tar format is used; it can be extracted using \fIgit get\-tar\-commit\-id\fR\&. In ZIP files it is stored as a file comment\&.
.SH "OPTIONS"
.PP
\-\-format=
.RS 4
Format of the resulting archive\&. Possible values are
\fBtar\fR,
\fBzip\fR,
\fBtar\&.gz\fR,
\fBtgz\fR, and any format defined using the configuration option
\fBtar\&.\fR\fI\fR\fB\&.command\fR\&. If
\fB\-\-format\fR
is not given, and the output file is specified, the format is inferred from the filename if possible (e\&.g\&. writing to
\fBfoo\&.zip\fR
makes the output to be in the
\fBzip\fR
format)\&. Otherwise the output format is
\fBtar\fR\&.
.RE
.PP
\-l, \-\-list
.RS 4
Show all available formats\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Report progress to stderr\&.
.RE
.PP
\-\-prefix=/
.RS 4
Prepend / to paths in the archive\&. Can be repeated; its rightmost value is used for all tracked files\&. See below which value gets used by
\fB\-\-add\-file\fR\&.
.sp
The is used as given and is not normalized\&. It may include leading slashes or parent directory components (e\&.g\&.,
\fB\&.\&.\fR\fB/\fR)\&. Some archive consumers may treat such paths as potentially unsafe and adjust or warn during extraction\&.
.RE
.PP
\-o , \-\-output=
.RS 4
Write the archive to instead of stdout\&.
.RE
.PP
\-\-add\-file=
.RS 4
Add a non\-tracked file to the archive\&. Can be repeated to add multiple files\&. The path of the file in the archive is built by concatenating the value of the last
\fB\-\-prefix\fR
option (if any) before this
\fB\-\-add\-file\fR
and the basename of \&.
.RE
.PP
\-\-add\-virtual\-file=:
.RS 4
Add the specified contents to the archive\&. Can be repeated to add multiple files\&.
.sp
The
\fI\fR
argument can start and end with a literal double\-quote character; the contained file name is interpreted as a C\-style string, i\&.e\&. the backslash is interpreted as escape character\&. The path must be quoted if it contains a colon, to avoid the colon from being misinterpreted as the separator between the path and the contents, or if the path begins or ends with a double\-quote character\&.
.sp
The file mode is limited to a regular file, and the option may be subject to platform\-dependent command\-line limits\&. For non\-trivial cases, write an untracked file and use
\fB\-\-add\-file\fR
instead\&.
.sp
Note that unlike
\fB\-\-add\-file\fR
the path created in the archive is not affected by the
\fB\-\-prefix\fR
option, as a full
\fI\fR
can be given as the value of the option\&.
.RE
.PP
\-\-worktree\-attributes
.RS 4
Look for attributes in \&.gitattributes files in the working tree as well (see
the section called \(lqATTRIBUTES\(rq)\&.
.RE
.PP
\-\-mtime=