mandoc

8 files changed, 464 insertions, 3 deletions

diff --git a/docs/appsluggr.1.md b/docs/appsluggr.1.md
new file mode 100644
index 0000000..8e59e93
--- /dev/null
+++ b/docs/appsluggr.1.md
@@ -0,0 +1,103 @@
+APPSLUGGR(1) - General Commands Manual (urm)
+
+# NAME
+
+**appsluggr** - appsluggr packages a precompiled binary application as a Heroku style slug for use with Dokku.
+
+# SYNOPSIS
+
+**appsluggr**
+
+\[**-fname**]
+\[**-license**]
+\[**-web**]
+\[**-web-scale**]
+\[**-worker**]
+\[**-worker-scale**]
+
+# DESCRIPTION
+
+**appsluggr**
+is a small tool to package
+`GOOS=linux GOARCH=amd64`
+binaries for consumption on
+`hyperlink: http://dokku.viewdocs.io/dokku/ Dokku`
+
+**-fname**
+
+> The filename to write the resulting slug to.
+
+> The default value for this is
+> `slug.tar.gz`
+
+**-license**
+
+> If set, the tool will show its software license details and then exit.
+
+**-web**
+
+> The path to the binary for the web process.
+
+> One of
+> **-web**
+> or
+> **-worker**
+> must be set.
+
+**-web-scale**
+
+> The default scale for web process if defined.
+
+> The default value for this is 1.
+
+**-worker**
+
+> The path to the binary for the worker process.
+> One of
+> **-web**
+> or
+> **-worker**
+> must be set.
+
+**-worker-scale**
+
+> The default scale for the worker process if defined.
+
+> The default value for this is 1
+
+# EXAMPLES
+
+`appsluggr`
+
+`appsluggr -web web`
+
+`appsluggr -worker ilo-sona`
+
+`appsluggr -fname foo.tar.gz -web web -worker worker -web-scale 4 -worker-scale 16`
+
+# IMPLEMENTATION NOTES
+
+**appsluggr**
+when used with
+[http://dokku.viewdocs.io/dokku/ Dokku](hyperlink:)
+requires the use of the
+[https://github.com/ryandotsmith/null-buildpack Null Buildpack](hyperlink:)
+as follows:
+
+`$ dokku config:set $APP_NAME BUILDPACK_URL=https://github.com/ryandotsmith/null-buildpack`
+
+Or
+
+`$ ssh dokku@host config:set <see above>`
+
+# DIAGNOSTICS
+
+The **appsluggr** utility exits&#160;0 on success, and&#160;&gt;0 if an error occurs.
+
+# SEE ALSO
+
+*	[http://dokku.viewdocs.io/dokku/ Dokku](hyperlink:)
+
+*	[https://github.com/ryandotsmith/null-buildpack Null Buildpack](hyperlink:)
+
+ \- December 9, 2018
diff --git a/docs/cadeybot.1.md b/docs/cadeybot.1.md
new file mode 100644
index 0000000..7bf161a
--- /dev/null
+++ b/docs/cadeybot.1.md
@@ -0,0 +1,51 @@
+CADEYBOT(1) - General Commands Manual (urm)
+
+# NAME
+
+**cadeybot** - Markov bot based on my discord GDPR dump.
+
+# SYNOPSIS
+
+**cadeybot**
+\[**-token**&nbsp;*TOKEN*]
+\[**-brain**&nbsp;*BRAIN*]
+
+# DESCRIPTION
+
+**cadeybot**
+is a simple markov chatbot. Mention it in any channel the bot is in to make it spew out amusing text.
+
+`TOKEN` **-token** *TOKEN*
+
+> Specifies the Discord token that
+> **cadeybot**
+> will use for client communication.
+
+`BRAIN` **-token** *TOKEN*
+
+> Specifies the Markov chain brain that
+> **cadeybot**
+> should load data into cadey.gob from.
+
+# IMPLEMENTATION NOTES
+
+In order for
+**cadeybot**
+to get markov bot data, please put the importer tool and corpusmake.sh into the messages folder of your Discord GDPR dump. Then run corpusmake.sh and pass the resulting brain.txt as -brain to
+**cadeybot**.
+
+# EXAMPLES
+
+`cadeybot`
+
+`cadeybot -brain brain.txt`
+
+# DIAGNOSTICS
+
+The **cadeybot** utility exits&#160;0 on success, and&#160;&gt;0 if an error occurs.
+
+# SEE ALSO
+
+*	[https://discordapp.com Discord](hyperlink:)
+
+ \- December 19, 2018
diff --git a/docs/flagconfyg.5.md b/docs/flagconfyg.5.md
new file mode 100644
index 0000000..05e1588
--- /dev/null
+++ b/docs/flagconfyg.5.md
@@ -0,0 +1,25 @@
+flagconfyg(5) - File Formats Manual (urm)
+
+# NAME
+
+**flagconfyg** - This is the simple configuration format for projects in the x repos.
+
+# DESCRIPTION
+
+**flagconfyg**
+is a simple configuration language for projects in this repository. They are
+configured by a file that looks like this:
+
+// for appsluggr
+web web
+web-scale 1
+
+fname (
+  slug.tar.gz
+)
+
+and this gets resolved to the following flag calls:
+
+\-web=web -web-scale=1 -fname=slug.tar.gz
+
+ \- January 12, 2019
diff --git a/docs/ghstat.1.md b/docs/ghstat.1.md
new file mode 100644
index 0000000..f87d9ce
--- /dev/null
+++ b/docs/ghstat.1.md
@@ -0,0 +1,62 @@
+GHSTAT(1) - General Commands Manual (urm)
+
+# NAME
+
+**ghstat** - Look up and summarize the status of GitHub.
+
+# SYNOPSIS
+
+**ghstat**
+\[**-license**]
+\[**-message**]
+
+# DESCRIPTION
+
+**ghstat**
+is a small tool to help users look up information about
+[https://github.com GitHub](hyperlink:)
+system status as viewed by their
+[https://status.github.com Status API](hyperlink:)
+
+By default this tool will print a very small summary of GitHub status followed by the time the last update was made in RFC 3339 time format.
+
+Here's an example:
+
+`$ ghstat`
+`Status: good (2018-12-06T17:09:57Z)`
+
+**-license**
+
+> If set, the tool will show its software license details and then exit.
+
+**-message**
+
+> If set, the tool will show the last status message from GitHub more verbosely like such:
+
+> `$ ghstat -message`
+> `Last message:`
+> `Status: good`
+> `Message:`
+> `Time:`
+
+> When there is a message relevant to the status, it and its time will be shown here.
+
+# EXAMPLES
+
+`ghstat`
+
+`ghstat -license`
+
+`ghstat -message`
+
+# DIAGNOSTICS
+
+The **ghstat** utility exits&#160;0 on success, and&#160;&gt;0 if an error occurs.
+
+# SEE ALSO
+
+*	[https://github.com GitHub](hyperlink:)
+
+*	[https://status.github.com GitHub Status](hyperlink:)
+
+ \- December 9, 2018
diff --git a/docs/ilo-kesi.1.md b/docs/ilo-kesi.1.md
new file mode 100644
index 0000000..05e35aa
--- /dev/null
+++ b/docs/ilo-kesi.1.md
@@ -0,0 +1,111 @@
+ILO-KESI(1) - General Commands Manual (urm)
+
+# NAME
+
+**ilo-kesi** - ni li ilo sona pi toki pona.
+
+# SYNOPSIS
+
+**ilo-kesi**
+\[**-repl**&nbsp;*TOKEN*]
+
+# DESCRIPTION
+
+**ilo-kesi**
+communicates with Discord and scans every message in every channel it is in for the following pattern:
+
+`ilo ${ILO_NIMI} o`
+
+This is usually:
+
+`ilo Kesi o`
+
+When this condition is met, the chat message will be posted to the
+`TOKI_PONA_TOKENIZER_API_URL`
+and the resulting parsed sentences will be analyzed for what is being asked, and then it will be done.
+
+This only works on sentences written in the
+[http://tokipona.org Toki Pona](hyperlink)
+constructed language.
+
+**-repl** *REPL*
+
+> When this flag is passed,
+> **ilo-kesi**
+> will function in a mode where it does not connect to discord. This is useful when debugging parts of the grammar parsing. You can pass a junk value to
+> `DISCORD_TOKEN`
+> to help make testing easier.
+
+# ENVIRONMENT
+
+`DISCORD_TOKEN`
+
+> Specifies the Discord token that
+> **ilo-kesi**
+> will use for client communication.
+
+`TOKI_PONA_TOKENIZER_API_URL`
+
+> Specifies the URL that
+> **ilo-kesi**
+> will use to tokenize Toki Pona sentences. This should be some instance of the following serverless function:
+
+> [https://github.com/Xe/x/blob/master/discord/ilo-kesi/function/index.js](hyperlink:)
+
+> The default value for this is:
+
+> [https://us-central1-golden-cove-408.cloudfunctions.net/function-1](hyperlink:)
+
+`SWITCH_COUNTER_WEBHOOK`
+
+> Specifies the URL that
+> **ilo-kesi**
+> will use to communicate with
+> [https://www.switchcounter.science Switch Counter](hyperlink:)
+> This will be used mainly to read data, unless the user in question is a member of the
+> `JAN_LAWA`
+> id set.
+
+`ILO_NIMI`
+
+> Specifies the name of
+> **ilo-kesi**
+> when being commanded to do stuff. This defaults to
+> `Kesi`
+
+JAN\_LAWA
+
+> Specifies the list of people (via Discord user ID's) that are allowed to use
+> **ilo-kesi**
+> to submit switch data to
+> [https://www.switchcounter.science Switch Counter](hyperlink:)
+
+# IMPLEMENTATION NOTES
+
+**ilo-kesi**
+requires a brain created by
+cadeybot(1)
+
+**ilo-kesi**
+requires a webhook from
+[https://www.switchcounter.science Switch Counter](hyperlink:)
+
+# EXAMPLES
+
+ilo-kesi
+
+ilo-kesi -repl
+
+# DIAGNOSTICS
+
+The **ilo-kesi** utility exits&#160;0 on success, and&#160;&gt;0 if an error occurs.
+
+# SEE ALSO
+
+*	[https://discordapp.com Discord](hyperlink:)
+
+*	[http://tokipona.org Toki Pona](hyperlink)
+
+*	[https://www.switchcounter.science Switch Counter](hyperlink:)
+
+ \- December 19, 2018
diff --git a/docs/license.1.md b/docs/license.1.md
new file mode 100644
index 0000000..011462b
--- /dev/null
+++ b/docs/license.1.md
@@ -0,0 +1,75 @@
+LICENSE(1) - General Commands Manual (urm)
+
+# NAME
+
+**license** - Generate software licenses from a rather large list of templates.
+
+# SYNOPSIS
+
+**license**
+\[**-email**&nbsp;*address*]
+\[**-license**]
+\[**-name**&nbsp;*name*]
+\[**-out**]
+\[**-show**]
+
+# DESCRIPTION
+
+**license**
+is a software license generator. It uses
+git-config(1)
+to parse out your email and "real name" when relevant for the license template reasons.
+
+**-email** *address*
+
+> The email of the person licensing the software. This should be your email, or a corporation's email. If in doubt, ask a lawyer what to put here.
+
+> The default value for this is derived from
+> git-config(1)
+> by using the command:
+
+> `$ git config user.email`
+
+**-license**
+
+> If set,
+> **license**
+> will show its software license details and then exit.
+
+**-name** *name*
+
+> The name of the person licensing the software. This should be your name, or a corporation's name. If in doubt, ask a lawyer what to put here.
+
+> The default value for this is derived from
+> git-config(1)
+> by using the command:
+
+> `$ git config user.name`
+
+**-out**
+
+> If this is set,
+> **license**
+> will write the resulting license to the disk instead of standard out.
+
+**-show**
+
+> If set,
+> **license**
+> will show its list of license templates instead of generating one.
+
+# EXAMPLES
+
+`license`
+
+`license -license`
+
+`license -show`
+
+`license mit`
+
+# DIAGNOSTICS
+
+The **license** utility exits&#160;0 on success, and&#160;&gt;0 if an error occurs.
+
+ \- December 9, 2018
diff --git a/docs/man/prepare.sh b/docs/man/prepare.sh
index c56f8f1..c8f23bc 100755
--- a/docs/man/prepare.sh
+++ b/docs/man/prepare.sh
@@ -1,8 +1,6 @@
 #!/bin/sh
 
-for file in *.1
+for file in *.1 *.5
 do
 	mandoc -T markdown $file > ../$file.md
 done
-
-gzip *.1
diff --git a/docs/quickserv.1.md b/docs/quickserv.1.md
new file mode 100644
index 0000000..ea9bd38
--- /dev/null
+++ b/docs/quickserv.1.md
@@ -0,0 +1,36 @@
+QUICKSERV(1) - General Commands Manual (prm)
+
+# NAME
+
+**quickserv** - quickly and dirtily serve a folder as a HTTP server.
+
+# SYNOPSIS
+
+**quickserv**
+\[**-dir**]
+\[**-port**]
+
+# DESCRIPTION
+
+**quickserv**
+serves a local directory of files as an HTTP server.
+
+**-dir**
+
+> Specifies the local path to be served over HTTP.
+
+**-port**
+
+> Specifies the TCP port that quickserv will bind to.
+
+# EXAMPLES
+
+`quickserv`
+
+`quickserv -dir ~/public_html -port 9001`
+
+# SEE ALSO
+
+*	[https://godoc.org/net/http#Dir](hyperlink:)
+
+ \- December 12, 2017