man1/git-mailinfo.1

   1 '\" t
   2 .\"     Title: git-mailinfo
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.603.g94b60adee3
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-MAILINFO" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-mailinfo \- Extracts patch and authorship from a single e\-mail message
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit mailinfo\fR [\-k|\-b] [\-u | \-\-encoding=<encoding> | \-n]
  36                [\-\-[no\-]scissors] [\-\-quoted\-cr=<action>]
  37                <msg> <patch>
  38 .fi
  39 .SH "DESCRIPTION"
  40 .sp
  41 Reads a single e\-mail message from the standard input, and writes the commit log message in <msg> file, and the patches in <patch> file\&. The author name, e\-mail and e\-mail subject are written out to the standard output to be used by \fIgit am\fR to create a commit\&. It is usually not necessary to use this command directly\&. See \fBgit-am\fR(1) instead\&.
  42 .SH "OPTIONS"
  43 .PP
  44 \-k
  45 .RS 4
  46 Usually the program removes email cruft from the Subject: header line to extract the title line for the commit log message\&. This option prevents this munging, and is most useful when used to read back
  47 \fIgit format\-patch \-k\fR
  48 output\&.
  49 .sp
  50 Specifically, the following are removed until none of them remain:
  51 .sp
  52 .RS 4
  53 .ie n \{\
  54 \h'-04'\(bu\h'+03'\c
  55 .\}
  56 .el \{\
  57 .sp -1
  58 .IP \(bu 2.3
  59 .\}
  60 Leading and trailing whitespace\&.
  61 .RE
  62 .sp
  63 .RS 4
  64 .ie n \{\
  65 \h'-04'\(bu\h'+03'\c
  66 .\}
  67 .el \{\
  68 .sp -1
  69 .IP \(bu 2.3
  70 .\}
  71 Leading
  72 \fBRe:\fR,
  73 \fBre:\fR, and
  74 \fB:\fR\&.
  75 .RE
  76 .sp
  77 .RS 4
  78 .ie n \{\
  79 \h'-04'\(bu\h'+03'\c
  80 .\}
  81 .el \{\
  82 .sp -1
  83 .IP \(bu 2.3
  84 .\}
  85 Leading bracketed strings (between
  86 \fB[\fR
  87 and
  88 \fB]\fR, usually
  89 \fB[PATCH]\fR)\&.
  90 .RE
  91 .sp
  92 Finally, runs of whitespace are normalized to a single ASCII space character\&.
  93 .RE
  94 .PP
  95 \-b
  96 .RS 4
  97 When \-k is not in effect, all leading strings bracketed with
  98 \fI[\fR
  99 and
 100 \fI]\fR
 101 pairs are stripped\&. This option limits the stripping to only the pairs whose bracketed string contains the word "PATCH"\&.
 102 .RE
 103 .PP
 104 \-u
 105 .RS 4
 106 The commit log message, author name and author email are taken from the e\-mail, and after minimally decoding MIME transfer encoding, re\-coded in the charset specified by
 107 \fBi18n\&.commitEncoding\fR
 108 (defaulting to UTF\-8) by transliterating them\&. This used to be optional but now it is the default\&.
 109 .sp
 110 Note that the patch is always used as\-is without charset conversion, even with this flag\&.
 111 .RE
 112 .PP
 113 \-\-encoding=<encoding>
 114 .RS 4
 115 Similar to \-u\&. But when re\-coding, the charset specified here is used instead of the one specified by
 116 \fBi18n\&.commitEncoding\fR
 117 or UTF\-8\&.
 118 .RE
 119 .PP
 120 \-n
 121 .RS 4
 122 Disable all charset re\-coding of the metadata\&.
 123 .RE
 124 .PP
 125 \-m, \-\-message\-id
 126 .RS 4
 127 Copy the Message\-ID header at the end of the commit message\&. This is useful in order to associate commits with mailing list discussions\&.
 128 .RE
 129 .PP
 130 \-\-scissors
 131 .RS 4
 132 Remove everything in body before a scissors line (e\&.g\&. "\-\- >8 \-\-")\&. The line represents scissors and perforation marks, and is used to request the reader to cut the message at that line\&. If that line appears in the body of the message before the patch, everything before it (including the scissors line itself) is ignored when this option is used\&.
 133 .sp
 134 This is useful if you want to begin your message in a discussion thread with comments and suggestions on the message you are responding to, and to conclude it with a patch submission, separating the discussion and the beginning of the proposed commit log message with a scissors line\&.
 135 .sp
 136 This can be enabled by default with the configuration option mailinfo\&.scissors\&.
 137 .RE
 138 .PP
 139 \-\-no\-scissors
 140 .RS 4
 141 Ignore scissors lines\&. Useful for overriding mailinfo\&.scissors settings\&.
 142 .RE
 143 .PP
 144 \-\-quoted\-cr=<action>
 145 .RS 4
 146 Action when processes email messages sent with base64 or quoted\-printable encoding, and the decoded lines end with a CRLF instead of a simple LF\&.
 147 .sp
 148 The valid actions are:
 149 .sp
 150 .RS 4
 151 .ie n \{\
 152 \h'-04'\(bu\h'+03'\c
 153 .\}
 154 .el \{\
 155 .sp -1
 156 .IP \(bu 2.3
 157 .\}
 158 \fBnowarn\fR: Git will do nothing when such a CRLF is found\&.
 159 .RE
 160 .sp
 161 .RS 4
 162 .ie n \{\
 163 \h'-04'\(bu\h'+03'\c
 164 .\}
 165 .el \{\
 166 .sp -1
 167 .IP \(bu 2.3
 168 .\}
 169 \fBwarn\fR: Git will issue a warning for each message if such a CRLF is found\&.
 170 .RE
 171 .sp
 172 .RS 4
 173 .ie n \{\
 174 \h'-04'\(bu\h'+03'\c
 175 .\}
 176 .el \{\
 177 .sp -1
 178 .IP \(bu 2.3
 179 .\}
 180 \fBstrip\fR: Git will convert those CRLF to LF\&.
 181 .RE
 182 .sp
 183 The default action could be set by configuration option
 184 \fBmailinfo\&.quotedCR\fR\&. If no such configuration option has been set,
 185 \fBwarn\fR
 186 will be used\&.
 187 .RE
 188 .PP
 189 <msg>
 190 .RS 4
 191 The commit log message extracted from e\-mail, usually except the title line which comes from e\-mail Subject\&.
 192 .RE
 193 .PP
 194 <patch>
 195 .RS 4
 196 The patch extracted from e\-mail\&.
 197 .RE
 198 .SH "CONFIGURATION"
 199 .sp
 200 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:
 201 .PP
 202 mailinfo\&.scissors
 203 .RS 4
 204 If true, makes
 205 \fBgit-mailinfo\fR(1)
 206 (and therefore
 207 \fBgit-am\fR(1)) act by default as if the \-\-scissors option was provided on the command\-line\&. When active, this feature removes everything from the message body before a scissors line (i\&.e\&. consisting mainly of ">8", "8<" and "\-")\&.
 208 .RE
 209 .SH "GIT"
 210 .sp
 211 Part of the \fBgit\fR(1) suite