Mention LibreTLS in install instructions

master
C. McEnroe 2020-08-04 14:38:23 -04:00
parent 814c36223a
commit 9bd001ad4f
1 changed files with 25 additions and 27 deletions

View File

@ -1,4 +1,4 @@
.Dd July 23, 2020 .Dd August 4, 2020
.Dt README 7 .Dt README 7
.Os "Causal Agency" .Os "Causal Agency"
.\" To view this file, run: man ./README.7 .\" To view this file, run: man ./README.7
@ -82,10 +82,12 @@ and certificates are easy to obtain.
. .
.Sh INSTALLING .Sh INSTALLING
.Nm .Nm
requires LibreSSL requires ncurses and
.Pq Fl ltls .Sy libtls ,
and ncurses provided by either
.Pq Fl lncursesw . .Lk https://git.causal.agency/libretls/about LibreTLS
(with OpenSSL)
or by LibreSSL.
It targets It targets
.Fx , .Fx ,
.Ox , .Ox ,
@ -102,34 +104,30 @@ sudo make install
.Ed .Ed
. .
.Pp .Pp
If your system installs LibreSSL If installing
in a non-standard path, set .Sy libtls
manually to
.Pa /usr/local ,
for example,
make sure
.Pa /usr/local/lib
appears in
.Pa /etc/ld.so.conf
or
.Pa /etc/ld.so.conf.d/*
and be sure to run
.Xr ldconfig 8
once the library is installed.
Set
.Ev PKG_CONFIG_PATH .Ev PKG_CONFIG_PATH
for for
.Nm ./configure . .Nm ./configure
For example, to find it.
.Bd -literal -offset indent .Bd -literal -offset indent
PKG_CONFIG_PATH=/opt/libressl/lib/pkgconfig ./configure PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure
.Ed .Ed
. .
.Pp .Pp
If your system is incapable of providing LibreSSL,
consider building it manually and installing to
.Pa /usr/local ,
adding
.Pa /usr/local/lib
to
.Pa /etc/ld.so.conf
and running
.Xr ldconfig 8
if needed.
It may also be necessary to create
.Pa /etc/ssl/cert.pem
as a symbolic link to
.Pa /etc/ssl/certs/ca-certificates.crt
or similar path.
.
.Pp
The The
.Nm sandman .Nm sandman
wrapper is provided for macOS wrapper is provided for macOS