summary refs log tree commit diff
path: root/git-fetch-email.1
diff options
context:
space:
mode:
Diffstat (limited to 'git-fetch-email.1')
-rw-r--r--git-fetch-email.1124
1 files changed, 124 insertions, 0 deletions
diff --git a/git-fetch-email.1 b/git-fetch-email.1
new file mode 100644
index 0000000..2ee3a6f
--- /dev/null
+++ b/git-fetch-email.1
@@ -0,0 +1,124 @@
+.Dd December 21, 2019
+.Dt GIT-FETCH-EMAIL 1
+.Os
+.
+.Sh NAME
+.Nm git-fetch-email
+.Nd fetch patches over IMAP
+.
+.Sh SYNOPSIS
+.Nm git
+.Cm fetch-email
+.Op Fl C Ar cc
+.Op Fl F Ar from
+.Op Fl S Ar subject
+.Op Fl T Ar to
+.Op Fl h Ar host
+.Op Fl m Ar mailbox
+.Op Fl p Ar port
+.Op Ar user
+.
+.Sh DESCRIPTION
+The
+.Nm
+command is a wrapper around
+.Xr imbox 1
+using
+.Xr git-config 1
+and
+.Xr git-credential 1 .
+It fetches patches to be piped into
+.Xr git-am 1 .
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl C Ar cc
+Fetch patches with matching
+.Cm Cc
+headers.
+The default is the value of
+.Cm fetchemail.cc .
+.
+.It Fl F Ar from
+Fetch patches with matching
+.Cm From
+headers.
+The default is the value of
+.Cm fetchemail.from .
+.
+.It Fl S Ar subject
+Fetch patches with matching
+.Cm Subject
+headers.
+The default is the value of
+.Cm fetchemail.subject ,
+or
+.Ql [PATCH .
+.
+.It Fl T Ar to
+Fetch patches with matching
+.Cm To
+headers.
+The default is the value of
+.Cm fetchemail.to .
+.
+.It Fl h Ar host
+Connect to IMAP on
+.Ar host .
+The default is the value of
+.Cm fetchemail.imapServer ,
+or as inferred by
+.Xr imbox 1 .
+.
+.It Fl m Ar mailbox
+Fetch patches from
+.Ar mailbox .
+The default is the value of
+.Cm fetchemail.imapMailbox ,
+or INBOX.
+.
+.It Fl p Ar port
+Connect to IMAP on
+.Ar port .
+The default is the value of
+.Cm fetchemail.imapServerPort ,
+or as inferred by
+.Xr imbox 1 .
+.El
+.
+.Pp
+If
+.Ar user
+is not provided,
+the value of
+.Cm fetchemail.imapUser
+is used.
+If
+.Cm fetchemail.imapPass
+is set,
+it is used as the IMAP login password,
+otherwise the password is obtained using
+.Xr git-credential 1 .
+.
+.Sh EXAMPLES
+.Bd -literal
+git config fetchemail.to list@example.org
+git fetch-email june@causal.agency | git am
+.Ed
+.
+.Sh SEE ALSO
+.Xr git-am 1 ,
+.Xr imbox 1 ,
+.Xr gitcredentials 7
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency
+.
+.Sh BUGS
+Send mail to
+.Aq Mt june@causal.agency
+or join
+.Li #ascii.town
+on
+.Li chat.freenode.net .