about summary refs log tree commit diff
path: root/README
blob: 4b9f9132beb039cd20c856ca5998cb1ee5ac573d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.

   Build
     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

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
     ui.c       cursed UI
     term.c     terminal features unsupported by curses
     edit.c     line editing
     tab.c      tab-complete
     url.c      URL detection
     string.c   base64 and rot13
     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)

BUGS
     The UI is currently broken with NetBSD's curses implementation.

Causal Agency                  December 2, 2018                  Causal Agency