summary refs log tree commit diff
path: root/README
blob: 5957c57024836824fb9101b297a0f55291c6e215 (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
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
     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                  January 25, 2019                  Causal Agency
itle='2018-09-14 14:57:32 -0400'>2018-09-14Add tests for formatParseJune McEnroe With one currently failing so you know they're worth it. 2018-09-13Preview with nick in input windowJune McEnroe 2018-09-13Never send PRIVMSG to TagStatus or TagVerboseJune McEnroe 2018-09-13Move color selection to format.cJune McEnroe 2018-09-13Fix len for format->split at end of stringJune McEnroe 2018-09-13Avoid uninitialized x in uiReadJune McEnroe 2018-09-13Add IRCDefault to colors enumJune McEnroe 2018-09-13Return a format->split even at the end of the stringJune McEnroe 2018-09-13Fix weird tab-complete after commaJune McEnroe I have no idea why I did this. 2018-09-13Rewrite UI againJune McEnroe The persistent topic is gone and the status line is now at the top. The status formatting still needs to be reworked. I also want to try showing the nick in the input window so it really looks like your next message. 2018-09-12Add note about C-oJune McEnroe Why are there so few well usable ctrl key bindings? 2018-09-12Use formatParse split to position input cursorJune McEnroe 2018-09-12Factor out IRC formatting parsingJune McEnroe 2018-09-11Add /help equivalent to /manJune McEnroe 2018-09-11Don't render every PM as a pingJune McEnroe 2018-09-11Add urlOpenMatchJune McEnroe 2018-09-10Depend on man.sh for chroot.tar targetJune McEnroe 2018-09-10Set LESSSECURE=1 in man.shJune McEnroe Ridiculous. 2018-09-10Add /man commandJune McEnroe 2018-09-10Install man page in chrootJune McEnroe 2018-09-10Install man pageJune McEnroe 2018-09-10Split keys into subsections and document colorsJune McEnroe 2018-09-10Add "blank" lines to chatte.1June McEnroe 2018-09-10Document key bindings in chatte.1June McEnroe 2018-09-08Document slash commands in chatte.1June McEnroe