.Dd December 16, 2020
.Dt NOTEMAP 1
.Os
.
.Sh NAME
.Nm notemap ,
.Nm git-notemap
.Nd mirror notes to IMAP
.
.Sh SYNOPSIS
.Nm
.Op Fl afvw
.Op Fl M Ar mailbox
.Op Fl h Ar host
.Op Fl m Ar file
.Op Fl p Ar port
.Ar user
.Op Ar
.
.Nm git
.Cm notemap
.Op Fl afv
.Op Fl M Ar mailbox
.Op Fl h Ar host
.Op Fl m Ar file
.Op Fl p Ar port
.Op Fl u Ar user
.Op Ar
.
.Sh DESCRIPTION
The
.Nm
utility
mirrors text notes
to an IMAP mailbox
appropriate for display
by the Apple Notes application.
Files are mapped to IMAP messages
using a map file,
by default
.Pa .notemap
in the current directory.
If no files are specified,
all mapped files are mirrored.
New files are added
to the map file using
.Fl a .
.
.Pp
IMAP over TLS is assumed.
The IMAP host and port
are automatically discovered
through SRV record lookup
on the domain portion of
.Ar user .
The password is read from
.Pa /dev/tty ,
or standard input if
.Fl w
is used.
.
.Pp
The
.Nm git-notemap
wrapper uses
.Xr git-config 1
and
.Xr gitcredentials 7
for defaults and authentication.
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl M Ar mailbox
Mirror notes to
.Ar mailbox .
The default is
.Sy Notes .
.It Fl a
Add new notes to the map file.
.It Fl f
Overwrite modified notes in the mailbox.
.It Fl h Ar host
Connect to IMAP on
.Ar host .
.It Fl m Ar file
Set the path of the map file.
The default is
.Pa .notemap .
.It Fl p Ar port
Connect to IMAP on
.Ar port .
.It Fl v
Log IMAP protocol to standard error.
.It Fl w
Read the password from standard input.
.El
.
.Pp
The
.Nm git-notemap
wrapper loads defaults
from the following
.Xr git-config 1
options:
.Cm notemap.imapServer ,
.Cm notemap.imapServerPort ,
.Cm notemap.imapUser ,
.Cm notemap.imapPass ,
.Cm notemap.imapMailbox ,
.Cm notemap.mapFile .
If
.Cm notemap.imapPass
is unset,
the password is obtained through
.Xr gitcredentials 7 .
.
.Sh EXAMPLES
.Bd -literal
notemap -a june@causal.agency note.txt
git config notemap.imapUser june@causal.agency
git notemap note.txt
.Ed
.
.Sh STANDARDS
.Bl -item
.It
.Rs
.%A N. Borenstein
.%A N. Freed
.%T MIME Part One: Format of Internet Message Bodies
.%I IETF
.%R RFC 2045
.%U https://tools.ietf.org/html/rfc2045
.%D November 1996
.Re
.It
.Rs
.%A M. Crispin
.%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1
.%I IETF
.%R RFC 3501
.%U https://tools.ietf.org/html/rfc3501
.%Q University of Washington
.%D March 2003
.Re
.It
.Rs
.%A L. Esibov
.%A A. Gulbrandsen
.%A P. Vixie
.%T A DNS RR for specifying the location of services (DNS SRV)
.%I IETF
.%R RFC 2782
.%U https://tools.ietf.org/html/rfc2782
.%D February 2000
.Re
.It
.Rs
.%A P. Leach
.%A M. Mealling
.%A R. Salz
.%T A Universally Unique IDentifier (UUID) URN Namespace
.%I IETF
.%R RFC 4122
.%U https://tools.ietf.org/html/rfc4122
.%D July 2005
.Re
.It
.Rs
.%A P. Mockapetris
.%T DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION
.%I IETF
.%R RFC 1035
.%U https://tools.ietf.org/html/rfc1035
.%D November 1987
.Re
.It
.Rs
.%A P. Resnick, Ed.
.%T Internet Message Format
.%I IETF
.%R RFC 5322
.%U https://tools.ietf.org/html/rfc5322
.%D October 2008
.Re
.El
.
.Sh AUTHORS
.An June McEnroe Aq Mt june@causal.agency
.
.Sh CAVEATS
Notes are assumed to be plain UTF-8 text
with LF line endings.
.
.Sh BUGS
Send mail to
.Aq Mt list+notemap@causal.agency
or join
.Li #ascii.town
on
.Li irc.tilde.chat .