From 216ae9a97134f2919091858076e2a6ef536acfe5 Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Thu, 13 Jun 2019 15:43:23 -0700 Subject: [PATCH] Added manpage --- conway.1 | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 conway.1 diff --git a/conway.1 b/conway.1 new file mode 100644 index 0000000..5e7b4c5 --- /dev/null +++ b/conway.1 @@ -0,0 +1,48 @@ +.\" Manpage for conway. +.\" Contact bruce@bruce-hill.com to correct errors or typos. +.TH man 8 "13 June 2019" "1.0" "conway manual page" +.SH NAME +conway \- A command line Conway's Game of Life simulator +.SH SYNOPSIS +.B conway +[\fI-B\fR birth rule] +[\fI-S\fR survival rule] +[\fI-A\fR alive color] +[\fI-D\fR dead color] +.SH DESCRIPTION +\fBconway\fR is yet another Conway's Game of Life simulator for the terminal, +written in pure C with no external libraries. + +.SH OPTIONS +.B \-B color +Set the birth rules for the simulation (default: "3") + +.B \-S color +Set the survival rules for the simulation (default: "23") + +.B \-A color +Set the hex RGB color of alive cells (3 or 6 hex digits). + +.B \-D color +Set the hex RGB color of dead cells (3 or 6 hex digits). + +.SH RULESETS +The default Conway's Game of Life ruleset is: a dead cell will come to life if +it has exactly 3 living neighbors, and a living cell will survive if it has 2 +or 3 living neighbors. This ruleset can be changed with the \fB-B\fR and +\fB-S\fR flags. See \fIhttp://psoup.math.wisc.edu/mcell/rullex_life.html\fR for +some interesting rulesets. + +.SH EXAMPLES +.TP +.B +conway -S 45678 -B 3 +A coral-like ruleset. + +.TP +.B +conway -A FB0 -D 226 +A yellow-on-blue color scheme. + +.SH AUTHOR +Bruce Hill (bruce@bruce-hill.com)