about summary refs log tree commit diff
path: root/bubger.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-04-09 12:25:47 -0400
committerJune McEnroe <june@causal.agency>2020-04-09 12:25:47 -0400
commitb7424c174c2b16e7ee7fa3ee59c3c937517d6149 (patch)
treed3a7076ac9fe6efece3fbb1660ea7b3bc083b7df /bubger.1
downloadbubger-b7424c174c2b16e7ee7fa3ee59c3c937517d6149.tar.gz
bubger-b7424c174c2b16e7ee7fa3ee59c3c937517d6149.zip
Add prospective manual page for bubger
Diffstat (limited to 'bubger.1')
-rw-r--r--bubger.1137
1 files changed, 137 insertions, 0 deletions
diff --git a/bubger.1 b/bubger.1
new file mode 100644
index 0000000..d92ecbb
--- /dev/null
+++ b/bubger.1
@@ -0,0 +1,137 @@
+.Dd April  9, 2020
+.Dt BUBGER 1
+.Os
+.
+.Sh NAME
+.Nm bubger
+.Nd IMAP archive renderer
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Op Fl C Ar path
+.Op Fl a Ar algo
+.Op Fl h Ar head
+.Op Fl p Ar port
+.Op Fl s Ar search
+.Op Fl t Ar title
+.Op Fl w Ar file
+.Ar host
+.Ar user
+.Op Ar mailbox
+.
+.Sh DESCRIPTION
+The
+.Nm
+utility renders an HTML, Atom and mboxrd archive
+of an IMAP mailbox
+arranged into threads.
+.
+.Pp
+The arguments are as follows:
+.
+.Bl -tag -width Ds
+.It Fl C Ar path
+Change directory to
+.Ar path
+before reading and writing files.
+.
+.It Fl a Ar algo
+Set the threading algorithm to one of
+.Sy ORDEREDSUBJECT
+or
+.Sy REFERENCES .
+The default algorithm is
+.Sy REFERENCES .
+.
+.It Fl h Ar head
+Add the contents of the file
+.Ar head
+to the
+.Sy <head>
+element of HTML pages.
+.
+.It Fl p Ar port
+Connect to IMAP on
+.Ar port .
+The default port is
+.Sy imaps
+.Pq 993 .
+TLS without STARTTLS is assumed.
+.
+.It Fl s Ar search
+Limit threads to messages matching
+.Ar search .
+The default search is
+.Sy ALL .
+.
+.It Fl t Ar title
+Set the base title for HTML pages.
+The default title is the mailbox name.
+.
+.It Fl w Ar file
+Read the IMAP password from
+.Ar file .
+By default the password is set by the
+.Ev BUBGER_IMAP_PASSWORD
+environment variable.
+.
+.It Fl v
+Log IMAP protocol to standard error.
+.
+.It Ar host
+Connect to IMAP on
+.Ar host .
+
+.It Ar user
+Log in to IMAP as
+.Ar user .
+.
+.It Ar mailbox
+Render messages from
+.Ar mailbox .
+The default mailbox is
+.Qq Archive .
+.El
+.
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev BUBGER_IMAP_PASSWORD
+The IMAP password.
+.El
+.
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa UIDVALIDITY
+Stores the mailbox UID validity.
+.It Pa UID/*.atom , Pa UID/*.html , Pa UID/*.mbox
+Cached Atom, HTML and mboxrd fragments for each message.
+.It Pa thread/*.atom , Pa thread/*.html , Pa thread/*.mbox
+Rendered Atom, HTML and mboxrd files for each thread.
+.El
+.
+.Sh STANDARDS
+.Bl -item
+.It
+.Rs
+.%A M. Crispin
+.%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 M. Crispin
+.%A K. Murchison
+.%T Internet Message Access Protocol - SORT and THREAD Extensions
+.%I IETF
+.%N RFC 5256
+.%D June 2008
+.%U https://tools.ietf.org/html/rfc5256
+.Re
+.El
+.
+.Sh AUTHORS
+.An June Bug Aq Mt june@causal.agency