doc/source/en/TortoiseGit/git_doc/git-send-email.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-send-email(1)">\r
   5 <articleinfo>\r
   6     <title>git-send-email(1)</title>\r
   7 <indexterm>\r
   8 <primary>git-send-email(1)</primary>\r
   9 </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-send-email - Send a collection of patches as emails</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git send-email</emphasis> [options] &lt;file|directory|rev-list options&gt;&#8230;</literallayout>\r
  19 </blockquote>\r
  20 </simplesect>\r
  21 <simplesect id="_description">\r
  22 <title>DESCRIPTION</title>\r
  23 <simpara>Takes the patches given on the command line and emails them out.\r
  24 Patches can be specified as files, directories (which will send all\r
  25 files in the directory), or directly as a revision list.  In the\r
  26 last case, any format accepted by <xref linkend="git-format-patch(1)" /> can\r
  27 be passed to git send-email.</simpara>\r
  28 <simpara>The header of the email is configurable by command line options.  If not\r
  29 specified on the command line, the user will be prompted with a ReadLine\r
  30 enabled interface to provide the necessary information.</simpara>\r
  31 <simpara>There are two formats accepted for patch files:</simpara>\r
  32 <orderedlist numeration="arabic">\r
  33 <listitem>\r
  34 <simpara>\r
  35 mbox format files\r
  36 </simpara>\r
  37 <simpara>This is what <xref linkend="git-format-patch(1)" /> generates.  Most headers and MIME\r
  38 formatting are ignored.</simpara>\r
  39 </listitem>\r
  40 <listitem>\r
  41 <simpara>\r
  42 The original format used by Greg Kroah-Hartman's <emphasis>send_lots_of_email.pl</emphasis>\r
  43 script\r
  44 </simpara>\r
  45 <simpara>This format expects the first line of the file to contain the "Cc:" value\r
  46 and the "Subject:" of the message as the second line.</simpara>\r
  47 </listitem>\r
  48 </orderedlist>\r
  49 </simplesect>\r
  50 <simplesect id="_options">\r
  51 <title>OPTIONS</title>\r
  52 <section id="_composing">\r
  53 <title>Composing</title>\r
  54 <variablelist>\r
  55 <varlistentry>\r
  56 <term>\r
  57 --annotate\r
  58 </term>\r
  59 <listitem>\r
  60 <simpara>\r
  61         Review and edit each patch you're about to send. See the\r
  62         CONFIGURATION section for <emphasis>sendemail.multiedit</emphasis>.\r
  63 </simpara>\r
  64 </listitem>\r
  65 </varlistentry>\r
  66 <varlistentry>\r
  67 <term>\r
  68 --bcc=&lt;address&gt;\r
  69 </term>\r
  70 <listitem>\r
  71 <simpara>\r
  72         Specify a "Bcc:" value for each email. Default is the value of\r
  73         <emphasis>sendemail.bcc</emphasis>.\r
  74 </simpara>\r
  75 <simpara>The --bcc option must be repeated for each user you want on the bcc list.</simpara>\r
  76 </listitem>\r
  77 </varlistentry>\r
  78 <varlistentry>\r
  79 <term>\r
  80 --cc=&lt;address&gt;\r
  81 </term>\r
  82 <listitem>\r
  83 <simpara>\r
  84         Specify a starting "Cc:" value for each email.\r
  85         Default is the value of <emphasis>sendemail.cc</emphasis>.\r
  86 </simpara>\r
  87 <simpara>The --cc option must be repeated for each user you want on the cc list.</simpara>\r
  88 </listitem>\r
  89 </varlistentry>\r
  90 <varlistentry>\r
  91 <term>\r
  92 --compose\r
  93 </term>\r
  94 <listitem>\r
  95 <simpara>\r
  96         Invoke a text editor (see GIT_EDITOR in <xref linkend="git-var(1)" />)\r
  97         to edit an introductory message for the patch series.\r
  98 </simpara>\r
  99 <simpara>When <emphasis>--compose</emphasis> is used, git send-email will use the From, Subject, and\r
 100 In-Reply-To headers specified in the message. If the body of the message\r
 101 (what you type after the headers and a blank line) only contains blank\r
 102 (or GIT: prefixed) lines the summary won't be sent, but From, Subject,\r
 103 and In-Reply-To headers will be used unless they are removed.</simpara>\r
 104 <simpara>Missing From or In-Reply-To headers will be prompted for.</simpara>\r
 105 <simpara>See the CONFIGURATION section for <emphasis>sendemail.multiedit</emphasis>.</simpara>\r
 106 </listitem>\r
 107 </varlistentry>\r
 108 <varlistentry>\r
 109 <term>\r
 110 --from=&lt;address&gt;\r
 111 </term>\r
 112 <listitem>\r
 113 <simpara>\r
 114         Specify the sender of the emails.  If not specified on the command line,\r
 115         the value of the <emphasis>sendemail.from</emphasis> configuration option is used.  If\r
 116         neither the command line option nor <emphasis>sendemail.from</emphasis> are set, then the\r
 117         user will be prompted for the value.  The default for the prompt will be\r
 118         the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not\r
 119         set, as returned by "git var -l".\r
 120 </simpara>\r
 121 </listitem>\r
 122 </varlistentry>\r
 123 <varlistentry>\r
 124 <term>\r
 125 --in-reply-to=&lt;identifier&gt;\r
 126 </term>\r
 127 <listitem>\r
 128 <simpara>\r
 129         Make the first mail (or all the mails with <emphasis>--no-thread</emphasis>) appear as a\r
 130         reply to the given Message-Id, which avoids breaking threads to\r
 131         provide a new patch series.\r
 132         The second and subsequent emails will be sent as replies according to\r
 133         the <emphasis>--[no]-chain-reply-to</emphasis> setting.\r
 134 </simpara>\r
 135 <simpara>So for example when <emphasis>--thread</emphasis> and <emphasis>--no-chain-reply-to</emphasis> are specified, the\r
 136 second and subsequent patches will be replies to the first one like in the\r
 137 illustration below where <emphasis>[PATCH v2 0/3]</emphasis> is in reply to <emphasis>[PATCH 0/2]</emphasis>:</simpara>\r
 138 <literallayout class="monospaced">[PATCH 0/2] Here is what I did...\r
 139   [PATCH 1/2] Clean up and tests\r
 140   [PATCH 2/2] Implementation\r
 141   [PATCH v2 0/3] Here is a reroll\r
 142     [PATCH v2 1/3] Clean up\r
 143     [PATCH v2 2/3] New tests\r
 144     [PATCH v2 3/3] Implementation</literallayout>\r
 145 <simpara>Only necessary if --compose is also set.  If --compose\r
 146 is not set, this will be prompted for.</simpara>\r
 147 </listitem>\r
 148 </varlistentry>\r
 149 <varlistentry>\r
 150 <term>\r
 151 --subject=&lt;string&gt;\r
 152 </term>\r
 153 <listitem>\r
 154 <simpara>\r
 155         Specify the initial subject of the email thread.\r
 156         Only necessary if --compose is also set.  If --compose\r
 157         is not set, this will be prompted for.\r
 158 </simpara>\r
 159 </listitem>\r
 160 </varlistentry>\r
 161 <varlistentry>\r
 162 <term>\r
 163 --to=&lt;address&gt;\r
 164 </term>\r
 165 <listitem>\r
 166 <simpara>\r
 167         Specify the primary recipient of the emails generated. Generally, this\r
 168         will be the upstream maintainer of the project involved. Default is the\r
 169         value of the <emphasis>sendemail.to</emphasis> configuration value; if that is unspecified,\r
 170         and --to-cmd is not specified, this will be prompted for.\r
 171 </simpara>\r
 172 <simpara>The --to option must be repeated for each user you want on the to list.</simpara>\r
 173 </listitem>\r
 174 </varlistentry>\r
 175 <varlistentry>\r
 176 <term>\r
 177 --8bit-encoding=&lt;encoding&gt;\r
 178 </term>\r
 179 <listitem>\r
 180 <simpara>\r
 181         When encountering a non-ASCII message or subject that does not\r
 182         declare its encoding, add headers/quoting to indicate it is\r
 183         encoded in &lt;encoding&gt;.  Default is the value of the\r
 184         <emphasis>sendemail.assume8bitEncoding</emphasis>; if that is unspecified, this\r
 185         will be prompted for if any non-ASCII files are encountered.\r
 186 </simpara>\r
 187 <simpara>Note that no attempts whatsoever are made to validate the encoding.</simpara>\r
 188 </listitem>\r
 189 </varlistentry>\r
 190 </variablelist>\r
 191 </section>\r
 192 <section id="_sending">\r
 193 <title>Sending</title>\r
 194 <variablelist>\r
 195 <varlistentry>\r
 196 <term>\r
 197 --envelope-sender=&lt;address&gt;\r
 198 </term>\r
 199 <listitem>\r
 200 <simpara>\r
 201         Specify the envelope sender used to send the emails.\r
 202         This is useful if your default address is not the address that is\r
 203         subscribed to a list. In order to use the <emphasis>From</emphasis> address, set the\r
 204         value to "auto". If you use the sendmail binary, you must have\r
 205         suitable privileges for the -f parameter.  Default is the value of the\r
 206         <emphasis>sendemail.envelopesender</emphasis> configuration variable; if that is\r
 207         unspecified, choosing the envelope sender is left to your MTA.\r
 208 </simpara>\r
 209 </listitem>\r
 210 </varlistentry>\r
 211 <varlistentry>\r
 212 <term>\r
 213 --smtp-encryption=&lt;encryption&gt;\r
 214 </term>\r
 215 <listitem>\r
 216 <simpara>\r
 217         Specify the encryption to use, either <emphasis>ssl</emphasis> or <emphasis>tls</emphasis>.  Any other\r
 218         value reverts to plain SMTP.  Default is the value of\r
 219         <emphasis>sendemail.smtpencryption</emphasis>.\r
 220 </simpara>\r
 221 </listitem>\r
 222 </varlistentry>\r
 223 <varlistentry>\r
 224 <term>\r
 225 --smtp-domain=&lt;FQDN&gt;\r
 226 </term>\r
 227 <listitem>\r
 228 <simpara>\r
 229         Specifies the Fully Qualified Domain Name (FQDN) used in the\r
 230         HELO/EHLO command to the SMTP server.  Some servers require the\r
 231         FQDN to match your IP address.  If not set, git send-email attempts\r
 232         to determine your FQDN automatically.  Default is the value of\r
 233         <emphasis>sendemail.smtpdomain</emphasis>.\r
 234 </simpara>\r
 235 </listitem>\r
 236 </varlistentry>\r
 237 <varlistentry>\r
 238 <term>\r
 239 --smtp-pass[=&lt;password&gt;]\r
 240 </term>\r
 241 <listitem>\r
 242 <simpara>\r
 243         Password for SMTP-AUTH. The argument is optional: If no\r
 244         argument is specified, then the empty string is used as\r
 245         the password. Default is the value of <emphasis>sendemail.smtppass</emphasis>,\r
 246         however <emphasis>--smtp-pass</emphasis> always overrides this value.\r
 247 </simpara>\r
 248 <simpara>Furthermore, passwords need not be specified in configuration files\r
 249 or on the command line. If a username has been specified (with\r
 250 <emphasis>--smtp-user</emphasis> or a <emphasis>sendemail.smtpuser</emphasis>), but no password has been\r
 251 specified (with <emphasis>--smtp-pass</emphasis> or <emphasis>sendemail.smtppass</emphasis>), then the\r
 252 user is prompted for a password while the input is masked for privacy.</simpara>\r
 253 </listitem>\r
 254 </varlistentry>\r
 255 <varlistentry>\r
 256 <term>\r
 257 --smtp-server=&lt;host&gt;\r
 258 </term>\r
 259 <listitem>\r
 260 <simpara>\r
 261         If set, specifies the outgoing SMTP server to use (e.g.\r
 262         <emphasis>smtp.example.com</emphasis> or a raw IP address).  Alternatively it can\r
 263         specify a full pathname of a sendmail-like program instead;\r
 264         the program must support the <emphasis>-i</emphasis> option.  Default value can\r
 265         be specified by the <emphasis>sendemail.smtpserver</emphasis> configuration\r
 266         option; the built-in default is <emphasis>/usr/sbin/sendmail</emphasis> or\r
 267         <emphasis>/usr/lib/sendmail</emphasis> if such program is available, or\r
 268         <emphasis>localhost</emphasis> otherwise.\r
 269 </simpara>\r
 270 </listitem>\r
 271 </varlistentry>\r
 272 <varlistentry>\r
 273 <term>\r
 274 --smtp-server-port=&lt;port&gt;\r
 275 </term>\r
 276 <listitem>\r
 277 <simpara>\r
 278         Specifies a port different from the default port (SMTP\r
 279         servers typically listen to smtp port 25, but may also listen to\r
 280         submission port 587, or the common SSL smtp port 465);\r
 281         symbolic port names (e.g. "submission" instead of 587)\r
 282         are also accepted. The port can also be set with the\r
 283         <emphasis>sendemail.smtpserverport</emphasis> configuration variable.\r
 284 </simpara>\r
 285 </listitem>\r
 286 </varlistentry>\r
 287 <varlistentry>\r
 288 <term>\r
 289 --smtp-server-option=&lt;option&gt;\r
 290 </term>\r
 291 <listitem>\r
 292 <simpara>\r
 293         If set, specifies the outgoing SMTP server option to use.\r
 294         Default value can be specified by the <emphasis>sendemail.smtpserveroption</emphasis>\r
 295         configuration option.\r
 296 </simpara>\r
 297 <simpara>The --smtp-server-option option must be repeated for each option you want\r
 298 to pass to the server. Likewise, different lines in the configuration files\r
 299 must be used for each option.</simpara>\r
 300 </listitem>\r
 301 </varlistentry>\r
 302 <varlistentry>\r
 303 <term>\r
 304 --smtp-ssl\r
 305 </term>\r
 306 <listitem>\r
 307 <simpara>\r
 308         Legacy alias for <emphasis>--smtp-encryption ssl</emphasis>.\r
 309 </simpara>\r
 310 </listitem>\r
 311 </varlistentry>\r
 312 <varlistentry>\r
 313 <term>\r
 314 --smtp-user=&lt;user&gt;\r
 315 </term>\r
 316 <listitem>\r
 317 <simpara>\r
 318         Username for SMTP-AUTH. Default is the value of <emphasis>sendemail.smtpuser</emphasis>;\r
 319         if a username is not specified (with <emphasis>--smtp-user</emphasis> or <emphasis>sendemail.smtpuser</emphasis>),\r
 320         then authentication is not attempted.\r
 321 </simpara>\r
 322 </listitem>\r
 323 </varlistentry>\r
 324 <varlistentry>\r
 325 <term>\r
 326 --smtp-debug=0|1\r
 327 </term>\r
 328 <listitem>\r
 329 <simpara>\r
 330         Enable (1) or disable (0) debug output. If enabled, SMTP\r
 331         commands and replies will be printed. Useful to debug TLS\r
 332         connection and authentication problems.\r
 333 </simpara>\r
 334 </listitem>\r
 335 </varlistentry>\r
 336 </variablelist>\r
 337 </section>\r
 338 <section id="_automating">\r
 339 <title>Automating</title>\r
 340 <variablelist>\r
 341 <varlistentry>\r
 342 <term>\r
 343 --to-cmd=&lt;command&gt;\r
 344 </term>\r
 345 <listitem>\r
 346 <simpara>\r
 347         Specify a command to execute once per patch file which\r
 348         should generate patch file specific "To:" entries.\r
 349         Output of this command must be single email address per line.\r
 350         Default is the value of <emphasis>sendemail.tocmd</emphasis> configuration value.\r
 351 </simpara>\r
 352 </listitem>\r
 353 </varlistentry>\r
 354 <varlistentry>\r
 355 <term>\r
 356 --cc-cmd=&lt;command&gt;\r
 357 </term>\r
 358 <listitem>\r
 359 <simpara>\r
 360         Specify a command to execute once per patch file which\r
 361         should generate patch file specific "Cc:" entries.\r
 362         Output of this command must be single email address per line.\r
 363         Default is the value of <emphasis>sendemail.cccmd</emphasis> configuration value.\r
 364 </simpara>\r
 365 </listitem>\r
 366 </varlistentry>\r
 367 <varlistentry>\r
 368 <term>\r
 369 --[no-]chain-reply-to\r
 370 </term>\r
 371 <listitem>\r
 372 <simpara>\r
 373         If this is set, each email will be sent as a reply to the previous\r
 374         email sent.  If disabled with "--no-chain-reply-to", all emails after\r
 375         the first will be sent as replies to the first email sent.  When using\r
 376         this, it is recommended that the first file given be an overview of the\r
 377         entire patch series. Disabled by default, but the <emphasis>sendemail.chainreplyto</emphasis>\r
 378         configuration variable can be used to enable it.\r
 379 </simpara>\r
 380 </listitem>\r
 381 </varlistentry>\r
 382 <varlistentry>\r
 383 <term>\r
 384 --identity=&lt;identity&gt;\r
 385 </term>\r
 386 <listitem>\r
 387 <simpara>\r
 388         A configuration identity. When given, causes values in the\r
 389         <emphasis>sendemail.&lt;identity&gt;</emphasis> subsection to take precedence over\r
 390         values in the <emphasis>sendemail</emphasis> section. The default identity is\r
 391         the value of <emphasis>sendemail.identity</emphasis>.\r
 392 </simpara>\r
 393 </listitem>\r
 394 </varlistentry>\r
 395 <varlistentry>\r
 396 <term>\r
 397 --[no-]signed-off-by-cc\r
 398 </term>\r
 399 <listitem>\r
 400 <simpara>\r
 401         If this is set, add emails found in Signed-off-by: or Cc: lines to the\r
 402         cc list. Default is the value of <emphasis>sendemail.signedoffbycc</emphasis> configuration\r
 403         value; if that is unspecified, default to --signed-off-by-cc.\r
 404 </simpara>\r
 405 </listitem>\r
 406 </varlistentry>\r
 407 <varlistentry>\r
 408 <term>\r
 409 --suppress-cc=&lt;category&gt;\r
 410 </term>\r
 411 <listitem>\r
 412 <simpara>\r
 413         Specify an additional category of recipients to suppress the\r
 414         auto-cc of:\r
 415 </simpara>\r
 416 <itemizedlist>\r
 417 <listitem>\r
 418 <simpara>\r
 419 <emphasis>author</emphasis> will avoid including the patch author\r
 420 </simpara>\r
 421 </listitem>\r
 422 <listitem>\r
 423 <simpara>\r
 424 <emphasis>self</emphasis> will avoid including the sender\r
 425 </simpara>\r
 426 </listitem>\r
 427 <listitem>\r
 428 <simpara>\r
 429 <emphasis>cc</emphasis> will avoid including anyone mentioned in Cc lines in the patch header\r
 430   except for self (use <emphasis>self</emphasis> for that).\r
 431 </simpara>\r
 432 </listitem>\r
 433 <listitem>\r
 434 <simpara>\r
 435 <emphasis>bodycc</emphasis> will avoid including anyone mentioned in Cc lines in the\r
 436   patch body (commit message) except for self (use <emphasis>self</emphasis> for that).\r
 437 </simpara>\r
 438 </listitem>\r
 439 <listitem>\r
 440 <simpara>\r
 441 <emphasis>sob</emphasis> will avoid including anyone mentioned in Signed-off-by lines except\r
 442    for self (use <emphasis>self</emphasis> for that).\r
 443 </simpara>\r
 444 </listitem>\r
 445 <listitem>\r
 446 <simpara>\r
 447 <emphasis>cccmd</emphasis> will avoid running the --cc-cmd.\r
 448 </simpara>\r
 449 </listitem>\r
 450 <listitem>\r
 451 <simpara>\r
 452 <emphasis>body</emphasis> is equivalent to <emphasis>sob</emphasis> + <emphasis>bodycc</emphasis>\r
 453 </simpara>\r
 454 </listitem>\r
 455 <listitem>\r
 456 <simpara>\r
 457 <emphasis>all</emphasis> will suppress all auto cc values.\r
 458 </simpara>\r
 459 </listitem>\r
 460 </itemizedlist>\r
 461 <simpara>Default is the value of <emphasis>sendemail.suppresscc</emphasis> configuration value; if\r
 462 that is unspecified, default to <emphasis>self</emphasis> if --suppress-from is\r
 463 specified, as well as <emphasis>body</emphasis> if --no-signed-off-cc is specified.</simpara>\r
 464 </listitem>\r
 465 </varlistentry>\r
 466 <varlistentry>\r
 467 <term>\r
 468 --[no-]suppress-from\r
 469 </term>\r
 470 <listitem>\r
 471 <simpara>\r
 472         If this is set, do not add the From: address to the cc: list.\r
 473         Default is the value of <emphasis>sendemail.suppressfrom</emphasis> configuration\r
 474         value; if that is unspecified, default to --no-suppress-from.\r
 475 </simpara>\r
 476 </listitem>\r
 477 </varlistentry>\r
 478 <varlistentry>\r
 479 <term>\r
 480 --[no-]thread\r
 481 </term>\r
 482 <listitem>\r
 483 <simpara>\r
 484         If this is set, the In-Reply-To and References headers will be\r
 485         added to each email sent.  Whether each mail refers to the\r
 486         previous email (<emphasis>deep</emphasis> threading per <emphasis>git format-patch</emphasis>\r
 487         wording) or to the first email (<emphasis>shallow</emphasis> threading) is\r
 488         governed by "--[no-]chain-reply-to".\r
 489 </simpara>\r
 490 <simpara>If disabled with "--no-thread", those headers will not be added\r
 491 (unless specified with --in-reply-to).  Default is the value of the\r
 492 <emphasis>sendemail.thread</emphasis> configuration value; if that is unspecified,\r
 493 default to --thread.</simpara>\r
 494 <simpara>It is up to the user to ensure that no In-Reply-To header already\r
 495 exists when <emphasis>git send-email</emphasis> is asked to add it (especially note that\r
 496 <emphasis>git format-patch</emphasis> can be configured to do the threading itself).\r
 497 Failure to do so may not produce the expected result in the\r
 498 recipient's MUA.</simpara>\r
 499 </listitem>\r
 500 </varlistentry>\r
 501 </variablelist>\r
 502 </section>\r
 503 <section id="_administering">\r
 504 <title>Administering</title>\r
 505 <variablelist>\r
 506 <varlistentry>\r
 507 <term>\r
 508 --confirm=&lt;mode&gt;\r
 509 </term>\r
 510 <listitem>\r
 511 <simpara>\r
 512         Confirm just before sending:\r
 513 </simpara>\r
 514 <itemizedlist>\r
 515 <listitem>\r
 516 <simpara>\r
 517 <emphasis>always</emphasis> will always confirm before sending\r
 518 </simpara>\r
 519 </listitem>\r
 520 <listitem>\r
 521 <simpara>\r
 522 <emphasis>never</emphasis> will never confirm before sending\r
 523 </simpara>\r
 524 </listitem>\r
 525 <listitem>\r
 526 <simpara>\r
 527 <emphasis>cc</emphasis> will confirm before sending when send-email has automatically\r
 528   added addresses from the patch to the Cc list\r
 529 </simpara>\r
 530 </listitem>\r
 531 <listitem>\r
 532 <simpara>\r
 533 <emphasis>compose</emphasis> will confirm before sending the first message when using --compose.\r
 534 </simpara>\r
 535 </listitem>\r
 536 <listitem>\r
 537 <simpara>\r
 538 <emphasis>auto</emphasis> is equivalent to <emphasis>cc</emphasis> + <emphasis>compose</emphasis>\r
 539 </simpara>\r
 540 </listitem>\r
 541 </itemizedlist>\r
 542 <simpara>Default is the value of <emphasis>sendemail.confirm</emphasis> configuration value; if that\r
 543 is unspecified, default to <emphasis>auto</emphasis> unless any of the suppress options\r
 544 have been specified, in which case default to <emphasis>compose</emphasis>.</simpara>\r
 545 </listitem>\r
 546 </varlistentry>\r
 547 <varlistentry>\r
 548 <term>\r
 549 --dry-run\r
 550 </term>\r
 551 <listitem>\r
 552 <simpara>\r
 553         Do everything except actually send the emails.\r
 554 </simpara>\r
 555 </listitem>\r
 556 </varlistentry>\r
 557 <varlistentry>\r
 558 <term>\r
 559 --[no-]format-patch\r
 560 </term>\r
 561 <listitem>\r
 562 <simpara>\r
 563         When an argument may be understood either as a reference or as a file name,\r
 564         choose to understand it as a format-patch argument (<emphasis>--format-patch</emphasis>)\r
 565         or as a file name (<emphasis>--no-format-patch</emphasis>). By default, when such a conflict\r
 566         occurs, git send-email will fail.\r
 567 </simpara>\r
 568 </listitem>\r
 569 </varlistentry>\r
 570 <varlistentry>\r
 571 <term>\r
 572 --quiet\r
 573 </term>\r
 574 <listitem>\r
 575 <simpara>\r
 576         Make git-send-email less verbose.  One line per email should be\r
 577         all that is output.\r
 578 </simpara>\r
 579 </listitem>\r
 580 </varlistentry>\r
 581 <varlistentry>\r
 582 <term>\r
 583 --[no-]validate\r
 584 </term>\r
 585 <listitem>\r
 586 <simpara>\r
 587         Perform sanity checks on patches.\r
 588         Currently, validation means the following:\r
 589 </simpara>\r
 590 <itemizedlist>\r
 591 <listitem>\r
 592 <simpara>\r
 593 Warn of patches that contain lines longer than 998 characters; this\r
 594                         is due to SMTP limits as described by <ulink url="http://www.ietf.org/rfc/rfc2821.txt">http://www.ietf.org/rfc/rfc2821.txt</ulink>.\r
 595 </simpara>\r
 596 </listitem>\r
 597 </itemizedlist>\r
 598 <simpara>Default is the value of <emphasis>sendemail.validate</emphasis>; if this is not set,\r
 599 default to <emphasis>--validate</emphasis>.</simpara>\r
 600 </listitem>\r
 601 </varlistentry>\r
 602 <varlistentry>\r
 603 <term>\r
 604 --force\r
 605 </term>\r
 606 <listitem>\r
 607 <simpara>\r
 608         Send emails even if safety checks would prevent it.\r
 609 </simpara>\r
 610 </listitem>\r
 611 </varlistentry>\r
 612 </variablelist>\r
 613 </section>\r
 614 </simplesect>\r
 615 <simplesect id="_configuration">\r
 616 <title>CONFIGURATION</title>\r
 617 <variablelist>\r
 618 <varlistentry>\r
 619 <term>\r
 620 sendemail.aliasesfile\r
 621 </term>\r
 622 <listitem>\r
 623 <simpara>\r
 624         To avoid typing long email addresses, point this to one or more\r
 625         email aliases files.  You must also supply <emphasis>sendemail.aliasfiletype</emphasis>.\r
 626 </simpara>\r
 627 </listitem>\r
 628 </varlistentry>\r
 629 <varlistentry>\r
 630 <term>\r
 631 sendemail.aliasfiletype\r
 632 </term>\r
 633 <listitem>\r
 634 <simpara>\r
 635         Format of the file(s) specified in sendemail.aliasesfile. Must be\r
 636         one of <emphasis>mutt</emphasis>, <emphasis>mailrc</emphasis>, <emphasis>pine</emphasis>, <emphasis>elm</emphasis>, or <emphasis>gnus</emphasis>.\r
 637 </simpara>\r
 638 </listitem>\r
 639 </varlistentry>\r
 640 <varlistentry>\r
 641 <term>\r
 642 sendemail.multiedit\r
 643 </term>\r
 644 <listitem>\r
 645 <simpara>\r
 646         If true (default), a single editor instance will be spawned to edit\r
 647         files you have to edit (patches when <emphasis>--annotate</emphasis> is used, and the\r
 648         summary when <emphasis>--compose</emphasis> is used). If false, files will be edited one\r
 649         after the other, spawning a new editor each time.\r
 650 </simpara>\r
 651 </listitem>\r
 652 </varlistentry>\r
 653 <varlistentry>\r
 654 <term>\r
 655 sendemail.confirm\r
 656 </term>\r
 657 <listitem>\r
 658 <simpara>\r
 659         Sets the default for whether to confirm before sending. Must be\r
 660         one of <emphasis>always</emphasis>, <emphasis>never</emphasis>, <emphasis>cc</emphasis>, <emphasis>compose</emphasis>, or <emphasis>auto</emphasis>. See <emphasis>--confirm</emphasis>\r
 661         in the previous section for the meaning of these values.\r
 662 </simpara>\r
 663 </listitem>\r
 664 </varlistentry>\r
 665 </variablelist>\r
 666 </simplesect>\r
 667 <simplesect id="_example">\r
 668 <title>EXAMPLE</title>\r
 669 <section id="_use_gmail_as_the_smtp_server">\r
 670 <title>Use gmail as the smtp server</title>\r
 671 <simpara>To use <emphasis>git send-email</emphasis> to send your patches through the GMail SMTP server,\r
 672 edit ~/.gitconfig to specify your account settings:</simpara>\r
 673 <literallayout class="monospaced">[sendemail]\r
 674         smtpencryption = tls\r
 675         smtpserver = smtp.gmail.com\r
 676         smtpuser = yourname@gmail.com\r
 677         smtpserverport = 587</literallayout>\r
 678 <simpara>Once your commits are ready to be sent to the mailing list, run the\r
 679 following commands:</simpara>\r
 680 <literallayout class="monospaced">$ git format-patch --cover-letter -M origin/master -o outgoing/\r
 681 $ edit outgoing/0000-*\r
 682 $ git send-email outgoing/*</literallayout>\r
 683 <simpara>Note: the following perl modules are required\r
 684       Net::SMTP::SSL, MIME::Base64 and Authen::SASL</simpara>\r
 685 </section>\r
 686 </simplesect>\r
 687 <simplesect id="_see_also">\r
 688 <title>SEE ALSO</title>\r
 689 <simpara><xref linkend="git-format-patch(1)" />, <xref linkend="git-imap-send(1)" />, mbox(5)</simpara>\r
 690 </simplesect>\r
 691 <simplesect id="_git">\r
 692 <title>GIT</title>\r
 693 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 694 </simplesect>\r
 695 </article>\r