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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 04/25/2023
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.40.1.423.g2807bd2c10
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-MAILINFO" "1" "04/25/2023" "Git 2\&.40\&.1\&.423\&.g2807bd" "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 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 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\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-k
  46 .RS 4
  47 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
  48 \fIgit format\-patch \-k\fR
  49 output\&.
  50 .sp
  51 Specifically, the following are removed until none of them remain:
  52 .sp
  53 .RS 4
  54 .ie n \{\
  55 \h'-04'\(bu\h'+03'\c
  56 .\}
  57 .el \{\
  58 .sp -1
  59 .IP \(bu 2.3
  60 .\}
  61 Leading and trailing whitespace\&.
  62 .RE
  63 .sp
  64 .RS 4
  65 .ie n \{\
  66 \h'-04'\(bu\h'+03'\c
  67 .\}
  68 .el \{\
  69 .sp -1
  70 .IP \(bu 2.3
  71 .\}
  72 Leading
  73 \fBRe:\fR,
  74 \fBre:\fR, and
  75 \fB:\fR\&.
  76 .RE
  77 .sp
  78 .RS 4
  79 .ie n \{\
  80 \h'-04'\(bu\h'+03'\c
  81 .\}
  82 .el \{\
  83 .sp -1
  84 .IP \(bu 2.3
  85 .\}
  86 Leading bracketed strings (between
  87 \fB[\fR
  88 and
  89 \fB]\fR, usually
  90 \fB[PATCH]\fR)\&.
  91 .RE
  92 .sp
  93 Finally, runs of whitespace are normalized to a single ASCII space character\&.
  94 .RE
  95 .PP
  96 \-b
  97 .RS 4
  98 When \-k is not in effect, all leading strings bracketed with
  99 \fI[\fR
 100 and
 101 \fI]\fR
 102 pairs are stripped\&. This option limits the stripping to only the pairs whose bracketed string contains the word "PATCH"\&.
 103 .RE
 104 .PP
 105 \-u
 106 .RS 4
 107 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
 108 \fBi18n\&.commitEncoding\fR
 109 (defaulting to UTF\-8) by transliterating them\&. This used to be optional but now it is the default\&.
 110 .sp
 111 Note that the patch is always used as\-is without charset conversion, even with this flag\&.
 112 .RE
 113 .PP
 114 \-\-encoding=<encoding>
 115 .RS 4
 116 Similar to \-u\&. But when re\-coding, the charset specified here is used instead of the one specified by
 117 \fBi18n\&.commitEncoding\fR
 118 or UTF\-8\&.
 119 .RE
 120 .PP
 121 \-n
 122 .RS 4
 123 Disable all charset re\-coding of the metadata\&.
 124 .RE
 125 .PP
 126 \-m, \-\-message\-id
 127 .RS 4
 128 Copy the Message\-ID header at the end of the commit message\&. This is useful in order to associate commits with mailing list discussions\&.
 129 .RE
 130 .PP
 131 \-\-scissors
 132 .RS 4
 133 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\&.
 134 .sp
 135 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\&.
 136 .sp
 137 This can be enabled by default with the configuration option mailinfo\&.scissors\&.
 138 .RE
 139 .PP
 140 \-\-no\-scissors
 141 .RS 4
 142 Ignore scissors lines\&. Useful for overriding mailinfo\&.scissors settings\&.
 143 .RE
 144 .PP
 145 \-\-quoted\-cr=<action>
 146 .RS 4
 147 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\&.
 148 .sp
 149 The valid actions are:
 150 .sp
 151 .RS 4
 152 .ie n \{\
 153 \h'-04'\(bu\h'+03'\c
 154 .\}
 155 .el \{\
 156 .sp -1
 157 .IP \(bu 2.3
 158 .\}
 159 \fBnowarn\fR: Git will do nothing when such a CRLF is found\&.
 160 .RE
 161 .sp
 162 .RS 4
 163 .ie n \{\
 164 \h'-04'\(bu\h'+03'\c
 165 .\}
 166 .el \{\
 167 .sp -1
 168 .IP \(bu 2.3
 169 .\}
 170 \fBwarn\fR: Git will issue a warning for each message if such a CRLF is found\&.
 171 .RE
 172 .sp
 173 .RS 4
 174 .ie n \{\
 175 \h'-04'\(bu\h'+03'\c
 176 .\}
 177 .el \{\
 178 .sp -1
 179 .IP \(bu 2.3
 180 .\}
 181 \fBstrip\fR: Git will convert those CRLF to LF\&.
 182 .RE
 183 .sp
 184 The default action could be set by configuration option
 185 \fBmailinfo\&.quotedCR\fR\&. If no such configuration option has been set,
 186 \fBwarn\fR
 187 will be used\&.
 188 .RE
 189 .PP
 190 <msg>
 191 .RS 4
 192 The commit log message extracted from e\-mail, usually except the title line which comes from e\-mail Subject\&.
 193 .RE
 194 .PP
 195 <patch>
 196 .RS 4
 197 The patch extracted from e\-mail\&.
 198 .RE
 199 .SH "CONFIGURATION"
 200 .sp
 201 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:
 202 .PP
 203 mailinfo\&.scissors
 204 .RS 4
 205 If true, makes
 206 \fBgit-mailinfo\fR(1)
 207 (and therefore
 208 \fBgit-am\fR(1)) act by default as if the \-\-scissors option was provided on the command\-line\&. When active, this features removes everything from the message body before a scissors line (i\&.e\&. consisting mainly of ">8", "8<" and "\-")\&.
 209 .RE
 210 .SH "GIT"
 211 .sp
 212 Part of the \fBgit\fR(1) suite