Render README from chatte.7

master
Curtis McEnroe 2018-09-15 22:22:51 -04:00
parent 3e2a9c2056
commit f1cae5194c
No known key found for this signature in database
GPG Key ID: CEA2F97ADCFCD77C
3 changed files with 97 additions and 18 deletions

View File

@ -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

19
README
View File

@ -1,7 +1,15 @@
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
DESCRIPTION
chatte is a curses IRC client originally intended for use over anonymous
SSH.
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
@ -17,5 +25,10 @@ This software requires LibreSSL and targets FreeBSD and Darwin.
url.c URL detection
pls.c Functions which should not have to be written
sshd_config Sample anonymous SSH configuration
sshd_config Anonymous SSH configuration
man.sh man(1) implementation for chroot
SEE ALSO
chatte(1)
Causal Agency September 15, 2018 Causal Agency

63
chatte.7 100644
View File

@ -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