notemap.1


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

.Dd May  5, 2020
.Dt NOTEMAP 1
.Os
.
.Sh NAME
.Nm 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
.Op Fl u Ar user
.Op Ar
.
.Sh DESCRIPTION
The
.Nm
utility
mirrors text notes
to an IMAP mailbox.
Files are mapped to IMAP messages
using a map file.
If no files are given as arguments,
all mapped files are mirrored.
.
.Pp
IMAP over TLS without STARTTLS is assumed.
The password is read from
.Pa /dev/tty ,
or standard input if
.Fl w
is used.
.
.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 notes which have changed 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.
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
.
.Sh EXAMPLES
.Bd -literal
notemap -a -u june@causal.agency note.txt
.Ed
.
.Sh STANDARDS
.Bl -item
.It
.Rs
.%A M. Crispin
.%Q University of Washington
.%T INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1
.%I IETF
.%N RFC 3501
.%D March 2003
.%U https://tools.ietf.org/html/rfc3501
.Re
.
.It
.Rs
.%A N. Freed
.%A N. Borenstein
.%T MIME Part One: Format of Internet Message Bodies
.%I IETF
.%N RFC 2045
.%D November 1996
.%U https://tools.ietf.org/html/rfc2045
.Re
.
.It
.Rs
.%A P. Leach
.%A M. Mealling
.%A R. Salz
.%T A Universally Unique IDentifier (UUID) URN Namespace
.%I IETF
.%N RFC 4122
.%D July 2005
.%U https://tools.ietf.org/html/rfc4122
.Re
.
.It
.Rs
.%A P. Resnick, Ed.
.%Q Qualcomm Incorporated
.%T Internet Message Format
.%I IETF
.%N RFC 5322
.%D October 2008
.%U https://tools.ietf.org/html/rfc5322
.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 chat.freenode.net .