{"thread":{"id":"14384","subject":"[PATCH 4/4] Documentation: Improve documentation for git-imap-send(1).","startedAt":"2008-07-09T21:29:02Z","lastAt":"2008-07-09T21:29:02Z","messageCount":1,"participants":["Robert Shearman"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"82757","messageId":"1215638942-25010-4-git-send-email-robertshearman@gmail.com","threadId":"14384","inReplyTo":null,"subject":"[PATCH 4/4] Documentation: Improve documentation for git-imap-send(1).","fromName":"Robert Shearman","fromEmail":"robertshearman@gmail.com","sentAt":"2008-07-09T21:29:02Z","receivedAt":"2008-07-09T21:29:02Z","isPatch":true,"sender":{"key":"robertshearman@gmail.com","avatar":null},"body":"Change the description to be similar to that used for git-send-email(1) to give a better description of what the tool can be used for and sound more user-friendly.\n\nDocument the configuration variables used by git-imap-send, split the example into tunnel and direct examples. Rephrase other parts of the git-imap-send documentation to use better grammar and to be clearer.\n\nSigned-off-by: Robert Shearman <robertshearman@gmail.com>\n---\n Documentation/git-imap-send.txt |   77 +++++++++++++++++++++++++++++++++------\n 1 files changed, 65 insertions(+), 12 deletions(-)\n\ndiff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt\nindex 136c82b..f9e7288 100644\n--- a/Documentation/git-imap-send.txt\n+++ b/Documentation/git-imap-send.txt\n@@ -3,7 +3,7 @@ git-imap-send(1)\n \n NAME\n ----\n-git-imap-send - Dump a mailbox from stdin into an imap folder\n+git-imap-send - Send a collection of patches from stdin to an IMAP folder\n \n \n SYNOPSIS\n@@ -13,9 +13,9 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-This command uploads a mailbox generated with git-format-patch\n-into an imap drafts folder.  This allows patches to be sent as\n-other email is sent with mail clients that cannot read mailbox\n+This command uploads a mailbox generated with git format-patch\n+into an IMAP drafts folder.  This allows patches to be sent as\n+other email is when using mail clients that cannot read mailbox\n files directly.\n \n Typical usage is something like:\n@@ -26,21 +26,74 @@ git format-patch --signoff --stdout --attach origin | git imap-send\n CONFIGURATION\n -------------\n \n-'git-imap-send' requires the following values in the repository\n-configuration file (shown with examples):\n+To use the tool imap.folder and either imap.tunnel or imap.host must be set\n+to appropriate values.\n+\n+Variables\n+~~~~~~~~~\n+\n+imap.folder::\n+\tThe folder to drop the mails into, which is typically the Drafts\n+\tfolder. For example: \"INBOX.Drafts\", \"INBOX/Drafts\" or\n+\t\"[Gmail]/Drafts\". Required to use imap-send.\n+\n+imap.tunnel::\n+\tCommand used to setup a tunnel to the IMAP server through which\n+\tcommands will be piped instead of using a direct network connection\n+\tto the server. Required when imap.host is not set to use imap-send.\n+\n+imap.host::\n+\tA URL identifying the server. Use a `imap://` prefix for non-secure\n+\tconnections and a `imaps://` prefix for secure connections.\n+\tIgnored when imap.tunnel is set, but required to use imap-send\n+\totherwise.\n+\n+imap.user::\n+\tThe username to use when logging in to the server.\n+\n+imap.password::\n+\tThe password to use when logging in to the server.\n+ \n+imap.port::\n+\tAn integer port number to connect to on the server.\n+\tDefaults to 143 for imap:// hosts and 993 for imaps:// hosts.\n+\tIgnored when imap.tunnel is set.\n+\n+imap.sslverify::\n+\tA boolean to enable/disable verification of the server certificate\n+\tused by the SSL/TLS connection. Default is `true`. Ignored when\n+\timap.tunnel is set.\n+\n+Examples\n+~~~~~~~~\n+\n+Using tunnel mode:\n \n ..........................\n [imap]\n-    Folder = \"INBOX.Drafts\"\n+    folder = \"INBOX.Drafts\"\n+    tunnel = \"ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null\"\n+..........................\n \n+Using direct mode:\n+\n+.........................\n [imap]\n-    Tunnel = \"ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null\"\n+    folder = \"INBOX.Drafts\"\n+    host = imap://imap.example.com\n+    user = bob\n+    pass = p4ssw0rd\n+..........................\n+\n+Using direct mode with SSL:\n \n+.........................\n [imap]\n-    Host = imap://imap.example.com\n-    User = bob\n-    Pass = pwd\n-    Port = 143\n+    folder = \"INBOX.Drafts\"\n+    host = imaps://imap.example.com\n+    user = bob\n+    pass = p4ssw0rd\n+    port = 123\n     sslverify = false\n ..........................\n \n-- \n1.5.6.2.224.g26efb.dirty\n"}]}