Skip to content

Commit

Permalink
Fixed manual page generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
abenson committed Nov 23, 2016
1 parent 396bafb commit 8f44990
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
35 changes: 25 additions & 10 deletions minitalk.1
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
.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
.SH SYNOPSIS
.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
Expand All @@ -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.
Expand Down
44 changes: 44 additions & 0 deletions minitalk.1.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8f44990

Please sign in to comment.