tttm

git clone https://orangeshoelaces.net/git/tttm.git

6b3c6fb11a4c0683d68cadaeee566a32aa1a105e

Author: Vasily Kolobkov on 06/03/2016

Committer: Vasily Kolobkov on 06/03/2016

Write manual

Stats

tttm.1 | 61 ++++++++
1 file changed, 61 insertions(+)

Patch

diff --git a/tttm.1 b/tttm.1
new file mode 100644
index 0000000..f9d28ba
--- /dev/null
+++ b/tttm.1
@@ -0,0 +1,61 @@
+.Dd June 3, 2016
+.Dt TTTM 1
+.Os
+.Sh NAME
+.Nm tttm
+.Nd mail retrieval agent
+.Sh SYNOPSIS
+.Nm
+.Op Fl u
+.Ar sink
+.Sh DESCRIPTION
+.Nm , a loose initialism for
+.Do thank you for the mail Dc , fetches mail from IMAP server and delivers each
+message on standard input of
+.Ar sink
+shell command.
+Mail is deleted from server afterwards.
+.Pp
+Communication with mail server is carried out on standard input (server replies)
+and output (client commands).
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl u
+Pertain to UCSPI specification, reading input on file descriptor 6, and
+writing commands to file descriptor 7.
+.El
+.Sh ENVIRONMENT
+In most likely case of authentication taking place within IMAP session,
+pass login credentials in following environment variables to thwart
+eavesdropping sensitive data via process arguments:
+.Bl -tag -width IMAP_XXXX
+.It Ev IMAP_USER
+User name
+.It Ev IMAP_PASS
+Password
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh EXAMPLES
+Here is an example of retrieving mail using
+.Nm
+along with
+.Xr nc 1
+to get you started:
+.Bd -literal -offset indent
+mkfifo cmd
+nc -c imap.example.org 993 < cmd | \e
+IMAP_USER=alice IMAP_PASS=love tttm slocal > cmd
+rm cmd
+.Ed
+.Sh SEE ALSO
+.Xr nc 1 ,
+.Xr socat 1 ,
+.Xr tcpclient 1
+.Sh STANDARDS
+.Nm
+speaks Internet Message Access Protocol version 4rev1, RFC 3501.
+.Sh AUTHORS
+Initially written and dedicated to the public domain by
+.An Vasily Kolobkov .