catgirl/README

57 lines
1.7 KiB
Plaintext
Raw Normal View History

2018-12-02 06:01:56 +00:00
CATGIRL(7) FreeBSD Miscellaneous Information Manual CATGIRL(7)
2018-08-04 22:00:54 +00:00
2018-09-16 02:22:51 +00:00
NAME
2018-12-02 06:01:56 +00:00
catgirl IRC client
2018-08-04 22:00:54 +00:00
2018-09-16 02:22:51 +00:00
DESCRIPTION
catgirl is a curses IRC client originally intended for use over anonymous
2018-09-16 02:22:51 +00:00
SSH.
2018-08-20 20:06:46 +00:00
2019-01-25 09:06:31 +00:00
It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD and
GNU/Linux.
2018-12-02 23:12:45 +00:00
2019-01-25 09:06:31 +00:00
INSTALL
2018-12-02 23:12:45 +00:00
On platforms other than FreeBSD, copy the appropriate file to config.mk
and modify as needed. The default install PREFIX is ~/.local.
cp $(uname).mk config.mk
make
make install
2018-09-16 02:22:51 +00:00
2019-01-25 09:06:31 +00:00
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.
2018-09-16 02:22:51 +00:00
FILES
2018-12-02 23:12:45 +00:00
chat.h shared state and function prototypes
chat.c command line parsing
event.c event loop and process spawning
tag.c tag (channel, query) ID assignment
handle.c incoming command handling
input.c input command handling
2018-12-02 06:01:56 +00:00
irc.c TLS client connection
format.c IRC formatting
2018-12-02 23:12:45 +00:00
ui.c cursed UI
term.c terminal features unsupported by curses
edit.c line editing
tab.c tab-complete
2018-12-02 06:01:56 +00:00
url.c URL detection
2018-12-02 23:12:45 +00:00
pls.c functions which should not have to be written
sandman.m utility for Darwin to signal sleep
2018-09-16 02:22:51 +00:00
2018-12-02 23:12:45 +00:00
sshd_config anonymous SSH configuration
2018-09-16 02:22:51 +00:00
man.sh man(1) implementation for chroot
SEE ALSO
2018-12-02 06:01:56 +00:00
catgirl(1), sandman(1)
2018-09-16 02:22:51 +00:00
2019-01-25 09:06:31 +00:00
Causal Agency January 25, 2019 Causal Agency