@matheusbsbs / matheus-bagliano / commits / 454a35b847
Fork 0

Add documentation for git-imap-send.

Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>

Mike McCormack committed Apr 6, 2006 at 12:32 UTC 454a35b847abe22885855fac79bde5c46ba48afe
1 file changed +60
Documentation/git-imap-send.txt new
+60
@@ -0,0 +1,60 @@
1 +git-imap-send(1)
2 +================
3 +
4 +NAME
5 +----
6 +git-imap-send - Dump a mailbox from stdin into an imap folder
7 +
8 +
9 +SYNOPSIS
10 +--------
11 +'git-imap-send'
12 +
13 +
14 +DESCRIPTION
15 +-----------
16 +This command uploads a mailbox generated with git-format-patch
17 +into an imap drafts folder. This allows patches to be sent as
18 +other email is sent with mail clients that cannot read mailbox
19 +files directly.
20 +
21 +Typical usage is something like:
22 +
23 +git-format-patch --signoff --stdout --attach origin | git-imap-send
24 +
25 +
26 +CONFIGURATION
27 +-------------
28 +
29 +git-imap-send requires the following values in the repository
30 +configuration file (shown with examples):
31 +
32 +[imap]
33 + Folder = "INBOX.Drafts"
34 +
35 +[imap]
36 + Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null"
37 +
38 +[imap]
39 + Host = imap.server.com
40 + User = bob
41 + Password = pwd
42 + Port = 143
43 +
44 +
45 +BUGS
46 +----
47 +Doesn't handle lines starting with "From " in the message body.
48 +
49 +
50 +Author
51 +------
52 +Derived from isync 1.0.1 by Mike McCormack.
53 +
54 +Documentation
55 +--------------
56 +Documentation by Mike McCormack
57 +
58 +GIT
59 +---
60 +Part of the gitlink:git[7] suite