]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-send-email(1) |
2 | ================= | |
479cec96 RA |
3 | |
4 | NAME | |
5 | ---- | |
215a7ad1 | 6 | git-send-email - Send a collection of patches as emails |
479cec96 RA |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
215a7ad1 | 11 | 'git-send-email' [options] <file|directory> [... file|directory] |
479cec96 RA |
12 | |
13 | ||
14 | ||
15 | DESCRIPTION | |
16 | ----------- | |
17 | Takes the patches given on the command line and emails them out. | |
18 | ||
19 | The header of the email is configurable by command line options. If not | |
20 | specified on the command line, the user will be prompted with a ReadLine | |
21 | enabled interface to provide the necessary information. | |
22 | ||
df8baa42 JF |
23 | OPTIONS |
24 | ------- | |
479cec96 RA |
25 | The options available are: |
26 | ||
79ee555b EB |
27 | --bcc:: |
28 | Specify a "Bcc:" value for each email. | |
5ef1f8d4 SV |
29 | + |
30 | The --bcc option must be repeated for each user you want on the bcc list. | |
79ee555b | 31 | |
da140f8b RA |
32 | --cc:: |
33 | Specify a starting "Cc:" value for each email. | |
5ef1f8d4 SV |
34 | + |
35 | The --cc option must be repeated for each user you want on the cc list. | |
79ee555b | 36 | |
2718435b RA |
37 | --chain-reply-to, --no-chain-reply-to:: |
38 | If this is set, each email will be sent as a reply to the previous | |
39 | email sent. If disabled with "--no-chain-reply-to", all emails after | |
40 | the first will be sent as replies to the first email sent. When using | |
41 | this, it is recommended that the first file given be an overview of the | |
42 | entire patch series. | |
4a62d3f5 AK |
43 | Default is the value of the 'sendemail.chainreplyto' configuration |
44 | value; if that is unspecified, default to --chain-reply-to. | |
2718435b RA |
45 | |
46 | --compose:: | |
47 | Use $EDITOR to edit an introductory message for the | |
48 | patch series. | |
479cec96 | 49 | |
df8baa42 | 50 | --from:: |
479cec96 RA |
51 | Specify the sender of the emails. This will default to |
52 | the value GIT_COMMITTER_IDENT, as returned by "git-var -l". | |
53 | The user will still be prompted to confirm this entry. | |
54 | ||
df8baa42 | 55 | --in-reply-to:: |
479cec96 | 56 | Specify the contents of the first In-Reply-To header. |
928a5590 | 57 | Subsequent emails will refer to the previous email |
f9e320c3 RA |
58 | instead of this if --chain-reply-to is set (the default) |
59 | Only necessary if --compose is also set. If --compose | |
60 | is not set, this will be prompted for. | |
479cec96 | 61 | |
5483c71d AR |
62 | --signed-off-by-cc, --no-signed-off-by-cc:: |
63 | If this is set, add emails found in Signed-off-by: or Cc: lines to the | |
64 | cc list. | |
65 | Default is the value of 'sendemail.signedoffbycc' configuration value; | |
66 | if that is unspecified, default to --signed-off-by-cc. | |
a985d595 | 67 | |
2718435b RA |
68 | --quiet:: |
69 | Make git-send-email less verbose. One line per email should be | |
70 | all that is output. | |
a6d62cdd | 71 | |
df8baa42 | 72 | --smtp-server:: |
928a5590 JA |
73 | If set, specifies the outgoing SMTP server to use (e.g. |
74 | `smtp.example.com` or a raw IP address). Alternatively it can | |
75 | specify a full pathname of a sendmail-like program instead; | |
6dcfa306 SV |
76 | the program must support the `-i` option. Default value can |
77 | be specified by the 'sendemail.smtpserver' configuration | |
78 | option; the built-in default is `/usr/sbin/sendmail` or | |
79 | `/usr/lib/sendmail` if such program is available, or | |
80 | `localhost` otherwise. | |
a6d62cdd | 81 | |
2718435b | 82 | --subject:: |
a6080a0a | 83 | Specify the initial subject of the email thread. |
2718435b RA |
84 | Only necessary if --compose is also set. If --compose |
85 | is not set, this will be prompted for. | |
86 | ||
5483c71d AR |
87 | --suppress-from, --no-suppress-from:: |
88 | If this is set, do not add the From: address to the cc: list, if it | |
89 | shows up in a From: line. | |
90 | Default is the value of 'sendemail.suppressfrom' configuration value; | |
91 | if that is unspecified, default to --no-supress-from. | |
a985d595 | 92 | |
5483c71d | 93 | --thread, --no-thread:: |
e46f7a0e | 94 | If this is set, the In-Reply-To header will be set on each email sent. |
5483c71d | 95 | If disabled with "--no-thread", no emails will have the In-Reply-To |
e46f7a0e | 96 | header set. |
5483c71d AR |
97 | Default is the value of the 'sendemail.thread' configuration value; |
98 | if that is unspecified, default to --thread. | |
e46f7a0e | 99 | |
03044a98 RJ |
100 | --dry-run:: |
101 | Do everything except actually send the emails. | |
102 | ||
103 | --envelope-sender:: | |
104 | Specify the envelope sender used to send the emails. | |
105 | This is useful if your default address is not the address that is | |
106 | subscribed to a list. If you use the sendmail binary, you must have | |
107 | suitable privileges for the -f parameter. | |
108 | ||
2718435b RA |
109 | --to:: |
110 | Specify the primary recipient of the emails generated. | |
111 | Generally, this will be the upstream maintainer of the | |
112 | project involved. | |
5ef1f8d4 SV |
113 | + |
114 | The --to option must be repeated for each user you want on the to list. | |
79ee555b | 115 | |
a6d62cdd | 116 | |
fc095242 AK |
117 | CONFIGURATION |
118 | ------------- | |
119 | sendemail.aliasesfile:: | |
120 | To avoid typing long email addresses, point this to one or more | |
121 | email aliases files. You must also supply 'sendemail.aliasfiletype'. | |
122 | ||
123 | sendemail.aliasfiletype:: | |
124 | Format of the file(s) specified in sendemail.aliasesfile. Must be | |
125 | one of 'mutt', 'mailrc', 'pine', or 'gnus'. | |
126 | ||
4a62d3f5 AK |
127 | sendemail.bcc:: |
128 | Email address (or alias) to always bcc. | |
129 | ||
130 | sendemail.chainreplyto:: | |
131 | Boolean value specifying the default to the '--chain_reply_to' | |
132 | parameter. | |
133 | ||
fc095242 AK |
134 | sendemail.smtpserver:: |
135 | Default smtp server to use. | |
136 | ||
479cec96 RA |
137 | Author |
138 | ------ | |
139 | Written by Ryan Anderson <ryan@michonline.com> | |
140 | ||
215a7ad1 | 141 | git-send-email is originally based upon |
479cec96 RA |
142 | send_lots_of_email.pl by Greg Kroah-Hartman. |
143 | ||
144 | Documentation | |
145 | -------------- | |
146 | Documentation by Ryan Anderson | |
147 | ||
148 | GIT | |
149 | --- | |
a7154e91 | 150 | Part of the gitlink:git[7] suite |