diff options
Diffstat (limited to 'notemap.1')
| -rw-r--r-- | notemap.1 | 157 |
1 files changed, 98 insertions, 59 deletions
diff --git a/notemap.1 b/notemap.1 index 5f28ca5..0ba9adc 100644 --- a/notemap.1 +++ b/notemap.1 @@ -1,9 +1,10 @@ -.Dd May 5, 2020 +.Dd December 16, 2020 .Dt NOTEMAP 1 .Os . .Sh NAME -.Nm notemap +.Nm notemap , +.Nm git-notemap .Nd mirror notes to IMAP . .Sh SYNOPSIS @@ -13,6 +14,16 @@ .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 . @@ -21,14 +32,27 @@ The .Nm utility mirrors text notes -to an IMAP mailbox. +to an IMAP mailbox +appropriate for display +by the Apple Notes application. Files are mapped to IMAP messages -using a map file. -If no files are given as arguments, +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 without STARTTLS is assumed. +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 @@ -36,6 +60,15 @@ or standard input if 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 @@ -43,86 +76,85 @@ Mirror notes to .Ar mailbox . The default is .Sy Notes . -. .It Fl a Add new notes to the map file. -. .It Fl f -Overwrite notes which have changed in the mailbox. -. +Overwrite modified notes in the mailbox. .It Fl h Ar host Connect to IMAP on .Ar host . -The default host is determined -by SRV record lookup on the domain of -.Ar user , -or simply the domain name -if no SRV record exists. -Lookup requires -.Xr dig 1 . -. .It Fl m Ar file -Set the location of the map file. +Set the path of the map file. The default is .Pa .notemap . -. .It Fl p Ar port Connect to IMAP on .Ar port . -If the -.Fl h -option is used, -the default port is -.Sy imaps -(993). -Otherwise, -the port is determined -in the same fashion as the host. -. -.It Fl u Ar user -Log in to IMAP as -.Ar user . -The IMAP connection information -is inferred from the username unless -.Fl h -is used. -. .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 -u june@causal.agency note.txt +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 -.%Q University of Washington .%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1 .%I IETF -.%N RFC 3501 -.%D March 2003 +.%R RFC 3501 .%U https://tools.ietf.org/html/rfc3501 +.%Q University of Washington +.%D March 2003 .Re -. .It .Rs -.%A N. Freed -.%A N. Borenstein -.%T MIME Part One: Format of Internet Message Bodies +.%A L. Esibov +.%A A. Gulbrandsen +.%A P. Vixie +.%T A DNS RR for specifying the location of services (DNS SRV) .%I IETF -.%N RFC 2045 -.%D November 1996 -.%U https://tools.ietf.org/html/rfc2045 +.%R RFC 2782 +.%U https://tools.ietf.org/html/rfc2782 +.%D February 2000 .Re -. .It .Rs .%A P. Leach @@ -130,25 +162,32 @@ notemap -a -u june@causal.agency note.txt .%A R. Salz .%T A Universally Unique IDentifier (UUID) URN Namespace .%I IETF -.%N RFC 4122 -.%D July 2005 +.%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. -.%Q Qualcomm Incorporated .%T Internet Message Format .%I IETF -.%N RFC 5322 -.%D October 2008 +.%R RFC 5322 .%U https://tools.ietf.org/html/rfc5322 +.%D October 2008 .Re .El . .Sh AUTHORS -.An June Bug Aq Mt june@causal.agency +.An June McEnroe Aq Mt june@causal.agency . .Sh CAVEATS Notes are assumed to be plain UTF-8 text @@ -160,4 +199,4 @@ Send mail to or join .Li #ascii.town on -.Li chat.freenode.net . +.Li irc.tilde.chat . |