Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

260 lines
8.2 KiB

  1. git-send-email(1)
  2. =================
  3. NAME
  4. ----
  5. git-send-email - Send a collection of patches as emails
  7. --------
  8. 'git send-email' [options] <file|directory> [... file|directory]
  10. -----------
  11. Takes the patches given on the command line and emails them out.
  12. The header of the email is configurable by command line options. If not
  13. specified on the command line, the user will be prompted with a ReadLine
  14. enabled interface to provide the necessary information.
  16. -------
  17. The options available are:
  18. --bcc::
  19. Specify a "Bcc:" value for each email.
  20. +
  21. The --bcc option must be repeated for each user you want on the bcc list.
  22. --cc::
  23. Specify a starting "Cc:" value for each email.
  24. +
  25. The --cc option must be repeated for each user you want on the cc list.
  26. --cc-cmd::
  27. Specify a command to execute once per patch file which
  28. should generate patch file specific "Cc:" entries.
  29. Output of this command must be single email address per line.
  30. Default is the value of 'sendemail.cccmd' configuration value.
  31. --chain-reply-to::
  32. --no-chain-reply-to::
  33. If this is set, each email will be sent as a reply to the previous
  34. email sent. If disabled with "--no-chain-reply-to", all emails after
  35. the first will be sent as replies to the first email sent. When using
  36. this, it is recommended that the first file given be an overview of the
  37. entire patch series.
  38. Default is the value of the 'sendemail.chainreplyto' configuration
  39. value; if that is unspecified, default to --chain-reply-to.
  40. --compose::
  41. Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
  42. introductory message for the patch series.
  43. --from::
  44. Specify the sender of the emails. This will default to
  45. the value GIT_COMMITTER_IDENT, as returned by "git var -l".
  46. The user will still be prompted to confirm this entry.
  47. --in-reply-to::
  48. Specify the contents of the first In-Reply-To header.
  49. Subsequent emails will refer to the previous email
  50. instead of this if --chain-reply-to is set (the default)
  51. Only necessary if --compose is also set. If --compose
  52. is not set, this will be prompted for.
  53. --signed-off-by-cc::
  54. --no-signed-off-by-cc::
  55. If this is set, add emails found in Signed-off-by: or Cc: lines to the
  56. cc list.
  57. Default is the value of 'sendemail.signedoffcc' configuration value;
  58. if that is unspecified, default to --signed-off-by-cc.
  59. --quiet::
  60. Make git-send-email less verbose. One line per email should be
  61. all that is output.
  62. --identity::
  63. A configuration identity. When given, causes values in the
  64. 'sendemail.<identity>' subsection to take precedence over
  65. values in the 'sendemail' section. The default identity is
  66. the value of 'sendemail.identity'.
  67. --smtp-server::
  68. If set, specifies the outgoing SMTP server to use (e.g.
  69. `` or a raw IP address). Alternatively it can
  70. specify a full pathname of a sendmail-like program instead;
  71. the program must support the `-i` option. Default value can
  72. be specified by the 'sendemail.smtpserver' configuration
  73. option; the built-in default is `/usr/sbin/sendmail` or
  74. `/usr/lib/sendmail` if such program is available, or
  75. `localhost` otherwise.
  76. --smtp-server-port::
  77. Specifies a port different from the default port (SMTP
  78. servers typically listen to smtp port 25 and ssmtp port
  79. 465).
  80. --smtp-user::
  81. Username for SMTP-AUTH. In place of this option, the following
  82. configuration variables can be specified:
  83. +
  84. --
  85. * sendemail.smtpuser
  86. * sendemail.<identity>.smtpuser (see sendemail.identity).
  87. --
  88. +
  89. However, --smtp-user always overrides these variables.
  90. +
  91. If a username is not specified (with --smtp-user or a
  92. configuration variable), then authentication is not attempted.
  93. --smtp-pass::
  94. Password for SMTP-AUTH. The argument is optional: If no
  95. argument is specified, then the empty string is used as
  96. the password.
  97. +
  98. In place of this option, the following configuration variables
  99. can be specified:
  100. +
  101. --
  102. * sendemail.smtppass
  103. * sendemail.<identity>.smtppass (see sendemail.identity).
  104. --
  105. +
  106. However, --smtp-pass always overrides these variables.
  107. +
  108. Furthermore, passwords need not be specified in configuration files
  109. or on the command line. If a username has been specified (with
  110. --smtp-user or a configuration variable), but no password has been
  111. specified (with --smtp-pass or a configuration variable), then the
  112. user is prompted for a password while the input is masked for privacy.
  113. --smtp-encryption::
  114. Specify the encryption to use, either 'ssl' or 'tls'. Any other
  115. value reverts to plain SMTP. Default is the value of
  116. 'sendemail.smtpencryption'.
  117. --smtp-ssl::
  118. Legacy alias for '--smtp-encryption=ssl'.
  119. --subject::
  120. Specify the initial subject of the email thread.
  121. Only necessary if --compose is also set. If --compose
  122. is not set, this will be prompted for.
  123. --suppress-from::
  124. --no-suppress-from::
  125. If this is set, do not add the From: address to the cc: list.
  126. Default is the value of 'sendemail.suppressfrom' configuration value;
  127. if that is unspecified, default to --no-suppress-from.
  128. --suppress-cc::
  129. Specify an additional category of recipients to suppress the
  130. auto-cc of. 'self' will avoid including the sender, 'author' will
  131. avoid including the patch author, 'cc' will avoid including anyone
  132. mentioned in Cc lines in the patch, 'sob' will avoid including
  133. anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
  134. running the --cc-cmd. 'all' will suppress all auto cc values.
  135. Default is the value of 'sendemail.suppresscc' configuration value;
  136. if that is unspecified, default to 'self' if --suppress-from is
  137. specified, as well as 'sob' if --no-signed-off-cc is specified.
  138. --thread::
  139. --no-thread::
  140. If this is set, the In-Reply-To header will be set on each email sent.
  141. If disabled with "--no-thread", no emails will have the In-Reply-To
  142. header set.
  143. Default is the value of the 'sendemail.thread' configuration value;
  144. if that is unspecified, default to --thread.
  145. --dry-run::
  146. Do everything except actually send the emails.
  147. --envelope-sender::
  148. Specify the envelope sender used to send the emails.
  149. This is useful if your default address is not the address that is
  150. subscribed to a list. If you use the sendmail binary, you must have
  151. suitable privileges for the -f parameter.
  152. Default is the value of the 'sendemail.envelopesender' configuration
  153. variable; if that is unspecified, choosing the envelope sender is left
  154. to your MTA.
  155. --to::
  156. Specify the primary recipient of the emails generated.
  157. Generally, this will be the upstream maintainer of the
  158. project involved.
  159. Default is the value of the '' configuration value;
  160. if that is unspecified, this will be prompted for.
  161. +
  162. The --to option must be repeated for each user you want on the to list.
  164. -------------
  165. sendemail.identity::
  166. The default configuration identity. When specified,
  167. 'sendemail.<identity>.<item>' will have higher precedence than
  168. 'sendemail.<item>'. This is useful to declare multiple SMTP
  169. identities and to hoist sensitive authentication information
  170. out of the repository and into the global configuration file.
  171. sendemail.aliasesfile::
  172. To avoid typing long email addresses, point this to one or more
  173. email aliases files. You must also supply 'sendemail.aliasfiletype'.
  174. sendemail.aliasfiletype::
  175. Format of the file(s) specified in sendemail.aliasesfile. Must be
  176. one of 'mutt', 'mailrc', 'pine', or 'gnus'.
  178. Email address (or alias) to always send to.
  179. sendemail.cccmd::
  180. Command to execute to generate per patch file specific "Cc:"s.
  181. sendemail.bcc::
  182. Email address (or alias) to always bcc.
  183. sendemail.chainreplyto::
  184. Boolean value specifying the default to the '--chain_reply_to'
  185. parameter.
  186. sendemail.smtpserver::
  187. Default SMTP server to use.
  188. sendemail.smtpserverport::
  189. Default SMTP server port to use.
  190. sendemail.smtpuser::
  191. Default SMTP-AUTH username.
  192. sendemail.smtppass::
  193. Default SMTP-AUTH password.
  194. sendemail.smtpencryption::
  195. Default encryption method. Use 'ssl' for SSL (and specify an
  196. appropriate port), or 'tls' for TLS. Takes precedence over
  197. 'smtpssl' if both are specified.
  198. sendemail.smtpssl::
  199. Legacy boolean that sets 'smtpencryption=ssl' if enabled.
  200. Author
  201. ------
  202. Written by Ryan Anderson <>
  203. git-send-email is originally based upon
  204. by Greg Kroah-Hartman.
  205. Documentation
  206. --------------
  207. Documentation by Ryan Anderson
  208. GIT
  209. ---
  210. Part of the linkgit:git[1] suite