diff options
Diffstat (limited to 'README.7')
| -rw-r--r-- | README.7 | 97 |
1 files changed, 66 insertions, 31 deletions
diff --git a/README.7 b/README.7 index a67ec77..a26d270 100644 --- a/README.7 +++ b/README.7 @@ -1,7 +1,7 @@ -.Dd January 25, 2021 +.\" To view this file: $ man ./README.7 +.Dd July 9, 2023 .Dt README 7 .Os "Causal Agency" -.\" To view this file, run: man ./README.7 . .Sh NAME .Nm catgirl @@ -9,7 +9,15 @@ . .Sh DESCRIPTION .Xr catgirl 1 -is a TLS-only terminal IRC client. +is a terminal IRC client. +. +.Pp +Screenshot: +imagine, +if you will, +text on a screen, +next to names +in a selection of colours. . .Ss Notable Features .Bl -bullet @@ -17,7 +25,7 @@ is a TLS-only terminal IRC client. Tab complete: most recently seen or mentioned nicks are completed first. -Commas are inserted between multple nicks. +Commas are inserted between multiple nicks. .It Prompt: the prompt clearly shows whether input @@ -45,6 +53,17 @@ is highlighted. 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 @@ -98,32 +117,32 @@ provided by either .Lk https://git.causal.agency/libretls/about LibreTLS (for OpenSSL) or by LibreSSL. -. -.Pp It targets .Fx , .Ox , macOS and Linux. -On -.Ox , -.Xr pledge 2 -is used to limit system operations, -and with -.Nm Fl R , -.Xr unveil 2 -is used to limit filesystem access. -On BSD systems, -configure with -.Fl \-mandir=/usr/local/man . +.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 -sudo make install +$ ./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 @@ -144,7 +163,7 @@ for .Nm ./configure to find it. .Bd -literal -offset indent -PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure +$ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure .Ed . .Pp @@ -154,14 +173,14 @@ wrapper is provided for macOS to stop and start .Nm on system sleep and wake. -Install it as follows: +To enable it, +configure with: .Bd -literal -offset indent -make scripts/sandman -sudo make install-sandman +$ ./configure --enable-sandman .Ed . .Sh FILES -.Bl -tag -width "complete.c" -compact +.Bl -tag -width "command.c" -compact .It Pa chat.h global state and declarations .It Pa chat.c @@ -170,10 +189,14 @@ startup and event loop 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 -input command handling +command handling .It Pa buffer.c line wrapping .It Pa edit.c @@ -190,6 +213,8 @@ chat logging configuration parsing .It Pa xdg.c XDG base directories +.It Pa sandman.m +sleep/wake wrapper for macOS .El . .Pp @@ -199,11 +224,14 @@ 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 @@ -221,19 +249,26 @@ 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 +.Xr catgirl 1 , +.Xr sandman 1 . .Pp IRC bouncer: .Lk https://git.causal.agency/pounce "pounce" . .Rs -.%A June Bug +.%A June McEnroe .%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 +.\" To view this file: $ man ./README.7 |