summary refs log tree commit diff
path: root/README.7
blob: 3c62bc5ac2fd09261dba5022d6dab45b99b78d72 (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
.Dd October 28, 2020
.Dt README 7
.Os "Causal Agency"
.
.Sh NAME
.Nm notemap
.Nd mirror notes to IMAP
.
.Sh DESCRIPTION
.Xr notemap 1
mirrors text files to an IMAP mailbox
in a format compatible with the iOS Notes app.
It's intended to make notes managed in
.Xr git 1
easily accessible from the phone.
.
.Pp
.Nm
requires
.Sy libtls ,
provided by either
.Lk https://git.causal.agency/libretls/about LibreTLS
(for OpenSSL)
or by LibreSSL.
On systems other than
.Fx ,
.Xr dig 1
is required for
automatic IMAP server configuration.
.
.Bd -literal -offsent indent
\&./configure
make
sudo make install
.Ed
.
.Sh CONTRIBUTING
The upstream URL of this project is
.Aq Lk https://git.causal.agency/notemap .
Contributions in any form can be sent to
.Aq Mt list+notemap@causal.agency .
For sending patches by email, see
.Aq Lk https://git-send-email.io .
.
.Sh SEE ALSO
.Xr notemap 1