summary refs log tree commit diff
path: root/README
blob: 06da8dfbe7ee841e0bcb748c7a87825d279aebbe (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
48
49
50
51
52
53
54
55
56
57
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
5bb327f10617&follow=1'>Compare words without copying in filtersJune McEnroe 2019-11-10Separate tags from all targetJune McEnroe 2019-11-10Filter invite-notifyJune McEnroe 2019-11-10Add capsicum note to READMEJune McEnroe 2019-11-10Filter extended-joinJune McEnroe 2019-11-10Expand client configuration documentation and list capabilitiesJune McEnroe 2019-11-10Request all supported caps from serverJune McEnroe 2019-11-10Filter ACCOUNT, AWAY, CHGHOST for incapable clientsJune McEnroe 2019-11-10Rename listen to localJune McEnroe 2019-11-09Remove extended-join and invite-notifyJune McEnroe 2019-11-09Maintain stateCaps and offer them to clientsJune McEnroe 2019-11-09Parse capabilitiesJune McEnroe 2019-11-09Avoid the reserved _A names with BIT macroJune McEnroe 2019-11-09Define macro for bit flag enumsJune McEnroe 2019-11-08Check that password is hashedJune McEnroe 2019-11-08Avoid calling getopt_long again after it returns -1June McEnroe 2019-11-08Only change AWAY status for registered clientsJune McEnroe 2019-11-07Just write the example normallyJune McEnroe 2019-11-07Include path in readlinkat errorJune McEnroe 2019-11-07Call clientConsume before clientRecvJune McEnroe 2019-11-06Use -l:filename in Linux.mkJune McEnroe 2019-11-06Fix compat.h for #defined strlcpyJune McEnroe 2019-11-06Allow unsetting LIBRESSL_PREFIXJune McEnroe 2019-11-06Document calico service configurationJune McEnroe 2019-11-06Document SASL EXTERNAL configuration in more detailJune McEnroe 2019-11-06Document pounce service configurationJune McEnroe 2019-11-06Mention Darwin and GNU/Linux in READMEJune McEnroe 2019-11-06Assume LibreSSL from brew on DarwinJune McEnroe 2019-11-06Remove -DNO_EXPLICIT_BZERO from Darwin.mkJune McEnroe 2019-11-06Don't install rc scripts or dirs on LinuxJune McEnroe