about summary refs log tree commit diff
path: root/notemap.1
blob: 56871e6f6df6018fde02bef330f617221e32d214 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
.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 Bug 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 .