Autogenerated HTML docs for v1.2.4-g5a1f
[git.git] / git-applymbox.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-applymbox(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-applymbox(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-applymbox -\r
269    Apply a series of patches in a mailbox\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <p><em>git-applymbox</em> [-u] [-k] [-q] [-m] ( -c .dotest/&lt;num&gt; | &lt;mbox&gt; ) [ &lt;signoff&gt; ]</p>\r
276 </div>\r
277 <h2>DESCRIPTION</h2>\r
278 <div class="sectionbody">\r
279 <p>Splits mail messages in a mailbox into commit log message,\r
280 authorship information and patches, and applies them to the\r
281 current branch.</p>\r
282 </div>\r
283 <h2>OPTIONS</h2>\r
284 <div class="sectionbody">\r
285 <dl>\r
286 <dt>\r
287 -q\r
288 </dt>\r
289 <dd>\r
290 <p>\r
291         Apply patches interactively.  The user will be given\r
292         opportunity to edit the log message and the patch before\r
293         attempting to apply it.\r
294 </p>\r
295 </dd>\r
296 <dt>\r
297 -k\r
298 </dt>\r
299 <dd>\r
300 <p>\r
301         Usually the program <em>cleans up</em> the Subject: header line\r
302         to extract the title line for the commit log message,\r
303         among which (1) remove <em>Re:</em> or <em>re:</em>, (2) leading\r
304         whitespaces, (3) <em>[</em> up to <em>]</em>, typically <em>[PATCH]</em>, and\r
305         then prepends "[PATCH] ".  This flag forbids this\r
306         munging, and is most useful when used to read back <em>git\r
307         format-patch --mbox</em> output.\r
308 </p>\r
309 </dd>\r
310 <dt>\r
311 -m\r
312 </dt>\r
313 <dd>\r
314 <p>\r
315         Patches are applied with <tt>git-apply</tt> command, and unless\r
316         it cleanly applies without fuzz, the processing fails.\r
317         With this flag, if a tree that the patch applies cleanly\r
318         is found in a repository, the patch is applied to the\r
319         tree and then a 3-way merge between the resulting tree\r
320         and the current tree.\r
321 </p>\r
322 </dd>\r
323 <dt>\r
324 -u\r
325 </dt>\r
326 <dd>\r
327 <p>\r
328         By default, the commit log message, author name and\r
329         author email are taken from the e-mail without any\r
330         charset conversion, after minimally decoding MIME\r
331         transfer encoding.  This flag causes the resulting\r
332         commit to be encoded in utf-8 by transliterating them.\r
333         Note that the patch is always used as is without charset\r
334         conversion, even with this flag.\r
335 </p>\r
336 </dd>\r
337 <dt>\r
338 -c .dotest/&lt;num&gt;\r
339 </dt>\r
340 <dd>\r
341 <p>\r
342         When the patch contained in an e-mail does not cleanly\r
343         apply, the command exits with an error message. The\r
344         patch and extracted message are found in .dotest/, and\r
345         you could re-run <em>git applymbox</em> with <em>-c .dotest/&lt;num&gt;</em>\r
346         flag to restart the process after inspecting and fixing\r
347         them.\r
348 </p>\r
349 </dd>\r
350 <dt>\r
351 &lt;mbox&gt;\r
352 </dt>\r
353 <dd>\r
354 <p>\r
355         The name of the file that contains the e-mail messages\r
356         with patches.  This file should be in the UNIX mailbox\r
357         format.  See <em>SubmittingPatches</em> document to learn about\r
358         the formatting convention for e-mail submission.\r
359 </p>\r
360 </dd>\r
361 <dt>\r
362 &lt;signoff&gt;\r
363 </dt>\r
364 <dd>\r
365 <p>\r
366         The name of the file that contains your "Signed-off-by"\r
367         line.  See <em>SubmittingPatches</em> document to learn what\r
368         "Signed-off-by" line means.  You can also just say\r
369         <em>yes</em>, <em>true</em>, <em>me</em>, or <em>please</em> to use an automatically\r
370         generated "Signed-off-by" line based on your committer\r
371         identity.\r
372 </p>\r
373 </dd>\r
374 </dl>\r
375 </div>\r
376 <h2>SEE ALSO</h2>\r
377 <div class="sectionbody">\r
378 <p><a href="git-am.html">git-am(1)</a>, <a href="git-applypatch.html">git-applypatch(1)</a>.</p>\r
379 </div>\r
380 <h2>Author</h2>\r
381 <div class="sectionbody">\r
382 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
383 </div>\r
384 <h2>Documentation</h2>\r
385 <div class="sectionbody">\r
386 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
387 </div>\r
388 <h2>GIT</h2>\r
389 <div class="sectionbody">\r
390 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
391 </div>\r
392 <div id="footer">\r
393 <div id="footer-text">\r
394 Last updated 27-Dec-2005 00:15:46 PDT\r
395 </div>\r
396 </div>\r
397 </body>\r
398 </html>\r