From 2e61779082e70848fb34c04f7f5df77e500bd7e0 Mon Sep 17 00:00:00 2001 From: "C. McEnroe" Date: Thu, 19 Dec 2019 02:13:38 -0500 Subject: Rename catgirl.7 to README.7 --- Makefile | 3 -- README | 57 -------------------------------- README.7 | 111 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ catgirl.7 | 111 -------------------------------------------------------------- 4 files changed, 111 insertions(+), 171 deletions(-) delete mode 100644 README create mode 100644 README.7 delete mode 100644 catgirl.7 diff --git a/Makefile b/Makefile index 66b7600..8519d59 100644 --- a/Makefile +++ b/Makefile @@ -97,6 +97,3 @@ install-chroot: chroot.tar clean: rm -fr ${BINS} ${OBJS} ${TESTS} tags root chroot.tar - -README: catgirl.7 - mandoc catgirl.7 | col -bx > README diff --git a/README b/README deleted file mode 100644 index 06da8df..0000000 --- a/README +++ /dev/null @@ -1,57 +0,0 @@ -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 diff --git a/README.7 b/README.7 new file mode 100644 index 0000000..cae56bb --- /dev/null +++ b/README.7 @@ -0,0 +1,111 @@ +.Dd February 25, 2019 +.Dt CATGIRL 7 +.Os "Causal Agency" +. +.Sh NAME +.Nm catgirl +.Nd IRC client +. +.Sh DESCRIPTION +.Nm +is a curses IRC client +originally intended for +use over anonymous SSH. +. +.Pp +It requires LibreSSL +.Pq Fl ltls +and targets +.Fx , +Darwin, +.Nx +and +GNU/Linux. +. +.Sh INSTALL +On platforms other than +.Fx , +copy the appropriate file to +.Pa config.mk +and modify as needed. +The default install +.Va PREFIX +is +.Pa ~/.local . +. +.Pp +.Bd -literal -offset indent +cp $(uname).mk config.mk +make +make install +.Ed +. +.Ss Darwin +LibreSSL is assumed to be installed with +.Xr brew 1 . +The +.Xr sandman 1 +wrapper is also installed. +. +.Ss NetBSD +LibreSSL is assumed to be installed with +.Xr pkgsrc 7 . +Due to bugs in +.Nx Ap s +.Xr curses 3 +implementation, +some of the UI is currently broken. +. +.Ss GNU/Linux +LibreSSL is assumed to be manually installed in +.Pa /usr/local +and is statically linked. +. +.Sh FILES +.Bl -tag -width sandman.m -compact +.It Pa chat.h +shared state and function prototypes +.It Pa chat.c +command line parsing +.It Pa event.c +event loop and process spawning +.It Pa tag.c +tag (channel, query) ID assignment +.It Pa handle.c +incoming command handling +.It Pa input.c +input command handling +.It Pa irc.c +TLS client connection +.It Pa format.c +IRC formatting +.It Pa color.c +nick and channel coloring +.It Pa ui.c +cursed UI +.It Pa term.c +terminal features unsupported by curses +.It Pa edit.c +line editing +.It Pa tab.c +tab-complete +.It Pa url.c +URL detection +.It Pa pls.c +functions which should not have to be written +.It Pa sandman.m +utility for Darwin to signal sleep +.El +. +.Pp +.Bl -tag -width sshd_config -compact +.It Pa sshd_config +anonymous SSH configuration +.It Pa man.sh +.Xr man 1 +implementation for chroot +.El +. +.Sh SEE ALSO +.Xr catgirl 1 , +.Xr sandman 1 diff --git a/catgirl.7 b/catgirl.7 deleted file mode 100644 index cae56bb..0000000 --- a/catgirl.7 +++ /dev/null @@ -1,111 +0,0 @@ -.Dd February 25, 2019 -.Dt CATGIRL 7 -.Os "Causal Agency" -. -.Sh NAME -.Nm catgirl -.Nd IRC client -. -.Sh DESCRIPTION -.Nm -is a curses IRC client -originally intended for -use over anonymous SSH. -. -.Pp -It requires LibreSSL -.Pq Fl ltls -and targets -.Fx , -Darwin, -.Nx -and -GNU/Linux. -. -.Sh INSTALL -On platforms other than -.Fx , -copy the appropriate file to -.Pa config.mk -and modify as needed. -The default install -.Va PREFIX -is -.Pa ~/.local . -. -.Pp -.Bd -literal -offset indent -cp $(uname).mk config.mk -make -make install -.Ed -. -.Ss Darwin -LibreSSL is assumed to be installed with -.Xr brew 1 . -The -.Xr sandman 1 -wrapper is also installed. -. -.Ss NetBSD -LibreSSL is assumed to be installed with -.Xr pkgsrc 7 . -Due to bugs in -.Nx Ap s -.Xr curses 3 -implementation, -some of the UI is currently broken. -. -.Ss GNU/Linux -LibreSSL is assumed to be manually installed in -.Pa /usr/local -and is statically linked. -. -.Sh FILES -.Bl -tag -width sandman.m -compact -.It Pa chat.h -shared state and function prototypes -.It Pa chat.c -command line parsing -.It Pa event.c -event loop and process spawning -.It Pa tag.c -tag (channel, query) ID assignment -.It Pa handle.c -incoming command handling -.It Pa input.c -input command handling -.It Pa irc.c -TLS client connection -.It Pa format.c -IRC formatting -.It Pa color.c -nick and channel coloring -.It Pa ui.c -cursed UI -.It Pa term.c -terminal features unsupported by curses -.It Pa edit.c -line editing -.It Pa tab.c -tab-complete -.It Pa url.c -URL detection -.It Pa pls.c -functions which should not have to be written -.It Pa sandman.m -utility for Darwin to signal sleep -.El -. -.Pp -.Bl -tag -width sshd_config -compact -.It Pa sshd_config -anonymous SSH configuration -.It Pa man.sh -.Xr man 1 -implementation for chroot -.El -. -.Sh SEE ALSO -.Xr catgirl 1 , -.Xr sandman 1 -- cgit 1.4.1