From c49aff35e3e70dd960e4eab35f15113b34f2087d Mon Sep 17 00:00:00 2001
From: Drew DeVault <sir@cmpwn.com>
Date: Wed, 25 Nov 2020 12:22:22 -0500
Subject: [PATCH] Add man pages

---
 Makefile            | 10 +++++++++-
 doc/checkproof.scd  | 15 +++++++++++++++
 doc/mkchallenge.scd | 20 ++++++++++++++++++++
 doc/mkproof.scd     | 18 ++++++++++++++++++
 4 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 doc/checkproof.scd
 create mode 100644 doc/mkchallenge.scd
 create mode 100644 doc/mkproof.scd

diff --git a/Makefile b/Makefile
index 80e4bda..3617f3f 100644
--- a/Makefile
+++ b/Makefile
@@ -16,6 +16,10 @@ checkproof: $(checkproof_objects)
 	@printf 'CCLD\t$@\n'
 	@$(CC) $(LDFLAGS) -o $@ $(checkproof_objects)
 
+doc/mkchallenge.1: doc/mkchallenge.scd
+doc/mkproof.1: doc/mkproof.scd
+doc/checkproof.1: doc/checkproof.scd
+
 .SUFFIXES: .c .o .scd .1 .5
 
 .c.o:
@@ -25,7 +29,11 @@ checkproof: $(checkproof_objects)
 		$(CPP) $(CFLAGS) -MM -MT $@ $< >> $(OUTDIR)/cppcache
 	@$(CC) -c $(CFLAGS) -o $@ $<
 
-docs:
+.scd.1:
+	@printf 'SCDOC\t$@\n'
+	@$(SCDOC) < $< > $@
+
+docs: doc/mkchallenge.1 doc/mkproof.1 doc/checkproof.1
 
 clean:
 	@rm -f \
diff --git a/doc/checkproof.scd b/doc/checkproof.scd
new file mode 100644
index 0000000..b6f175f
--- /dev/null
+++ b/doc/checkproof.scd
@@ -0,0 +1,15 @@
+checkproof(1)
+
+# NAME
+
+*checkproof* - verify a proof-of-work challenge
+
+# SYNOPSIS
+
+*checkproof* _challenge_ _proof_
+
+# DESCRIPTION
+
+*checkproof* verifies a proof-of-work challenge which has been completed by
+*mkproof*(1). The result will be printed to stdout. If valid, *checkproof* will
+exit with a zero status code; if invalid, a nonzero status code.
diff --git a/doc/mkchallenge.scd b/doc/mkchallenge.scd
new file mode 100644
index 0000000..78cc354
--- /dev/null
+++ b/doc/mkchallenge.scd
@@ -0,0 +1,20 @@
+mkchallenge(1)
+
+# NAME
+
+*mkchallenge* - generate a proof-of-work challenge
+
+# SYNOPSIS
+
+*mkchallenge* [-d _difficulty_]
+
+# DESCRIPTION
+
+*mkchallenge* generates a proof-of-work challenge and prints it to stdout. To
+solve the challenge, see *mkproof*(1). To check the solution, see
+*checkproof*(1).
+
+# OPTIONS
+
+*-d* _difficulty_
+	Sets the challenge difficulty. The default is 4.
diff --git a/doc/mkproof.scd b/doc/mkproof.scd
new file mode 100644
index 0000000..83e03cb
--- /dev/null
+++ b/doc/mkproof.scd
@@ -0,0 +1,18 @@
+mkproof(1)
+
+# NAME
+
+*mkproof* - complete a proof-of-work challenge
+
+# SYNOPSIS
+
+*mkproof* _challenge_
+
+# DESCRIPTION
+
+*mkproof* completes a proof-of-work challenge prepared by *mkchallenge*(1). The
+proof will be printed to stdout once it is obtained, and may be passed to
+*checkproof*(1) for verification.
+
+This command is computationally expensive, and will likely pin a CPU core. See
+*nice*(1) to constrain its performance characteristics.