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
Use LDADD variables, support BINDIRJune McEnroe Also change MANDIR default to ${PREFIX}/man. 2020-12-13Use nick for color if user is "*" 1.1June McEnroe Not accurate but better than all nicks being the same color in imported logs. 2020-08-23Use DESTDIR in install 1.0June McEnroe 2020-08-23Add catsit example to READMEJune McEnroe 2020-08-23Update litterbox version rangeJune McEnroe 2020-08-19Set a database busy timeoutJune McEnroe 2020-07-29Add Linux supportJune McEnroe Static linking on Linux (even with musl-gcc) is just too much of a pain. People more dedicated than I am can figure it out themselves. Or how to properly sandbox this without a chroot. 2020-07-29Remove unused prevEventJune McEnroe 2020-07-23Rewrite configure scriptJune McEnroe 2020-07-21Add OpenBSD instructionsJune McEnroe 2020-07-21Use a .pc file to configureJune McEnroe 2020-07-19Filter networks with only private contexts from recents as wellJune McEnroe 2020-07-18Specify litterbox version in readmeJune McEnroe 2020-07-18Reverse order of X macro parameters for pages and keysJune McEnroe 2020-07-18Remove kcgi 0.11 compatibilityJune McEnroe 2020-07-17Filter networks with only private contextsJune McEnroe 2020-07-17Add export optionJune McEnroe Adding the export query parameter to any page downloads a .html with the default stylesheet embedded, and all navigation, forms and internal links removed, for being able to share some part of a private instance of litterbox. 2020-07-17Add margin to inputsJune McEnroe Seems that only Safari provides any margins on form elements by default. 2020-07-16Don't write null terminator in stylesheet responseJune McEnroe 2020-07-16Remove sudo from make installJune McEnroe