Go to file
June McEnroe e39bba1a8a Move mbs out of struct Edit, use a global buffer
This saves 4K in the edit buffers, not to mention all the heap
allocations for the separate mbs buffers!

There might be a way to be more clever about capacities, but I don't
think it's worth it.
2022-02-20 15:42:24 -05:00
scripts Move sandman build to scripts/Makefile 2022-02-12 20:19:18 -05:00
.gitignore Run line editing tests 2022-02-19 00:01:34 -05:00
LICENSE Add copy of GPL 2020-02-09 15:25:28 -05:00
Makefile Factor out input handling to input.c 2022-02-19 20:20:19 -05:00
README.7 Reimplement text macros 2022-02-19 20:38:12 -05:00
buffer.c Replace catf with seprintf 2021-06-09 11:56:35 -04:00
catgirl.1 Prompt for empty server or SASL passwords 2022-02-12 13:26:38 -05:00
chat.c Reimplement text macros 2022-02-19 20:38:12 -05:00
chat.h Show indicator in status when window has pending input 2022-02-20 14:49:17 -05:00
command.c Factor out window management to window.c 2022-02-19 18:28:45 -05:00
compat_readpassphrase.c Copy RPP defines from oconfigure 2022-02-12 13:36:24 -05:00
complete.c Match window substrings case-sensitively 2021-06-17 19:07:56 -04:00
config.c Allow interspersing flags and config files 2021-01-10 13:49:57 -05:00
configure Use compat_readpassphrase.c on Linux 2022-02-12 13:36:24 -05:00
edit.c Move mbs out of struct Edit, use a global buffer 2022-02-20 15:42:24 -05:00
edit.h Move mbs out of struct Edit, use a global buffer 2022-02-20 15:42:24 -05:00
filter.c Ignore messages in reply to previously ignored messages 2021-05-04 15:34:27 -04:00
handle.c Factor out input handling to input.c 2022-02-19 20:20:19 -05:00
input.c Move mbs out of struct Edit, use a global buffer 2022-02-20 15:42:24 -05:00
irc.c Import refactored xdg.c from pounce 2021-10-16 17:03:31 -04:00
log.c Import refactored xdg.c from pounce 2021-10-16 17:03:31 -04:00
ui.c Remove unneeded includes in ui.c 2022-02-19 23:25:36 -05:00
url.c /exec without controlling terminal 2021-06-13 16:46:34 -04:00
window.c Show indicator in status when window has pending input 2022-02-20 14:49:17 -05:00
xdg.c Import refactored xdg.c from pounce 2021-10-16 17:03:31 -04:00

README.7

