catboy/README.7

112 lines
1.7 KiB
Groff
Raw Normal View History

2019-02-26 04:10:40 +00:00
.Dd February 25, 2019
.Dt CATGIRL 7
2018-09-16 02:22:51 +00:00
.Os "Causal Agency"
.
.Sh NAME
.Nm catgirl
.Nd IRC client
2018-09-16 02:22:51 +00:00
.
.Sh DESCRIPTION
.Nm
is a curses IRC client
originally intended for
use over anonymous SSH.
.
.Pp
It requires LibreSSL
2018-12-02 23:12:45 +00:00
.Pq Fl ltls
2018-09-16 02:22:51 +00:00
and targets
2018-11-29 04:29:19 +00:00
.Fx ,
2018-12-02 23:12:45 +00:00
Darwin,
2019-01-25 09:06:31 +00:00
.Nx
and
GNU/Linux.
2018-12-02 23:12:45 +00:00
.
2019-01-25 09:06:31 +00:00
.Sh INSTALL
2018-12-02 23:12:45 +00:00
On platforms other than
.Fx ,
copy the appropriate file to
.Pa config.mk
and modify as needed.
The default install
2019-01-25 09:06:31 +00:00
.Va PREFIX
2018-12-02 23:12:45 +00:00
is
.Pa ~/.local .
.
.Pp
.Bd -literal -offset indent
cp $(uname).mk config.mk
make
make install
.Ed
2018-09-16 02:22:51 +00:00
.
2019-01-25 09:06:31 +00:00
.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.
.
2018-09-16 02:22:51 +00:00
.Sh FILES
2018-12-02 06:01:56 +00:00
.Bl -tag -width sandman.m -compact
2018-09-16 02:22:51 +00:00
.It Pa chat.h
2018-12-02 23:12:45 +00:00
shared state and function prototypes
2018-09-16 02:22:51 +00:00
.It Pa chat.c
2018-12-02 23:12:45 +00:00
command line parsing
2018-09-16 02:22:51 +00:00
.It Pa event.c
2018-12-02 23:12:45 +00:00
event loop and process spawning
2018-09-16 02:22:51 +00:00
.It Pa tag.c
2018-12-02 23:12:45 +00:00
tag (channel, query) ID assignment
2018-09-16 02:22:51 +00:00
.It Pa handle.c
2018-12-02 23:12:45 +00:00
incoming command handling
2018-09-16 02:22:51 +00:00
.It Pa input.c
2018-12-02 23:12:45 +00:00
input command handling
2018-09-16 02:22:51 +00:00
.It Pa irc.c
TLS client connection
.It Pa format.c
IRC formatting
2019-02-26 04:10:40 +00:00
.It Pa color.c
nick and channel coloring
2018-09-16 02:22:51 +00:00
.It Pa ui.c
2018-12-02 23:12:45 +00:00
cursed UI
2018-09-16 02:22:51 +00:00
.It Pa term.c
2018-12-02 23:12:45 +00:00
terminal features unsupported by curses
2018-09-16 02:22:51 +00:00
.It Pa edit.c
2018-12-02 23:12:45 +00:00
line editing
2018-09-16 02:22:51 +00:00
.It Pa tab.c
2018-12-02 23:12:45 +00:00
tab-complete
2018-09-16 02:22:51 +00:00
.It Pa url.c
URL detection
.It Pa pls.c
2018-12-02 23:12:45 +00:00
functions which should not have to be written
2018-12-02 06:01:56 +00:00
.It Pa sandman.m
2018-12-02 23:12:45 +00:00
utility for Darwin to signal sleep
2018-09-16 02:22:51 +00:00
.El
.
.Pp
.Bl -tag -width sshd_config -compact
.It Pa sshd_config
2018-12-02 23:12:45 +00:00
anonymous SSH configuration
2018-09-16 02:22:51 +00:00
.It Pa man.sh
.Xr man 1
implementation for chroot
.El
.
.Sh SEE ALSO
2018-12-02 06:01:56 +00:00
.Xr catgirl 1 ,
.Xr sandman 1