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
0e87e62c9568265291484&follow=1'>Only add available commands to completeJune McEnroe 2022-02-26Factor out commandAvailableJune McEnroe 2022-02-23Give examples of "general events" 2.1June McEnroe 2022-02-23Add missing unistd.h include in input.cJune McEnroe 2022-02-22Document the interfaceJune McEnroe 2022-02-20Clean up unimplemented editing mode stuffJune McEnroe 2022-02-20Save input buffer contentsJune McEnroe 2022-02-20Share a cut buffer between all edit buffersJune McEnroe 2022-02-20Assert return values in edit testsJune McEnroe 2022-02-20Move mbs out of struct Edit, use a global bufferJune McEnroe 2022-02-20Clear edit buffer before running commandJune McEnroe 2022-02-20Show indicator in status when window has pending inputJune McEnroe 2022-02-20Use separate edit buffers for each IDJune McEnroe 2022-02-20Make sure new cap is actually larger than new lengthJune McEnroe 2022-02-20Remove unused mbs.len field from struct EditJune McEnroe 2022-02-19Remove unneeded includes in ui.cJune McEnroe 2022-02-19Reimplement tab completeJune McEnroe 2022-02-19Handle errors from editFn, etc.June McEnroe 2022-02-19Reimplement text macrosJune McEnroe 2022-02-19Factor out input handling to input.cJune McEnroe 2022-02-19Factor out window management to window.cJune McEnroe 2022-02-19Enable -Wmissing-prototypesJune McEnroe 2022-02-19Fix edit.[ch] license notice additional permissionsJune McEnroe 2022-02-19Run line editing testsJune McEnroe 2022-02-18Implement new line editing "library"June McEnroe 2022-02-18Simplify cursor positioning in inputJune McEnroe 2022-02-18Fix M-f orderingJune McEnroe 2022-02-12Move sandman build to scripts/MakefileJune McEnroe 2022-02-12Use compat_readpassphrase.c on LinuxJune McEnroe 2022-02-12Copy RPP defines from oconfigureJune McEnroe