diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2021-04-05 16:42:01 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-04-05 16:42:01 -0700 |
commit | a527e341c147cc6b952ba35f08ce4e116dc200af (patch) | |
tree | 9be6e21fc8b304c9aca0560a32aab35ab3fef5bf /gmi2email.1.pod | |
parent | 5e5d198de86e71687677b9312c0ae6fc238b0fbd (diff) | |
parent | 7b3d79afdaca217183b9715cfb40979a16cafd89 (diff) | |
download | mailscripts-a527e341c147cc6b952ba35f08ce4e116dc200af.tar.gz |
Merge tag 'debian/0.23-1' into buster-bpo
mailscripts release 0.23-1 for unstable (sid) [dgit]
[dgit distro=debian no-split --quilt=linear]
# gpg: Signature made Thu 28 Jan 2021 04:37:17 PM MST
# gpg: using RSA key 9B917007AE030E36E4FC248B695B7AE4BF066240
# gpg: Good signature from "Sean Whitton <spwhitton@spwhitton.name>" [ultimate]
# Primary key fingerprint: 8DC2 487E 51AB DD90 B5C4 753F 0F56 D055 3B6D 411B
# Subkey fingerprint: 9B91 7007 AE03 0E36 E4FC 248B 695B 7AE4 BF06 6240
Diffstat (limited to 'gmi2email.1.pod')
-rw-r--r-- | gmi2email.1.pod | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/gmi2email.1.pod b/gmi2email.1.pod new file mode 100644 index 0000000..b7e9108 --- /dev/null +++ b/gmi2email.1.pod @@ -0,0 +1,129 @@ +=head1 NAME + +gmi2email - subscribe to gemlogs and read individual Gemini pages by e-mail + +=head1 SYNOPSIS + +B<gmi2email> [I<OPTIONS>] [I<URI or FILE>] ... + +=head1 DESCRIPTION + +B<gmi2email> 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 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 + +=item B<--subscriptions>[=I<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. + +We support the subscription mechanism described at +<gemini://gemini.circumlunar.space/docs/companion/subscription.gmi> as well as +Atom feeds. + +B<gmi2email> looks for a file with a list of gemini:// URIs to check for new +posts, one per line, in I<FILE>, or if that is not set, in +B<$XDG_CONFIG_HOME/mailscripts/gmi2email.subscriptions>, or if XDG_CONFIG_HOME +is not set, it falls back to trying to read +B<~/.config/mailscripts/gmi2email.subscriptions>. + +=item B<--inline-images> + +Download and inline any images included in the post. + +=item B<--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. + +=item B<--from=>I<ADDRESS> + +Set the From: address, overriding the configuration file. + +=item B<--to=>I<ADDRESS> + +Set the To: address, overriding the configuration file. + +=back + +=head1 CONFIGURATION + +B<gmi2email> tries to read configuration from the file +B<$XDG_CONFIG_HOME/mailscripts/gmi2email.config>, or if XDG_CONFIG_HOME is not +set, it falls back to trying to read +B<~/.config/mailscripts/gmi2email.config>. + +The format is I<key = value>, one per line. The following +configuration keys are supported: + +=over 4 + +=item B<from> + +Set the From: address. + +=item B<to> + +Set the To: address. + +=item inline_images + +Set to 1 to implicitly pass B<--inline-images>. + +=back + +=head1 SEE ALSO + +<https://gemini.circumlunar.space/> + +=head1 AUTHOR + +B<gmi2email> was written by Sean Whitton <spwhitton@spwhitton.name>. |