docs

cmd/appsluggr/main.go

@@ -1,3 +1,6 @@
+// Command appsluggr packages a standard web and worker slug for Heroku/Dokku.
+//
+// This hard assumes that the binaries put into the slug will work on the target hardware.
 package main
 
 import (

cmd/dnsd/main.go

@@ -1,20 +1,21 @@
+// Command dnsd is a simple DNS server for my network. It has O(n) lookup times.
 package main
 
 import (
 	"bufio"
 	"flag"
+	"fmt"
 	"log"
 	"net/http"
 	"os"
 	"os/signal"
 	"syscall"
 	"time"
-	"fmt"
 
-	"within.website/x/web"
-	"within.website/x/internal"
 	"github.com/miekg/dns"
 	"github.com/mmikulicic/stringlist"
+	"within.website/x/internal"
+	"within.website/x/web"
 )
 
 var (

cmd/ff-primitive/main.go

@@ -1,3 +1,4 @@
+// Command ff-primitive takes farbfeld data from standard in and applies http://primitive.lol to it.
 package main
 
 import (
@@ -8,9 +9,9 @@ import (
 	"runtime"
 	"runtime/pprof"
 
-	"within.website/x/internal"
 	"github.com/fogleman/primitive/primitive"
 	farbfeld "github.com/hullerob/go.farbfeld"
+	"within.website/x/internal"
 )
 
 var (

cmd/genua/main.go

@@ -1,3 +1,4 @@
+// Command genua generates an example user agent.
 package main
 
 import (

cmd/johaus/main.go

@@ -1,3 +1,4 @@
+// Command johaus wraps the lojban parser camxes and presents the results over HTTP.
 package main
 
 import (

cmd/la-baujmi/main.go

@@ -1,15 +1,16 @@
+// Command la-baujmi is a simple language understander for Toki Pona.
 package main
 
 import (
 	"log"
 	"os"
 	"strings"
 
+	"github.com/mndrix/golog"
+	line "github.com/peterh/liner"
 	"within.website/x/internal"
 	_ "within.website/x/internal/tokipona"
 	"within.website/x/web/tokiponatokens"
-	"github.com/mndrix/golog"
-	line "github.com/peterh/liner"
 )
 
 func main() {

cmd/license/licenses/licenses.go

@@ -1,3 +1,4 @@
+// Package licenses is the list of licenses that this software supports.
 package licenses
 
 var List map[string]string
@@ -32,7 +33,7 @@ func init() {
 		"sqlite":            SQLiteBlessing,
 		"fair":              FairLicense,
 		"yolo":              YoloLicense,
-		"icu996": ICU996License,
+		"icu996":            ICU996License,
 	}
 }
 

cmd/license/main.go

@@ -1,3 +1,4 @@
+// Command license is a simple software license generator.
 package main
 
 import (
@@ -10,8 +11,8 @@ import (
 	"text/template"
 	"time"
 
-	"within.website/x/internal"
 	"within.website/x/cmd/license/licenses"
+	"within.website/x/internal"
 )
 
 var (

cmd/mainsanow/main.go

@@ -1,7 +1,7 @@
+// Command mainsanow shows the current time in ma insa.
 package main
 
 import (
-	"flag"
 	"log"
 	"time"
 
@@ -10,7 +10,6 @@ import (
 )
 
 func main() {
-	flag.Parse()
 	internal.HandleStartup()
 
 	tn, err := mainsa.At(time.Now())

cmd/minipaas/main.go

@@ -1,3 +1,4 @@
+// Command minipaas is a simple client for minipaas.xeserv.us. This is not useful without access to that server.
 package main
 
 import (

cmd/mkapp/main.go

@@ -1,3 +1,4 @@
+// Command mkapp creates a mastodon app for a given -instance.
 package main
 
 import (

cmd/priorworkgen/main.go

@@ -1,3 +1,4 @@
+// Command priorworkgen generates the list of prior work (read: GitHub repositories) for contractual stuff.
 package main
 
 import (
@@ -7,10 +8,10 @@ import (
 	"log"
 	"os"
 
-	"within.website/x/internal"
 	"github.com/google/go-github/github"
 	_ "github.com/joho/godotenv/autoload"
 	"golang.org/x/oauth2"
+	"within.website/x/internal"
 )
 
 var (

cmd/quickserv/main.go

@@ -1,3 +1,4 @@
+// Command quickserv serves a folder of files over HTTP quickly.
 package main
 
 import (

cmd/relayd/main.go

@@ -1,3 +1,4 @@
+// Command relayd is a simple TLS terminator using let's encrypt.
 package main
 
 import (

cmd/thumber/main.go

@@ -1,3 +1,4 @@
+// Command thumber creates 256x256 thumbnails for a folder/pile of them.
 package main
 
 import (
@@ -7,8 +8,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"within.website/x/internal"
 	"github.com/disintegration/imaging"
+	"within.website/x/internal"
 )
 
 var (

cmd/tlstestd/main.go

@@ -1,16 +1,17 @@
+// Command tlstestd loads the given TLS cert/key and listens to the given port over HTTPS.
 package main
 
 import (
 	"flag"
-	"net/http"
 	"log"
+	"net/http"
 
 	"within.website/x/internal"
 )
 
 var (
 	cert = flag.String("cert", "cert.pem", "TLS cert file")
-	key = flag.String("key", "key.pem", "TLS key")
+	key  = flag.String("key", "key.pem", "TLS key")
 	port = flag.String("port", "2848", "TCP port to listen on")
 )
 
@@ -23,7 +24,7 @@ func main() {
 	internal.HandleStartup()
 
 	http.HandleFunc("/", helloServer)
-	err := http.ListenAndServeTLS(":"+ *port, *cert, *key, nil)
+	err := http.ListenAndServeTLS(":"+*port, *cert, *key, nil)
 	if err != nil {
 		log.Fatal("ListenAndServe: ", err)
 	}

cmd/tor2web/main.go

@@ -1,3 +1,4 @@
+// Command tor2web is a simple caching proxy to tor onion sites.
 package main
 
 import (

cmd/whoisfront/main.go

@@ -1,3 +1,4 @@
+// Command whoisfront is a simple CGI wrapper to switchcounter.science. This is used in some internal tooling.
 package main
 
 import (

cmd/within.website/main.go

@@ -1,3 +1,4 @@
+// Command within.website is the vanity import server for https://within.website.
 package main
 
 import (

idp/doc.go

@@ -0,0 +1,2 @@
+// Command idp is a primitive identity provider based on TOTP challenge from Google Authenticator codes.
+package main

internal/tokipona/doc.go

@@ -0,0 +1,2 @@
+// Package tokipona adds a copyright notice that pu wants to the list of licenses.
+package tokipona

internal/tor/tor.go

@@ -1,3 +1,4 @@
+// Package tor manages and automates starting a child tor process for exposing TCP services into onionland.
 package tor
 
 import (

jbo/doc.go

@@ -0,0 +1,2 @@
+// Package jbo is a set of utilities and helpers for understanding lojban text.
+package jbo

maybedoer/maybedoer.go

@@ -1,3 +1,6 @@
+// Package maybedoer contains a pipeline of actions that might fail. If any action
+// in the chain fails, no further actions take place and the error becomes the pipeline
+// error.
 package maybedoer
 
 // Impl sequences a set of actions to be performed via calls to
@@ -21,4 +24,3 @@ func (c *Impl) Maybe(f func() error) {
 func (c *Impl) Error() error {
 	return c.err
 }
-

tokipona/doc.go

@@ -0,0 +1,4 @@
+// Package tokipona contains utilities, helpers and relexers for Toki Pona.
+package tokipona
+
+import _ "within.website/x/internal/tokipona"