crabmail/doc/crabmail.1

.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "crabmail" "1" "2022-04-03"
.P
.SH NAME
.P
crabmail - an HTML email archive generator
.P
.SH SYNOPSIS
.P
crabmail [-rR] [-c CONFIG] [-d OUT_DIR] maildir
.P
.SH DESCRIPTION
.P
Crabmail writes html pages for the maildir folders contained within \fBmaildir\fR
.P
\fB-g\fR
.RS 4
include gemini output.\& default true if neither this nor \fB-h\fR is present.\&
.P
.RE
\fB-h\fR
.RS 4
include html output.\& default true if neither this nor \fB-h\fR is present.\&
.P
.RE
\fB-c CONFIG\fR
.P
.RS 4
The config file to read from.\& Default is .\&/crabmail.\&conf
.P
.RE
\fB-d OUT_DIR\fR
.RS 4
.P
The out dir to write HTML to.\& Defaults it .\&/site
.P
.RE
\fBmaildir\fR
.P
.RS 4
Path to a maildir folder.\& All subfolders (with the exception of the special
maildir folders cur, new, tmp) will be rendered as sub-pages in your HTML
archive.\& 
.P
.RE
Threads will be written to \fBOUT_DIR\fR/threads/[thread-id].\&html -- Thread IDs can
have basically any character in them, except for forward slashes, which are
replaced by semicolons: keep this in mind if you are using a non-unix
filesystem.\&
.P
Threading is determined by a combination of in-reply-to and subject headers.\&
.P
Caching is minimal at the moment and subject to change.\&
.P
.SH SEE ALSO
.P
\fBcrabmail-config\fR(5) 
.P
.SH AUTHORS
Alex Wennerberg <alex@alexwennerberg.\&com>