Browse Source

Add GNU/Linux build instructions

master
Causal Agent 7 months ago
parent
commit
920ea899d7
Signed by: Curtis McEnroe <june@causal.agency> GPG Key ID: CEA2F97ADCFCD77C
2 changed files with 43 additions and 15 deletions
  1. 16
    6
      README
  2. 27
    9
      catgirl.7

+ 16
- 6
README View File

@@ -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

+ 27
- 9
catgirl.7 View File

@@ -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.

Loading…
Cancel
Save