NOTEMAP(1)

📦 version 1.3, in nixos 26.05, nixpkgs unstable

NOTEMAP(1) — General Commands Manual, but bestie edition 💌

Manual name folded in near the top like a little name tag: notemap and git-notemap, okay? Periodt.

💖 NAME 💖

notemap, git-notemap — mirror notes to IMAP ✨

✨ SYNOPSIS ✨

notemap [-afvw] [-M mailbox] [-h host] [-m file] [-p port] user [file ...]
git notemap [-afv] [-M mailbox] [-h host] [-m file] [-p port] [-u user] [file ...]

🦋 DESCRIPTION 🦋

Okay so notemap is the utility that mirrors text notes into an IMAP mailbox that’s appropriate for display by the Apple Notes application. It maps files to IMAP messages using a map file — by default .notemap in the current directory. If you don’t specify any files, all mapped files are mirrored. New files get added to the map file with -a, slay.

🔒 IMAP over TLS is assumed. The IMAP host and port are automatically discovered through SRV record lookup on the domain portion of user. The password is read from /dev/tty, or from standard input if -w is used.

The git-notemap wrapper uses git-config(1) and gitcredentials(7) for defaults and authentication. It’s giving convenient, honestly.

The arguments are as follows, bestie — every one, no skips:

  • -M mailbox — Mirror notes to mailbox. The default is Notes.
  • -a — Add new notes to the map file.
  • -f — Overwrite modified notes in the mailbox.
  • -h host — Connect to IMAP on host.
  • -m file — Set the path of the map file. The default is .notemap.
  • -p port — Connect to IMAP on port.
  • -v — Log IMAP protocol to standard error.
  • -w — Read the password from standard input.

The git-notemap wrapper loads defaults from these git-config(1) options: notemap.imapServer, notemap.imapServerPort, notemap.imapUser, notemap.imapPass, notemap.imapMailbox, notemap.mapFile. If notemap.imapPass is unset, the password is obtained through gitcredentials(7). iykyk 💅

🎀 EXAMPLES 🎀

Here’s the group-chat demo reel 🍓:

notemap -a june@causal.agency note.txt
git config notemap.imapUser june@causal.agency
git notemap note.txt

🌈 STANDARDS 🌈

The receipts, exact and no cap 📚:

👑 AUTHORS 👑

Made by the icon: June Bug <june@causal.agency> 💖

💀 CAVEATS 💀

Heads up, bestie: notes are assumed to be plain UTF-8 text with LF line endings.

🐛 BUGS 🐛

Found a bug? Send mail to ⟨list+notemap@causal.agency⟩ or join #ascii.town on chat.freenode.net. fr fr, we’re around 🫶

Debian edition, dated December 16, 2020 — NOTEMAP(1) signing off 💅✨

📦 where this page comes from