summary refs log tree commit diff
path: root/bin/man1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--bin/man1/imbox.190
1 files changed, 90 insertions, 0 deletions
diff --git a/bin/man1/imbox.1 b/bin/man1/imbox.1
new file mode 100644
index 00000000..791c9968
--- /dev/null
+++ b/bin/man1/imbox.1
@@ -0,0 +1,90 @@
+.Dd December 20, 2019
+.Dt IMBOX 1
+.Os
+.
+.Sh NAME
+.Nm imbox
+.Nd IMAP to mboxrd
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl vw
+.Op Fl h Ar host
+.Op Fl m Ar mailbox
+.Op Fl p Ar port
+.Op Fl s Ar search
+.Ar user
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility exports messages from an IMAP mailbox
+to the mboxrd format on standard output.
+IMAP login is performed as
+.Ar user
+with a password read from
+.Pa /dev/tty ,
+or standard input if
+.Fl w
+is used.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl h Ar host
+Connect to
+.Ar host .
+The default host is
+.Li imap.fastmail.com .
+TLS without STARTTLS is assumed.
+.
+.It Fl m Ar mailbox
+Export messages from
+.Ar mailbox .
+The default mailbox is INBOX.
+.
+.It Fl p Ar port
+Connect to
+.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 .
+.
+.It Fl v
+Log IMAP protocol to standard error.
+.
+.It Fl w
+Read the IMAP password from standard input.
+.El
+.
+.Sh EXAMPLES
+.Bd -literal
+imbox june@causal.agency | git am
+.Ed
+.
+.Sh STANDARDS
+.Bl -item
+.It
+.Rs
+.%A M. Crispin
+.%Q University of Washington
+.%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1
+.%I IETF
+.%N RFC 3501
+.%D March 2003
+.%U https://tools.ietf.org/html/rfc3501
+.Re
+.It
+.Rs
+.%A E. Hall
+.%T The application/mbox Media Type
+.%I IETF
+.%N RFC 4155
+.%D September 2005
+.%U https://tools.ietf.org/html/rfc4155
+.Re
+.El
itting the whole message on it won't work. I hate this code though. 2019-11-11Filter userhost-in-namesJune McEnroe I really want to be writing tests for these functions... 2019-11-10Compare words without copying in filtersJune McEnroe 2019-11-10Separate tags from all targetJune McEnroe 2019-11-10Filter invite-notifyJune McEnroe 2019-11-10Add capsicum note to READMEJune McEnroe 2019-11-10Filter extended-joinJune McEnroe 2019-11-10Expand client configuration documentation and list capabilitiesJune McEnroe 2019-11-10Request all supported caps from serverJune McEnroe 2019-11-10Filter ACCOUNT, AWAY, CHGHOST for incapable clientsJune McEnroe 2019-11-10Rename listen to localJune McEnroe 2019-11-09Remove extended-join and invite-notifyJune McEnroe The remaining caps only generate new commands which can easily be filtered out when sending to clients so will be in the first pass of support. extended-join is probably safe to pass through unaltered, just causing extraneous parameters on JOIN commands, but maybe not. invite-notify reuses the INVITE command where the invited user is not self. 2019-11-09Maintain stateCaps and offer them to clientsJune McEnroe 2019-11-09Parse capabilitiesJune McEnroe The list that I've defined are the ones that I expect to be able to enable probably without any clients breaking... And of course server-time which pounce implements itself. 2019-11-09Avoid the reserved _A names with BIT macroJune McEnroe 2019-11-09Define macro for bit flag enumsJune McEnroe 2019-11-08Check that password is hashedJune McEnroe 2019-11-08Avoid calling getopt_long again after it returns -1June McEnroe On GNU, calling getopt_long again will reset optind back to the first non-option argument, which would cause an infinite loop of reading the same configurtion file forever. 2019-11-08Only change AWAY status for registered clientsJune McEnroe Turns out I did eventually fix this, because I may want to implement "passive clients" for logging or notification stuff, which wouldn't affect AWAY status either. 2019-11-07Just write the example normallyJune McEnroe 2019-11-07Include path in readlinkat errorJune McEnroe 2019-11-07Call clientConsume before clientRecvJune McEnroe This might reduce the frequency of a client getting its own message back because it was behind in the ring when it sent it. 2019-11-06Use -l:filename in Linux.mkJune McEnroe 2019-11-06Fix compat.h for #defined strlcpyJune McEnroe 2019-11-06Allow unsetting LIBRESSL_PREFIXJune McEnroe 2019-11-06Document calico service configurationJune McEnroe 2019-11-06Document SASL EXTERNAL configuration in more detailJune McEnroe 2019-11-06Document pounce service configurationJune McEnroe 2019-11-06Mention Darwin and GNU/Linux in READMEJune McEnroe 2019-11-06Assume LibreSSL from brew on DarwinJune McEnroe 2019-11-06Remove -DNO_EXPLICIT_BZERO from Darwin.mkJune McEnroe 2019-11-06Don't install rc scripts or dirs on LinuxJune McEnroe