summaryrefslogtreecommitdiff
path: root/Documentation/git-imap-send.txt
diff options
context:
space:
mode:
authorMike McCormack <mike@codeweavers.com>2006-04-06 03:32:19 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-04-06 03:48:40 (GMT)
commit454a35b847abe22885855fac79bde5c46ba48afe (patch)
tree266f52ba551196c6d1bff024d7f508cfde3224f3 /Documentation/git-imap-send.txt
parentba3c93743a8151e3663e1fda6b3cb165d8373ddf (diff)
downloadgit-454a35b847abe22885855fac79bde5c46ba48afe.zip
git-454a35b847abe22885855fac79bde5c46ba48afe.tar.gz
git-454a35b847abe22885855fac79bde5c46ba48afe.tar.bz2
Add documentation for git-imap-send.
Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-imap-send.txt')
-rw-r--r--Documentation/git-imap-send.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
new file mode 100644
index 0000000..cfc0d88
--- /dev/null
+++ b/Documentation/git-imap-send.txt
@@ -0,0 +1,60 @@
+git-imap-send(1)
+================
+
+NAME
+----
+git-imap-send - Dump a mailbox from stdin into an imap folder
+
+
+SYNOPSIS
+--------
+'git-imap-send'
+
+
+DESCRIPTION
+-----------
+This command uploads a mailbox generated with git-format-patch
+into an imap drafts folder. This allows patches to be sent as
+other email is sent with mail clients that cannot read mailbox
+files directly.
+
+Typical usage is something like:
+
+git-format-patch --signoff --stdout --attach origin | git-imap-send
+
+
+CONFIGURATION
+-------------
+
+git-imap-send requires the following values in the repository
+configuration file (shown with examples):
+
+[imap]
+ Folder = "INBOX.Drafts"
+
+[imap]
+ Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null"
+
+[imap]
+ Host = imap.server.com
+ User = bob
+ Password = pwd
+ Port = 143
+
+
+BUGS
+----
+Doesn't handle lines starting with "From " in the message body.
+
+
+Author
+------
+Derived from isync 1.0.1 by Mike McCormack.
+
+Documentation
+--------------
+Documentation by Mike McCormack
+
+GIT
+---
+Part of the gitlink:git[7] suite