mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-19 15:34:51 +01:00
Code Activity
git/Documentation/git-imap-send.txt

117 lines
2.5 KiB
Text
Raw Normal View History

Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
git-imap-send(1)
================
NAME
----
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
git-imap-send - Send a collection of patches from stdin to an IMAP folder
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
SYNOPSIS
--------
Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-30 08:09:04 +02:00
'git imap-send'
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
DESCRIPTION
-----------
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
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 when using mail clients that cannot read mailbox
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
files directly.
Typical usage is something like:
Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-30 08:09:04 +02:00
git format-patch --signoff --stdout --attach origin | git imap-send
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
CONFIGURATION
-------------
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
To use the tool, imap.folder and either imap.tunnel or imap.host must be set
to appropriate values.
Variables
~~~~~~~~~
imap.folder::
The folder to drop the mails into, which is typically the Drafts
folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
"[Gmail]/Drafts". Required to use imap-send.
imap.tunnel::
Command used to setup a tunnel to the IMAP server through which
commands will be piped instead of using a direct network connection
to the server. Required when imap.host is not set to use imap-send.
imap.host::
A URL identifying the server. Use a `imap://` prefix for non-secure
connections and a `imaps://` prefix for secure connections.
Ignored when imap.tunnel is set, but required to use imap-send
otherwise.
imap.user::
The username to use when logging in to the server.
imap.password::
The password to use when logging in to the server.
imap.port::
An integer port number to connect to on the server.
Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
Ignored when imap.tunnel is set.
imap.sslverify::
A boolean to enable/disable verification of the server certificate
used by the SSL/TLS connection. Default is `true`. Ignored when
imap.tunnel is set.
Examples
~~~~~~~~
Using tunnel mode:
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
Several trivial documentation touch ups. Move incorrect asciidoc level 2 titles back to level 1. Show output of git-name-rev in man page example. Reword sentences that begin with a period (.) in asciidoc numbered lists to work around conversion to man page bug. Mention that git-repack now calls git-prune-packed when the -d option is passed to it. [imap] section headers in the config file example need to be contained in a literal block. imap.pass is the proper config file variable to use, not imap.password. Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-05 21:05:10 +02:00
..........................
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
[imap]
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
folder = "INBOX.Drafts"
tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null"
..........................
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
Using direct mode:
.........................
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
[imap]
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
folder = "INBOX.Drafts"
host = imap://imap.example.com
user = bob
pass = p4ssw0rd
..........................
Using direct mode with SSL:
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
.........................
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
[imap]
Documentation: Improve documentation for git-imap-send(1) 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. Document 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. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:02 +02:00
folder = "INBOX.Drafts"
host = imaps://imap.example.com
user = bob
pass = p4ssw0rd
port = 123
git-imap-send: Support SSL Allow SSL to be used when a imaps:// URL is used for the host name. Also, automatically use TLS when not using imaps:// by using the IMAP STARTTLS command, if the server supports it. Tested with Courier and Gimap IMAP servers. Signed-off-by: Robert Shearman <robertshearman@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-09 23:29:00 +02:00
sslverify = false
Several trivial documentation touch ups. Move incorrect asciidoc level 2 titles back to level 1. Show output of git-name-rev in man page example. Reword sentences that begin with a period (.) in asciidoc numbered lists to work around conversion to man page bug. Mention that git-repack now calls git-prune-packed when the -d option is passed to it. [imap] section headers in the config file example need to be contained in a literal block. imap.pass is the proper config file variable to use, not imap.password. Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-05 21:05:10 +02:00
..........................
Add documentation for git-imap-send. Signed-off-by: Mike McCormack <mike@codeweavers.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-04-06 05:32:19 +02:00
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
---
documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-06 09:07:32 +02:00
Part of the linkgit:git[1] suite
Copy permalink