gmi2email(1)

📦
version 31 · 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ gmi2email(1) ✨

okay bestie, gather round, because this is the manual page for gmi2email — a User Command from the Debian Project, and honestly? it's giving ✨subscription-era RSS but make it Gemini✨

🦋 NAME 🦋

gmi2email — subscribe to gemlogs and read individual Gemini pages by e-mail 💌

🌸 SYNOPSIS 🌸

gmi2email [OPTIONS] [URI or FILE] ...

💖 DESCRIPTION 💖

so what does gmi2email actually do, you ask? bestie. it fetches pages served using the Gemini protocol, converts them into e-mail messages, and then sends those messages. that's it. that's the whole vibe. 👑

it's mainly useful for subscribing to Gemini logs (aka "gemlogs") by e-mail, like rss2email(1) does for the regular web. no cap.

gmi2email fetches, converts and sends all URIs and files containing text/gemini content specified on the command line. every single one. it does not skip. it does not play. 💅

🌈 TYPICAL USAGE 🌈

  1. make sure you have a working MTA, because gmi2email will use the sendmail(1) command to send mail. no MTA, no mail, it's giving sad. 😭
  2. create ~/.config/mailscripts/gmi2email.config with content like this:
from = rss@example.com
to = your_email@example.com
inline_images = 1
  1. create ~/.config/mailscripts/gmi2email.subscriptions with some feed URIs, e.g.
gemini://example.com/my_cool_gemlog/
gemini://example.com/other_cool_gemlog/feed.xml
  1. just once, execute
% gmi2email --subscriptions --no-send
  1. and then, periodically, execute
% gmi2email --subscriptions

and that's the whole routine bestie, set it and forget it fr fr 🫶

🎀 OPTIONS 🎀

  • --subscriptions[=FILE] — in addition to mailing any URIs/files specified on the command line, this checks your subscribed gemlogs for new posts and sends those too. super useful in a crontab 👑

we support the subscription mechanism described at <gemini://gemini.circumlunar.space/docs/companion/subscription.gmi> as well as Atom feeds. yes, both. we contain multitudes. ✨

gmi2email looks for a file with a list of gemini:// URIs to check for new posts, one per line, in FILE, or if that is not set, in $XDG_CONFIG_HOME/mailscripts/gmi2email.subscriptions, or if XDG_CONFIG_HOME is not set, it falls back to trying to read ~/.config/mailscripts/gmi2email.subscriptions. and btw, lines beginning with '#' are treated as comments and ignored. so go ahead and annotate, queen. 💅

  • --inline-images — download and inline any images included in the post. pics in your mail, we love to see it 🌸
  • --no-send — don't actually send any mail. this one's intended for when you just added some new subscriptions and want to avoid receiving all the old posts you've already read. lifesaver, honestly 🙈
  • --from=ADDRESS — set the From: address, overriding the configuration file. 💌
  • --to=ADDRESS — set the To: address, overriding the configuration file. 📬

🧚 CONFIGURATION 🧚

gmi2email tries to read configuration from the file $XDG_CONFIG_HOME/mailscripts/gmi2email.config, or if XDG_CONFIG_HOME is not set, it falls back to trying to read ~/.config/mailscripts/gmi2email.config.

the format is key = value, one per line. simple. clean. iconic.

the following configuration keys are supported:

  • from — set the From: address.
  • to — set the To: address.
  • inline_images — set to 1 to implicitly pass --inline-images.

👑 SEE ALSO 👑

💜 AUTHOR 💜

gmi2email was written by Sean Whitton <spwhitton@spwhitton.name>. give them their flowers 💐

and that's a wrap bestie!! this page was served up by perl v5.40.1 from the Debian Project, dated gmi2email(1) — so like, go forth, subscribe to gemlogs, and let your inbox be cute ✨🦋💖

📦 where this page comes from