From e29e329b58b8e4a92c0d535a5e67f147e8a3d026 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sun, 24 Jan 2021 11:51:43 -0700 Subject: gmi2email(1): add "TYPICAL USAGE" Signed-off-by: Sean Whitton --- gmi2email.1.pod | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/gmi2email.1.pod b/gmi2email.1.pod index d5004d5..6f12b84 100644 --- a/gmi2email.1.pod +++ b/gmi2email.1.pod @@ -14,6 +14,47 @@ subscribing to Gemini logs ("gemlogs") by e-mail, like rss2email(1). B fetches, converts and sends all URIs and files containing text/gemini content specified on the command line. +=head2 TYPICAL USAGE + +1. Ensure you have a working MTA: B will use the sendmail(1) +command to send mail. + +2. Create B<~/.config/mailscripts/gmi2email.config> with content like this: + +=over 4 + + from = rss@example.com + to = your_email@example.com + inline_images = 1 + +=back + +3. Create B<~/.config/mailscripts/gmi2email.subscriptions> with some feed +URIs, e.g. + +=over 4 + + gemini://example.com/my_cool_gemlog/ + gemini://example.com/other_cool_gemlog/feed.xml + +=back + +4. Just once, execute + +=over 4 + + % gmi2email --subscriptions --no-send + +=back + +5. Periodically, execute + +=over 4 + + % gmi2email --subscriptions + +=back + =head1 OPTIONS =over 4 -- cgit v1.2.3