reorg

7 files changed, 513 insertions, 0 deletions

diff --git a/docs/man1/README.md b/docs/man1/README.md
new file mode 100644
index 0000000..b0a74fc
--- /dev/null
+++ b/docs/man1/README.md
@@ -0,0 +1,11 @@
+# manpages
+
+These are manpages for a selected group of commands that I consider really useful. I have created a web version of these manpages too at TODO: add link to deployed site.
+
+## Deployment
+
+- gzip all the files (`$ gzip *.1`)
+- copy to (`/usr/share/man/man1/`)
+- `$ man appsluggr`
+
+
diff --git a/docs/man1/appsluggr.1 b/docs/man1/appsluggr.1
new file mode 100644
index 0000000..a0f3881
--- /dev/null
+++ b/docs/man1/appsluggr.1
@@ -0,0 +1,113 @@
+.Dd December 09, 2018
+.Dt APPSLUGGR 1 URM
+
+
+.Sh NAME
+.Nm appsluggr
+.Nd appsluggr packages a precompiled binary application as a Heroku style slug for use with Dokku.
+
+
+.Sh SYNOPSIS
+.Nm
+
+.Op Fl fname
+.Op Fl license
+.Op Fl web
+.Op Fl web-scale
+.Op Fl worker
+.Op Fl worker-scale
+
+
+.Sh DESCRIPTION
+.Nm
+is a small tool to package
+.Li GOOS=linux GOARCH=amd64
+binaries for consumption on
+.Li hyperlink: http://dokku.viewdocs.io/dokku/ Dokku
+.
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Fl fname
+The filename to write the resulting slug to.
+
+The default value for this is
+.Li slug.tar.gz
+.
+
+.It Fl license
+If set, the tool will show its software license details and then exit.
+
+.It Fl web
+The path to the binary for the web process.
+
+One of
+.Fl web
+or
+.Fl worker
+must be set.
+
+.It Fl web-scale
+The default scale for web process if defined.
+
+The default value for this is 1.
+
+.It Fl worker
+The path to the binary for the worker process.
+One of
+.Fl web
+or
+.Fl worker
+must be set.
+
+.It Fl worker-scale
+The default scale for the worker process if defined.
+
+The default value for this is 1
+
+.El
+
+
+.Sh EXAMPLES
+
+.Li appsluggr
+
+.Li appsluggr -web web
+
+.Li appsluggr -worker ilo-sona
+
+.Li appsluggr -fname foo.tar.gz -web web -worker worker -web-scale 4 -worker-scale 16
+
+
+.Sh IMPLEMENTATION NOTES
+
+.Nm
+when used with
+.Lk hyperlink: http://dokku.viewdocs.io/dokku/ Dokku
+requires the use of the
+.Lk hyperlink: https://github.com/ryandotsmith/null-buildpack Null Buildpack
+as follows:
+
+.Li $ dokku config:set $APP_NAME BUILDPACK_URL=https://github.com/ryandotsmith/null-buildpack
+
+Or
+
+.Li $ ssh dokku@host config:set <see above>
+
+
+.Sh DIAGNOSTICS
+
+.Ex -std appsluggr
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: http://dokku.viewdocs.io/dokku/ Dokku
+
+.It
+.Lk hyperlink: https://github.com/ryandotsmith/null-buildpack Null Buildpack
+
+.El
diff --git a/docs/man1/cadeybot.1 b/docs/man1/cadeybot.1
new file mode 100644
index 0000000..e1d1967
--- /dev/null
+++ b/docs/man1/cadeybot.1
@@ -0,0 +1,62 @@
+.Dd December 19, 2018
+.Dt CADEYBOT 1 URM
+
+
+.Sh NAME
+.Nm cadeybot
+.Nd Markov bot based on my discord GDPR dump.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl token Ar TOKEN
+.Op Fl brain Ar BRAIN
+
+
+.Sh DESCRIPTION
+.Nm
+is a simple markov chatbot. Mention it in any channel the bot is in to make it spew out amusing text.
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Ev TOKEN Fl token Ar TOKEN
+Specifies the Discord token that 
+.Nm
+will use for client communication.
+
+.It Ev BRAIN Fl token Ar TOKEN
+Specifies the Markov chain brain that
+.Nm
+should load data into cadey.gob from.
+
+.El
+
+
+.Sh IMPLEMENTATION NOTES
+
+In order for 
+.Nm
+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
+.Nm .
+
+
+.Sh EXAMPLES
+
+.Li cadeybot
+
+.Li cadeybot -brain brain.txt
+
+
+.Sh DIAGNOSTICS
+
+.Ex -std cadeybot
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://discordapp.com Discord
+
+.El
diff --git a/docs/man1/ghstat.1 b/docs/man1/ghstat.1
new file mode 100644
index 0000000..694c72e
--- /dev/null
+++ b/docs/man1/ghstat.1
@@ -0,0 +1,75 @@
+.Dd December 09, 2018
+.Dt GHSTAT 1 URM
+
+
+.Sh NAME
+.Nm ghstat
+.Nd Look up and summarize the status of GitHub.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl license
+.Op Fl message
+
+
+
+.Sh DESCRIPTION
+.Nm
+is a small tool to help users look up information about
+.Lk hyperlink: https://github.com GitHub
+system status as viewed by their
+.Lk hyperlink: https://status.github.com Status API
+.
+
+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:
+
+.Li $ ghstat
+.Li Status: good (2018-12-06T17:09:57Z)
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Fl license
+If set, the tool will show its software license details and then exit.
+
+.It Fl message
+If set, the tool will show the last status message from GitHub more verbosely like such:
+
+.Li $ ghstat -message
+.Li Last message:
+.Li Status:  good
+.Li Message: 
+.Li Time:    
+
+When there is a message relevant to the status, it and its time will be shown here.
+
+.El
+
+
+.Sh EXAMPLES
+
+.Li ghstat
+
+.Li ghstat -license
+
+.Li ghstat -message
+
+
+.Sh DIAGNOSTICS
+
+.Ex -std ghstat
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://github.com GitHub
+
+.It
+.Lk hyperlink: https://status.github.com GitHub Status
+
+.El
diff --git a/docs/man1/ilo-kesi.1 b/docs/man1/ilo-kesi.1
new file mode 100644
index 0000000..93f26f7
--- /dev/null
+++ b/docs/man1/ilo-kesi.1
@@ -0,0 +1,130 @@
+.Dd December 19, 2018
+.Dt ILO-KESI 1 URM
+
+
+.Sh NAME
+.Nm ilo-kesi
+.Nd ni li ilo sona pi toki pona.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl repl Ar TOKEN
+
+
+.Sh DESCRIPTION
+.Nm
+communicates with Discord and scans every message in every channel it is in for the following pattern:
+
+.Li ilo ${ILO_NIMI} o
+
+This is usually:
+
+.Li ilo Kesi o
+
+When this condition is met, the chat message will be posted to the
+.Ev 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
+.Lk hyperlink http://tokipona.org Toki Pona
+constructed language.
+
+.Bl -tag -width "routed" -offset -indent -compact
+
+.It Fl repl Ar REPL
+When this flag is passed,
+.Nm
+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
+.Ev DISCORD_TOKEN
+to help make testing easier.
+
+.El
+
+
+.Sh ENVIRONMENT
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Ev DISCORD_TOKEN
+Specifies the Discord token that 
+.Nm
+will use for client communication.
+
+.It Ev TOKI_PONA_TOKENIZER_API_URL
+Specifies the URL that 
+.Nm
+will use to tokenize Toki Pona sentences. This should be some instance of the following serverless function:
+
+.Lk hyperlink: https://github.com/Xe/x/blob/master/discord/ilo-kesi/function/index.js
+
+The default value for this is:
+
+.Lk hyperlink: https://us-central1-golden-cove-408.cloudfunctions.net/function-1
+
+.It Ev SWITCH_COUNTER_WEBHOOK
+Specifies the URL that
+.Nm
+will use to communicate with
+.Lk hyperlink: https://www.switchcounter.science Switch Counter
+.
+This will be used mainly to read data, unless the user in question is a member of the
+.Ev JAN_LAWA
+id set.
+
+.It Ev ILO_NIMI
+Specifies the name of
+.Nm
+when being commanded to do stuff. This defaults to
+.Li Kesi
+.
+
+.It JAN_LAWA
+Specifies the list of people (via Discord user ID's) that are allowed to use
+.Nm
+to submit switch data to
+.Lk hyperlink: https://www.switchcounter.science Switch Counter
+.
+
+.El
+
+
+.Sh IMPLEMENTATION NOTES
+
+.Nm
+requires a brain created by
+.Xr cadeybot 1
+.
+
+.Nm
+requires a webhook from
+.Lk hyperlink: https://www.switchcounter.science Switch Counter
+.
+
+
+.Sh EXAMPLES
+
+ilo-kesi
+
+ilo-kesi -repl
+
+
+.Sh DIAGNOSTICS
+
+.Ex -std ilo-kesi
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://discordapp.com Discord
+
+.It
+.Lk hyperlink http://tokipona.org Toki Pona
+
+.It
+.Lk hyperlink: https://www.switchcounter.science Switch Counter
+
+.El
diff --git a/docs/man1/license.1 b/docs/man1/license.1
new file mode 100644
index 0000000..67cef43
--- /dev/null
+++ b/docs/man1/license.1
@@ -0,0 +1,78 @@
+.Dd December 09, 2018
+.Dt LICENSE 1 URM
+
+
+.Sh NAME
+.Nm license
+.Nd Generate software licenses from a rather large list of templates.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl email Ar address
+.Op Fl license
+.Op Fl name Ar name
+.Op Fl out
+.Op Fl show
+
+
+.Sh DESCRIPTION
+.Nm
+is a software license generator. It uses
+.Xr git-config 1
+to parse out your email and "real name" when relevant for the license template reasons.
+
+
+.Bl -tag -width " " -offset indent -compact
+
+
+.It Fl email Ar 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
+.Xr git-config 1
+by using the command:
+
+.Li $ git config user.email
+
+.It Fl license
+If set,
+.Nm
+will show its software license details and then exit.
+
+.It Fl name Ar 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
+.Xr git-config 1
+by using the command:
+
+.Li $ git config user.name
+
+.It Fl out
+If this is set,
+.Nm
+will write the resulting license to the disk instead of standard out.
+
+.It Fl show
+If set,
+.Nm
+will show its list of license templates instead of generating one.
+
+.El
+
+
+.Sh EXAMPLES
+
+.Li license
+
+.Li license -license
+
+.Li license -show
+
+.Li license mit
+
+
+.Sh DIAGNOSTICS
+
+.Ex -std license
diff --git a/docs/man1/quickserv.1 b/docs/man1/quickserv.1
new file mode 100644
index 0000000..5403140
--- /dev/null
+++ b/docs/man1/quickserv.1
@@ -0,0 +1,44 @@
+.Dd December 12, 2017
+.Dt QUICKSERV 1 PRM
+
+
+.Sh NAME
+.Nm quickserv
+.Nd quickly and dirtily serve a folder as a HTTP server.
+
+
+.Sh SYNOPSIS
+.Nm
+.Op Fl dir
+.Op Fl port
+
+
+.Sh DESCRIPTION
+.Nm
+serves a local directory of files as an HTTP server.
+
+.Bl -tag -width " " -offset indent -compact
+
+.It Fl dir
+Specifies the local path to be served over HTTP.
+
+.It Fl port
+Specifies the TCP port that quickserv will bind to.
+
+.El
+
+
+.Sh EXAMPLES
+
+.Li quickserv
+
+.Li quickserv -dir ~/public_html -port 9001
+
+
+.Sh SEE ALSO
+
+.Bl -bullet
+
+.It
+.Lk hyperlink: https://godoc.org/net/http#Dir
+