.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "gmi2email 1"
.TH gmi2email 1 "Debian Project" "perl v5.38.2" "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
gmi2email \- subscribe to gemlogs and read individual Gemini pages by e\-mail
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBgmi2email\fR [\fIOPTIONS\fR] [\fIURI or FILE\fR] ...
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgmi2email\fR fetches pages served using the Gemini protocol, converts them to
e\-mail messages, and then sends those messages.  It is mainly useful for
subscribing to Gemini logs ("gemlogs") by e\-mail, like \fBrss2email\fR\|(1).
\&\fBgmi2email\fR fetches, converts and sends all URIs and files containing
text/gemini content specified on the command line.
.SS "TYPICAL USAGE"
.IX Subsection "TYPICAL USAGE"
1. Ensure you have a working MTA: \fBgmi2email\fR will use the \fBsendmail\fR\|(1)
command to send mail.
.PP
2. Create \fB~/.config/mailscripts/gmi2email.config\fR with content like this:
.Sp
.Vb 3
\&    from = rss@example.com
\&    to = your_email@example.com
\&    inline_images = 1
.Ve
.PP
3. Create \fB~/.config/mailscripts/gmi2email.subscriptions\fR with some feed
URIs, e.g.
.Sp
.Vb 2
\&    gemini://example.com/my_cool_gemlog/
\&    gemini://example.com/other_cool_gemlog/feed.xml
.Ve
.PP
4. Just once, execute
.Sp
.Vb 1
\&    % gmi2email \-\-subscriptions \-\-no\-send
.Ve
.PP
5. Periodically, execute
.Sp
.Vb 1
\&    % gmi2email \-\-subscriptions
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-subscriptions\fR[=\fIFILE\fR] 4
.IX Item "--subscriptions[=FILE]"
In addition to mailing any URIs/files specified on the command line, check
subscribed gemlogs for new posts and send those too.  Useful in a crontab.
.Sp
We support the subscription mechanism described at
<gemini://gemini.circumlunar.space/docs/companion/subscription.gmi> as well as
Atom feeds.
.Sp
\&\fBgmi2email\fR looks for a file with a list of gemini:// URIs to check for new
posts, one per line, in \fIFILE\fR, or if that is not set, in
\&\fR\f(CB$XDG_CONFIG_HOME\fR\fB/mailscripts/gmi2email.subscriptions\fR, or if XDG_CONFIG_HOME
is not set, it falls back to trying to read
\&\fB~/.config/mailscripts/gmi2email.subscriptions\fR.  Lines beginning with '#'
are treated as comments and ignored.
.IP \fB\-\-inline\-images\fR 4
.IX Item "--inline-images"
Download and inline any images included in the post.
.IP \fB\-\-no\-send\fR 4
.IX Item "--no-send"
Don't actually send any mail.  Intended when you just added some new
subscriptions and want to avoid receiving all the old posts you've already
read.
.IP \fB\-\-from=\fR\fIADDRESS\fR 4
.IX Item "--from=ADDRESS"
Set the From: address, overriding the configuration file.
.IP \fB\-\-to=\fR\fIADDRESS\fR 4
.IX Item "--to=ADDRESS"
Set the To: address, overriding the configuration file.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
\&\fBgmi2email\fR tries to read configuration from the file
\&\fR\f(CB$XDG_CONFIG_HOME\fR\fB/mailscripts/gmi2email.config\fR, or if XDG_CONFIG_HOME is not
set, it falls back to trying to read
\&\fB~/.config/mailscripts/gmi2email.config\fR.
.PP
The format is \fIkey = value\fR, one per line.  The following
configuration keys are supported:
.IP \fBfrom\fR 4
.IX Item "from"
Set the From: address.
.IP \fBto\fR 4
.IX Item "to"
Set the To: address.
.IP inline_images 4
.IX Item "inline_images"
Set to 1 to implicitly pass \fB\-\-inline\-images\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://gemini.circumlunar.space/>
.SH AUTHOR
.IX Header "AUTHOR"
\&\fBgmi2email\fR was written by Sean Whitton <spwhitton@spwhitton.name>.