minitalk.1

.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "MINITALK" "1" "May 2023" "Minitalk User Manual" "Minitalk 0.3.1"
.hy
.SH NAME
.PP
minitalk - small, simple chat system
.SH SYNOPSIS
.PP
minitalk FILE [NICK]
.SH DESCRIPTION
.TP
FILE
File to use as \[lq]room\[rq].
Must have read/write permissions.
.TP
NICK
Specify nick to use.
Default is current username.
Must be 1-15 characters in length, and must only contain numbers and
letters.
.SH EXAMPLE
.PP
Join a room controlled via /var/chat/general.
.IP
.nf
\f[C]
$ minitalk /var/chat/general
\f[R]
.fi
.PP
The same, but specifying the username \[lq]admin\[rq].
.IP
.nf
\f[C]
$ minitalk /var/chat/general admin
\f[R]
.fi
.SH NOTES
.PP
The primary issue is a security concern.
Anyone that needs to chat in the \[lq]room\[rq] has to be able to write
to the control file.
Anyone that needs read from the room needs read access.
Anyone that has access to these \[lq]control\[rq] files can also inject
anything they want into the chat.
This truly is built on the honor system, and was designed around a
single purpose: multi-user chat between trusted users on a single host.
.PP
Don\[cq]t expect this to be secure.
.SH AUTHORS
.PP
Andrew Benson.
.SH COPYRIGHT
.PP
Copyright \[co] 2023 Andrew Benson.
License: MIT
.SH AUTHORS
Andrew Benson.