Rename catgirl.7 to README.7

master
C. McEnroe 2019-12-19 02:13:38 -05:00
parent d919d122fb
commit 2e61779082
No known key found for this signature in database
GPG Key ID: CEA2F97ADCFCD77C
3 changed files with 0 additions and 60 deletions

View File

@ -97,6 +97,3 @@ install-chroot: chroot.tar
clean: clean:
rm -fr ${BINS} ${OBJS} ${TESTS} tags root chroot.tar rm -fr ${BINS} ${OBJS} ${TESTS} tags root chroot.tar
README: catgirl.7
mandoc catgirl.7 | col -bx > README

57
README
View File

@ -1,57 +0,0 @@
CATGIRL(7) FreeBSD Miscellaneous Information Manual CATGIRL(7)
NAME
catgirl IRC client
DESCRIPTION
catgirl is a curses IRC client originally intended for use over anonymous
SSH.
It requires LibreSSL (-ltls) and targets FreeBSD, Darwin, NetBSD and
GNU/Linux.
INSTALL
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
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
event.c event loop and process spawning
tag.c tag (channel, query) ID assignment
handle.c incoming command handling
input.c input command handling
irc.c TLS client connection
format.c IRC formatting
color.c nick and channel coloring
ui.c cursed UI
term.c terminal features unsupported by curses
edit.c line editing
tab.c tab-complete
url.c URL detection
pls.c functions which should not have to be written
sandman.m utility for Darwin to signal sleep
sshd_config anonymous SSH configuration
man.sh man(1) implementation for chroot
SEE ALSO
catgirl(1), sandman(1)
Causal Agency February 25, 2019 Causal Agency

View File