summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-12-21 07:08:49 -0500
committerJune McEnroe <june@causal.agency>2019-12-21 07:08:49 -0500
commit66a05050214a503e66a0e42c977fad755e2f574c (patch)
treed426f821fd84c15b9d9e54036a8f5404dfaf3672
parentNull-terminate read literals (diff)
downloadimbox-66a05050214a503e66a0e42c977fad755e2f574c.tar.gz
imbox-66a05050214a503e66a0e42c977fad755e2f574c.zip
Rewrite aspirational manual
-rw-r--r--imbox.176
1 files changed, 61 insertions, 15 deletions
diff --git a/imbox.1 b/imbox.1
index 791c996..c91abd8 100644
--- a/imbox.1
+++ b/imbox.1
@@ -1,4 +1,4 @@
-.Dd December 20, 2019
+.Dd December 21, 2019
 .Dt IMBOX 1
 .Os
 .
@@ -9,10 +9,13 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl vw
+.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 Fl s Ar search
 .Ar user
 .
 .Sh DESCRIPTION
@@ -20,6 +23,14 @@ The
 .Nm
 utility exports messages from an IMAP mailbox
 to the mboxrd format on standard output.
+Messages matching the criteria set by
+.Fl CFST
+are exported.
+The default criterion is
+.Fl S Cm '[PATCH' .
+.
+.Pp
+IMAP over TLS without STARTTLS is assumed.
 IMAP login is performed as
 .Ar user
 with a password read from
@@ -31,12 +42,32 @@ is used.
 .Pp
 The arguments are as follows:
 .Bl -tag -width Ds
+.It Fl C Ar cc
+Export messages with matching
+.Cm Cc
+headers.
+.
+.It Fl F Ar from
+Export messages with matching
+.Cm From
+headers.
+.
+.It Fl S Ar subject
+Export messages with matching
+.Cm Subject
+headers.
+.
+.It Fl T Ar to
+Export messages with matching
+.Cm To
+headers.
+.
 .It Fl h Ar host
-Connect to
+Connect to IMAP on
 .Ar host .
-The default host is
-.Li imap.fastmail.com .
-TLS without STARTTLS is assumed.
+The default host is determined by SRV record lookup
+on the domain name of
+.Ar user .
 .
 .It Fl m Ar mailbox
 Export messages from
@@ -44,21 +75,22 @@ Export messages from
 The default mailbox is INBOX.
 .
 .It Fl p Ar port
-Connect to
+Connect to IMAP on
 .Ar port .
-The default port is 993.
-.
-.It Fl s Ar search
-Export messages matching
-.Ar search .
-The default search is
-.Ql SUBJECT \(dq[PATCH\(dq .
+If the
+.Fl h
+option is used,
+the default port is
+.Cm imaps
+(993).
+Otherwise,
+the port is determined in the same fashion as the host.
 .
 .It Fl v
 Log IMAP protocol to standard error.
 .
 .It Fl w
-Read the IMAP password from standard input.
+Read the password from standard input.
 .El
 .
 .Sh EXAMPLES
@@ -66,6 +98,9 @@ Read the IMAP password from standard input.
 imbox june@causal.agency | git am
 .Ed
 .
+.Sh SEE ALSO
+.Xr git-am 1
+.
 .Sh STANDARDS
 .Bl -item
 .It
@@ -88,3 +123,14 @@ imbox june@causal.agency | git am
 .%U https://tools.ietf.org/html/rfc4155
 .Re
 .El
+.
+.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 .