diff options
author | June McEnroe <june@causal.agency> | 2019-01-25 04:06:31 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2019-01-25 04:06:31 -0500 |
commit | 920ea899d7535d8ad821837be8ca95f525a35eaa (patch) | |
tree | 5feef8ee9b811c23722acf49d4a107732d3a0fb9 | |
parent | Add Linux.mk (diff) | |
download | test-920ea899d7535d8ad821837be8ca95f525a35eaa.tar.gz test-920ea899d7535d8ad821837be8ca95f525a35eaa.zip |
Add GNU/Linux build instructions
-rw-r--r-- | README | 22 | ||||
-rw-r--r-- | catgirl.7 | 36 |
2 files changed, 43 insertions, 15 deletions
diff --git a/README b/README index 6a14ed2..5957c57 100644 --- a/README +++ b/README @@ -7,9 +7,10 @@ DESCRIPTION catgirl is a curses IRC client originally intended for use over anonymous SSH. - It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD. + It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD and + GNU/Linux. - Build +INSTALL On platforms other than FreeBSD, copy the appropriate file to config.mk and modify as needed. The default install PREFIX is ~/.local. @@ -17,6 +18,18 @@ DESCRIPTION make make install + Darwin + LibreSSL is assumed to be installed with brew(1). The sandman(1) wrapper + is also installed. + + NetBSD + LibreSSL is assumed to be installed with pkgsrc(7). Due to bugs in + NetBSD's curses(3) implementation, some of the UI is currently broken. + + GNU/Linux + LibreSSL is assumed to be manually installed in /usr/local and is + statically linked. + FILES chat.h shared state and function prototypes chat.c command line parsing @@ -40,7 +53,4 @@ FILES SEE ALSO catgirl(1), sandman(1) -BUGS - The UI is currently broken with NetBSD's curses implementation. - -Causal Agency December 2, 2018 Causal Agency +Causal Agency January 25, 2019 Causal Agency diff --git a/catgirl.7 b/catgirl.7 index 4151b80..638b3f2 100644 --- a/catgirl.7 +++ b/catgirl.7 @@ -1,4 +1,4 @@ -.Dd December 2, 2018 +.Dd January 25, 2019 .Dt CATGIRL 7 .Os "Causal Agency" . @@ -18,16 +18,18 @@ It requires LibreSSL and targets .Fx , Darwin, -.Nx . +.Nx +and +GNU/Linux. . -.Ss Build +.Sh INSTALL On platforms other than .Fx , copy the appropriate file to .Pa config.mk and modify as needed. The default install -.Ev PREFIX +.Va PREFIX is .Pa ~/.local . . @@ -38,6 +40,27 @@ make make install .Ed . +.Ss Darwin +LibreSSL is assumed to be installed with +.Xr brew 1 . +The +.Xr sandman 1 +wrapper is also installed. +. +.Ss NetBSD +LibreSSL is assumed to be installed with +.Xr pkgsrc 7 . +Due to bugs in +.Nx Ap s +.Xr curses 3 +implementation, +some of the UI is currently broken. +. +.Ss GNU/Linux +LibreSSL is assumed to be manually installed in +.Pa /usr/local +and is statically linked. +. .Sh FILES .Bl -tag -width sandman.m -compact .It Pa chat.h @@ -84,8 +107,3 @@ implementation for chroot .Sh SEE ALSO .Xr catgirl 1 , .Xr sandman 1 -. -.Sh BUGS -The UI is currently broken with -.Nx Ap s -curses implementation. |