summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-01-24 11:51:43 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-01-24 11:51:43 -0700
commite29e329b58b8e4a92c0d535a5e67f147e8a3d026 (patch)
tree2aea83774ae83178e30458ec10b1fc54e52ab6ea
parent558d2566377ad7f6946129eab1f679e244b8999d (diff)
downloadmailscripts-e29e329b58b8e4a92c0d535a5e67f147e8a3d026.tar.gz
gmi2email(1): add "TYPICAL USAGE"
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r--gmi2email.1.pod41
1 files changed, 41 insertions, 0 deletions
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<gmi2email> 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<gmi2email> 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