git-send-email.txt 3.9 KB
Newer Older
J
Junio C Hamano 已提交
1 2
git-send-email(1)
=================
3 4 5

NAME
----
J
Junio C Hamano 已提交
6
git-send-email - Send a collection of patches as emails
7 8 9 10


SYNOPSIS
--------
J
Junio C Hamano 已提交
11
'git-send-email' [options] <file|directory> [... file|directory]
12 13 14 15 16 17 18 19 20 21 22



DESCRIPTION
-----------
Takes the patches given on the command line and emails them out.

The header of the email is configurable by command line options.  If not
specified on the command line, the user will be prompted with a ReadLine
enabled interface to provide the necessary information.

J
Jonas Fonseca 已提交
23 24
OPTIONS
-------
25 26
The options available are:

27 28
--bcc::
	Specify a "Bcc:" value for each email.
29 30
+
The --bcc option must be repeated for each user you want on the bcc list.
31

R
Ryan Anderson 已提交
32 33
--cc::
	Specify a starting "Cc:" value for each email.
34 35
+
The --cc option must be repeated for each user you want on the cc list.
36

37 38 39 40 41 42
--chain-reply-to, --no-chain-reply-to::
	If this is set, each email will be sent as a reply to the previous
	email sent.  If disabled with "--no-chain-reply-to", all emails after
	the first will be sent as replies to the first email sent.  When using
	this, it is recommended that the first file given be an overview of the
	entire patch series.
43 44
	Default is the value of the 'sendemail.chainreplyto' configuration
	value; if that is unspecified, default to --chain-reply-to.
45 46 47 48

--compose::
	Use $EDITOR to edit an introductory message for the
	patch series.
49

J
Jonas Fonseca 已提交
50
--from::
51 52 53 54
	Specify the sender of the emails.  This will default to
	the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
	The user will still be prompted to confirm this entry.

J
Jonas Fonseca 已提交
55
--in-reply-to::
56
	Specify the contents of the first In-Reply-To header.
57
	Subsequent emails will refer to the previous email
58 59 60
	instead of this if --chain-reply-to is set (the default)
	Only necessary if --compose is also set.  If --compose
	is not set, this will be prompted for.
61

62
--no-signed-off-by-cc::
63 64
	Do not add emails found in Signed-off-by: or Cc: lines to the
	cc list.
65

66 67 68
--quiet::
	Make git-send-email less verbose.  One line per email should be
	all that is output.
69

J
Jonas Fonseca 已提交
70
--smtp-server::
71 72 73
	If set, specifies the outgoing SMTP server to use (e.g.
	`smtp.example.com` or a raw IP address).  Alternatively it can
	specify a full pathname of a sendmail-like program instead;
74 75 76 77 78
	the program must support the `-i` option.  Default value can
	be specified by the 'sendemail.smtpserver' configuration
	option; the built-in default is `/usr/sbin/sendmail` or
	`/usr/lib/sendmail` if such program is available, or
	`localhost` otherwise.
79

80 81 82 83 84
--subject::
   	Specify the initial subject of the email thread.
	Only necessary if --compose is also set.  If --compose
	is not set, this will be prompted for.

85 86 87 88
--suppress-from::
	Do not add the From: address to the cc: list, if it shows up in a From:
	line.

89 90 91 92 93 94 95 96 97
--dry-run::
	Do everything except actually send the emails.

--envelope-sender::
	Specify the envelope sender used to send the emails.
	This is useful if your default address is not the address that is
	subscribed to a list. If you use the sendmail binary, you must have
	suitable privileges for the -f parameter.

98 99 100 101
--to::
	Specify the primary recipient of the emails generated.
	Generally, this will be the upstream maintainer of the
	project involved.
102 103
+
The --to option must be repeated for each user you want on the to list.
104

105

106 107 108 109 110 111 112 113 114 115
CONFIGURATION
-------------
sendemail.aliasesfile::
	To avoid typing long email addresses, point this to one or more
	email aliases files.  You must also supply 'sendemail.aliasfiletype'.

sendemail.aliasfiletype::
	Format of the file(s) specified in sendemail.aliasesfile. Must be
	one of 'mutt', 'mailrc', 'pine', or 'gnus'.

116 117 118 119 120 121 122
sendemail.bcc::
	Email address (or alias) to always bcc.

sendemail.chainreplyto::
	Boolean value specifying the default to the '--chain_reply_to'
	parameter.

123 124 125
sendemail.smtpserver::
	Default smtp server to use.

126 127 128 129
Author
------
Written by Ryan Anderson <ryan@michonline.com>

J
Junio C Hamano 已提交
130
git-send-email is originally based upon
131 132 133 134 135 136 137 138
send_lots_of_email.pl by Greg Kroah-Hartman.

Documentation
--------------
Documentation by Ryan Anderson

GIT
---
139
Part of the gitlink:git[7] suite
140