summary refs log tree commit diff
path: root/README.7
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.7111
1 files changed, 0 insertions, 111 deletions
diff --git a/README.7 b/README.7
deleted file mode 100644
index cae56bb..0000000
--- a/README.7
+++ /dev/null
@@ -1,111 +0,0 @@
-.Dd February 25, 2019
-.Dt CATGIRL 7
-.Os "Causal Agency"
-.
-.Sh NAME
-.Nm catgirl
-.Nd IRC client
-.
-.Sh DESCRIPTION
-.Nm
-is a curses IRC client
-originally intended for
-use over anonymous SSH.
-.
-.Pp
-It requires LibreSSL
-.Pq Fl ltls
-and targets
-.Fx ,
-Darwin,
-.Nx
-and
-GNU/Linux.
-.
-.Sh INSTALL
-On platforms other than
-.Fx ,
-copy the appropriate file to
-.Pa config.mk
-and modify as needed.
-The default install
-.Va PREFIX
-is
-.Pa ~/.local .
-.
-.Pp
-.Bd -literal -offset indent
-cp $(uname).mk config.mk
-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
-shared state and function prototypes
-.It Pa chat.c
-command line parsing
-.It Pa event.c
-event loop and process spawning
-.It Pa tag.c
-tag (channel, query) ID assignment
-.It Pa handle.c
-incoming command handling
-.It Pa input.c
-input command handling
-.It Pa irc.c
-TLS client connection
-.It Pa format.c
-IRC formatting
-.It Pa color.c
-nick and channel coloring
-.It Pa ui.c
-cursed UI
-.It Pa term.c
-terminal features unsupported by curses
-.It Pa edit.c
-line editing
-.It Pa tab.c
-tab-complete
-.It Pa url.c
-URL detection
-.It Pa pls.c
-functions which should not have to be written
-.It Pa sandman.m
-utility for Darwin to signal sleep
-.El
-.
-.Pp
-.Bl -tag -width sshd_config -compact
-.It Pa sshd_config
-anonymous SSH configuration
-.It Pa man.sh
-.Xr man 1
-implementation for chroot
-.El
-.
-.Sh SEE ALSO
-.Xr catgirl 1 ,
-.Xr sandman 1