.\" To view this file, run: man ./README.7
.Dd February 19, 2022
.Dt README 7
.Os "Causal Agency"
.
.Sh NAME
.Nm catgirl
.Nd IRC client
.
.Sh DESCRIPTION
.Xr catgirl 1
is a TLS-only terminal IRC client.
.
.Ss Notable Features
.Bl -bullet
.It
Tab complete:
most recently seen or mentioned nicks
are completed first.
Commas are inserted between multiple nicks.
.It
Prompt:
the prompt clearly shows whether input
will be interpreted as a command
or sent as a message.
.It
Split scroll:
keeps the latest messages in view while scrolling.
.It
URL detection:
recent URLs from a particular user
or matching a substring
can be opened or copied.
.It
Nick coloring:
color generation based on usernames
remains stable across nick changes.
Mentions of users in messages are colored.
.It
Topic diffing:
the modified portion
of a channel topic change
is highlighted.
.It
Ignore:
visibility of filtered messages
can be toggled.
.It
Security:
on
.Fx
and
.Ox ,
the
.Cm restrict
option enables tight sandboxing.
Sandboxing is always used on
.Ox .
.El
.
.Ss Non-features
.Bl -bullet
.It
Dynamic configuration:
all configuration happens
in a simple text file
or on the command line.
.It
Multi-network:
a terminal multiplexer such as
.Xr screen 1
or
.Xr tmux 1
(or just your regular terminal emulator tabs)
can be used to connect
.Nm
to multiple networks.
.It
Reconnection:
when the connection to the server is lost,
.Nm
exits.
It can be run in a loop
or connected to a bouncer,
such as
.Lk https://git.causal.agency/pounce "pounce" .
.It
CTCP:
apart from
.Sy ACTION ,
this protocol is useless at best
and enables abuse at worst.
.It
Protocol coverage:
IRCv3 extensions are implemented only
where they contribute to
the intended user experience.
.It
Cleartext IRC:
TLS is now ubiquitous
and certificates are easy to obtain.
.El
.
.Sh INSTALLING
.Nm
requires ncurses and
.Sy libtls ,
provided by either
.Lk https://git.causal.agency/libretls/about LibreTLS
(for OpenSSL)
or by LibreSSL.
It targets
.Fx ,
.Ox ,
macOS
and Linux.
.Nm
and
.Sy libtls
may be packaged for your system.
Check the Repology pages for
.Lk https://repology.org/project/catgirl/versions catgirl
and
.Lk https://repology.org/project/libretls/versions libretls .
.
.Bd -literal -offset indent
$ ./configure
$ make all
# make install
.Ed
.
.Pp
Packagers are encouraged
to patch in their own text macros in
.Pa input.c .
.
.Pp
If installing
.Sy libtls
manually to
.Pa /usr/local ,
for example,
make sure
.Pa /usr/local/lib
appears in
.Pa /etc/ld.so.conf
or
.Pa /etc/ld.so.conf.d/*
and be sure to run
.Xr ldconfig 8
once the library is installed.
Set
.Ev PKG_CONFIG_PATH
for
.Nm ./configure
to find it.
.Bd -literal -offset indent
$ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure
.Ed
.
.Pp
The
.Nm sandman
wrapper is provided for macOS
to stop and start
.Nm
on system sleep and wake.
Install it as follows:
.Bd -literal -offset indent
$ make -C scripts sandman
# make -C scripts install
.Ed
.
.Sh FILES
.Bl -tag -width "complete.c" -compact
.It Pa chat.h
global state and declarations
.It Pa chat.c
startup and event loop
.It Pa irc.c
IRC connection and parsing
.It Pa ui.c
curses interface
.It Pa window.c
window management
.It Pa input.c
input handling
.It Pa handle.c
IRC message handling
.It Pa command.c
command handling
.It Pa buffer.c
line wrapping
.It Pa edit.c
line editing
.It Pa complete.c
tab complete
.It Pa url.c
URL detection
.It Pa filter.c
message filtering
.It Pa log.c
chat logging
.It Pa config.c
configuration parsing
.It Pa xdg.c
XDG base directories
.El
.
.Pp
.Bl -tag -width "scripts/notify-send.scpt" -compact
.It Pa scripts/chat.tmux.conf
example
.Xr tmux 1
configuration for multiple networks
and automatic reconnects
.It Pa scripts/sandman.m
sleep/wake wrapper for macOS
.It Pa scripts/notify-send.scpt
.Xr notify-send 1
in AppleScript
.It Pa scripts/build-chroot.sh
chroot builder for
.Ox
and
.Fx
.It Pa scripts/chroot-prompt.sh
name prompt wrapper for chroot
.It Pa scripts/chroot-man.sh
.Xr man 1
implementation for chroot
.It Pa scripts/sshd_config
.Xr sshd 8
configuration for public chroot
.El
.
.Sh CONTRIBUTING
The upstream URL of this project is
.Aq Lk https://git.causal.agency/catgirl .
Contributions in any form can be sent to
.Aq Mt list+catgirl@causal.agency .
For sending patches by email, see
.Aq Lk https://git-send-email.io .
Mailing list archives are available at
.Aq Lk https://causal.agency/list/catgirl.html .
.
.Pp
Monetary contributions can be
.Lk https://liberapay.com/june/donate "donated via Liberapay" .
.
.Sh SEE ALSO
.Xr catgirl 1
.
.Pp
IRC bouncer:
.Lk https://git.causal.agency/pounce "pounce"
.
.Rs
.%A June Bug
.%T IRC Suite
.%U https://text.causal.agency/010-irc-suite.txt
.%D June 19, 2020
.Re
.
.\" To view this file, run: man ./README.7