diff options
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README | 49 | ||||
| -rw-r--r-- | chatte.7 | 63 |
3 files changed, 97 insertions, 18 deletions
diff --git a/Makefile b/Makefile index 938d874..ece6649 100644 --- a/Makefile +++ b/Makefile @@ -89,3 +89,6 @@ chroot.tar: chatte chatte.1 man.sh clean: rm -rf tags chatte $(OBJS) $(TESTS) root chroot.tar + +README: chatte.7 + mandoc chatte.7 | sed $$'s/.\b//g' > README diff --git a/README b/README index 8737aea..bc7d86c 100644 --- a/README +++ b/README @@ -1,21 +1,34 @@ -IRC client originally intended for use over anonymous SSH. +CHATTE(7) Miscellaneous Information Manual CHATTE(7) -This software requires LibreSSL and targets FreeBSD and Darwin. +NAME + chatte – IRC for catgirls - 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 Curses 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 +DESCRIPTION + chatte is a curses IRC client originally intended for use over anonymous + SSH. - sshd_config Sample anonymous SSH configuration - man.sh man(1) implementation for chroot + It requires LibreSSL and targets FreeBSD and Darwin. + +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 Curses 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 + + sshd_config Anonymous SSH configuration + man.sh man(1) implementation for chroot + +SEE ALSO + chatte(1) + +Causal Agency September 15, 2018 Causal Agency diff --git a/chatte.7 b/chatte.7 new file mode 100644 index 0000000..5d5b31c --- /dev/null +++ b/chatte.7 @@ -0,0 +1,63 @@ +.Dd September 15, 2018 +.Dt CHATTE 7 +.Os "Causal Agency" +. +.Sh NAME +.Nm chatte +.Nd IRC for catgirls +. +.Sh DESCRIPTION +.Nm +is a curses IRC client +originally intended for +use over anonymous SSH. +. +.Pp +It requires LibreSSL +and targets +.Fx +and Darwin. +. +.Sh FILES +.Bl -tag -width format.c -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 ui.c +Curses 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 +.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 chatte 1 |