Skip to content

Commit 864415d

Browse files
committed
Manual page rendered; installed.
1 parent 526f658 commit 864415d

File tree

3 files changed

+53
-8
lines changed

3 files changed

+53
-8
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ LDFLAGS=-lreadline
66

77
minitalk: minitalk.c
88

9+
minitalk.1: minitalk.1.md
10+
pandoc -t man -o minitalk.1 minitalk.1.md
11+
912
clean:
1013
rm -f minitalk
1114

1215
install: minitalk
1316
/usr/bin/install -t $(PREFIX)/bin minitalk
17+
/usr/bin/install -t $(PREFIX)/man/man1 minitalk.1

minitalk.1

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.TH "MINITALK" "1" "December 26, 2015" "Minitalk User Manual" ""
2+
.SH NAME
3+
.PP
4+
minitalk \- small, simple chat system
5+
.SH SYNOPSIS
6+
.PP
7+
minitalk FILE [NICK]
8+
.SH DESCRIPTION
9+
.PP
10+
FILE File to use as "room".
11+
Must have read/write permissions.
12+
NICK Specify nick to use.
13+
Default is current username.
14+
.SH EXAMPLES
15+
.PP
16+
Join a room controlled via /var/chat/general.
17+
.IP
18+
.nf
19+
\f[C]
20+
$\ minitalk\ /var/chat/general
21+
\f[]
22+
.fi
23+
.PP
24+
The same, but specifying the username "admin".
25+
.IP
26+
.nf
27+
\f[C]
28+
$\ minitalk\ /var/chat/general\ admin
29+
\f[]
30+
.fi
31+
.SH AUTHOR
32+
.PP
33+
Written by Andrew Benson.
34+
.SH COPYRIGHT
35+
.PP
36+
Copyright © 2015 Andrew Benson.
37+
License: MIT
38+
.SH AUTHORS
39+
Andrew Benson.

minitalk.1.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
# minitalk
1+
% MINITALK(1) Minitalk User Manual
2+
% Andrew Benson
3+
% December 26, 2015
24

3-
## NAME
5+
# NAME
46

57
minitalk - small, simple chat system
68

7-
## SYNOPSIS
9+
# SYNOPSIS
810

911
minitalk FILE [NICK]
1012

11-
## DESCRIPTION
13+
# DESCRIPTION
1214

1315
FILE File to use as "room". Must have read/write permissions.
1416
NICK Specify nick to use. Default is current username.
1517

16-
## EXAMPLES
18+
# EXAMPLES
1719

1820
Join a room controlled via /var/chat/general.
1921

@@ -23,10 +25,10 @@ The same, but specifying the username "admin".
2325

2426
$ minitalk /var/chat/general admin
2527

26-
## AUTHOR
28+
# AUTHOR
2729

28-
Written by Andrew Benson.
30+
Written by Andrew Benson.
2931

30-
## COPYRIGHT
32+
# COPYRIGHT
3133

3234
Copyright © 2015 Andrew Benson. License: MIT

0 commit comments

Comments
 (0)