diff --git a/Makefile b/Makefile index e951588..4457f96 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,7 @@ LDFLAGS=-lreadline minitalk: minitalk.c minitalk.1: minitalk.1.md - pandoc -t man -o minitalk.1 minitalk.1.md + pandoc -s -t man -o minitalk.1 minitalk.1.md clean: rm -f minitalk diff --git a/minitalk.1 b/minitalk.1 index 49a7c4b..e8e6e88 100644 --- a/minitalk.1 +++ b/minitalk.1 @@ -1,4 +1,7 @@ -.TH "MINITALK" "1" "July 2016" "Minitalk 0.2.3" "" +.\" Automatically generated by Pandoc 1.17.2 +.\" +.TH "MINITALK" "1" "November 2016" "Minitalk User Manual" "Minitalk 0.2.3" +.hy .SH NAME .PP minitalk \- small, simple chat system @@ -6,13 +9,19 @@ minitalk \- small, simple chat system .PP minitalk FILE [NICK] .SH DESCRIPTION -.PP -FILE File to use as "room". +.TP +.B FILE +File to use as "room". Must have read/write permissions. -.PP -NICK Specify nick to use. +.RS +.RE +.TP +.B NICK +Specify nick to use. Default is current username. -.SH EXAMPLES +.RS +.RE +.SH EXAMPLE .PP Join a room controlled via /var/chat/general. .IP @@ -29,15 +38,21 @@ The same, but specifying the username "admin". $\ minitalk\ /var/chat/general\ admin \f[] .fi -.SH ISSUES +.SH NOTES .PP The primary issue is a security concern. -Anyone that needs to chat in the "room" 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 "control" 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. +Anyone that needs to chat in the "room" 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 "control" 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\[aq]t expect this to be secure. -.SH AUTHOR +.SH AUTHORS .PP -Written by Andrew Benson. +Andrew Benson. .SH COPYRIGHT .PP Copyright © 2016 Andrew Benson. diff --git a/minitalk.1.md b/minitalk.1.md new file mode 100644 index 0000000..fa76097 --- /dev/null +++ b/minitalk.1.md @@ -0,0 +1,44 @@ +% MINITALK(1) Minitalk User Manual | Minitalk 0.2.3 +% Andrew Benson +% November 2016 + +# NAME + +minitalk - small, simple chat system + +# SYNOPSIS + +minitalk FILE [NICK] + +# DESCRIPTION + +FILE + ~ File to use as "room". Must have read/write permissions. + +NICK + ~ Specify nick to use. Default is current username. + +# EXAMPLE + +Join a room controlled via /var/chat/general. + + $ minitalk /var/chat/general + +The same, but specifying the username "admin". + + $ minitalk /var/chat/general admin + +# NOTES + +The primary issue is a security concern. Anyone that needs to chat in the "room" 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 "control" 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. + +Don't expect this to be secure. + + +# AUTHORS + +Andrew Benson. + +# COPYRIGHT + +Copyright © 2016 Andrew Benson. License: MIT