commit 5bbaf84ea3c3aeb346ebd22df0f56e2b0a2f1345 (patch)
parent f9488ca5664cc38787e05c295b3873028eb7dbf3
Author: Alex Karle <alex@alexkarle.com>
Date: Thu, 31 Dec 2020 00:52:02 -0500
cleanup: Fix -Tlint errors in almost all man pages
There were a few big ones I missed (like -bullet needing to be before
-compact in .Bl), that really didn't show in HTML, but were issues in
man(1) itself.
Thankfully, mandoc(1) has a handy -Tlint mode that suggests things like
\(em and -bullet being first.
This patch really just cleans up a bunch of mdoc errors/warnings. There
_are_ still some warnings, so I don't think I'll lock it down with make
yet...
Diffstat:
8 files changed, 35 insertions(+), 24 deletions(-)
diff --git a/BLM.7 b/BLM.7
@@ -10,7 +10,7 @@ I meant to post about this earlier, but it's better late than never.
It's become abundantly clear to me that we need serious structural changes in our country.
I want to raise my voice in solidarity to say that Black Lives Matter.
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Lk https://blacklivesmatter.com
.It
diff --git a/a-new-hope.7 b/a-new-hope.7
@@ -14,7 +14,7 @@ has free static site hosting!
Inspired by Jeff Huang's article on websites Designed to Last
and a general desire for a simpler web.
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Lk https://jeffhuang.com/designed_to_last
.It
diff --git a/blog.7 b/blog.7
@@ -7,7 +7,7 @@
.Sh DESCRIPTION
I don't write frequently, but when I do, it's usually about tech.
.Sh SEE ALSO
-.Bl -bullet -compact -offset=indent
+.Bl -bullet -compact -offset indent
.It
.Xr intro 7
.It
diff --git a/domain-names.7 b/domain-names.7
@@ -36,9 +36,10 @@ Almost brilliant enough of a business to make me forgive their scumminess.
.Em Almost .
Nary an option to buy it.
.El
-So here we are. Looks like `karle.co` for at least a little longer.
+So here we are.
+Looks like `karle.co` for at least a little longer.
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Xr blog 7
.El
diff --git a/my-old-man.7 b/my-old-man.7
@@ -26,7 +26,8 @@ rewrite my site in
.Xr mdoc 7 ,
you might be wondering
.Em why
-I would do this. This blog post is intended to answer just that.
+I would do this.
+This blog post is intended to answer just that.
.Sh WHY
.Ss For the learning experience
The single biggest motivator of the rewrite was that
@@ -74,7 +75,8 @@ If you read this far, I thought you might be interested to hear how I'm
deploying the content.
.Pp
I'm a big fan of automation, so I've rigged up the site to deploy on a push
-to the master branch. Doing so involved two steps.
+to the master branch.
+Doing so involved two steps.
.Ss Building the mdoc
I created a small Makefile that builds each HTML file from each man page source.
.Pp
@@ -87,7 +89,8 @@ The relevant bit is the implicit suffix rule to convert each .7 file to .html:
| sed 's#</head>#<meta name="viewport" content="width=device-width,initial-scale=1">&# ' \\
> $@
.Ed
-This looks crazy, but it's not too complex. First, know that
+This looks crazy, but it's not too complex.
+First, know that
.Sy $<
is the source (the <name>.7 page), and
.Sy $@
@@ -110,9 +113,11 @@ Finally, I use a
oneliner to splice in a <meta> viewport tag for mobile
devices.
.Pp
-And that's really it! The rest is just listing the man pages I want built,
+And that's really it!
+The rest is just listing the man pages I want built,
with a phony default target depending on the html pages so that a `make` builds
-them all. Check out the full source
+them all.
+Check out the full source
.Lk https://alexkarle.com/git/alexkarle.com/file/Makefile.html here .
.Ss Deploying via git hook
Since I'm self-hosting git on the same server as the website, it's trivial to
@@ -141,7 +146,7 @@ and the git history at
.Lk https://alexkarle.com/git ,
so I don't see any harm to having the README.md accessible from the root.
.Sh SEE ALSO
-.Bl -compact -bullet -offset indent
+.Bl -bullet -compact
.It
.Xr blog 7
.It
diff --git a/on-writing.7 b/on-writing.7
@@ -15,7 +15,9 @@ still didn't end up publishing it.
I didn't think it was quite right.
I liked it well enough, but I was worried other people would judge it.
.Pp
-But here's the irony--as far as I know, I have no readers.
+But here's the irony
+\(em
+as far as I know, I have no readers.
Publishing it is almost equivalent to shouting into the void.
.Pp
So why did I care so much?
@@ -37,7 +39,8 @@ reactions, but the fear still got to me.
But I want to persevere, and that's ultimately what writing this is about.
I'm not writing for fame or attention.
I'm not writing to further my career or put it on my resume.
-I'm writing for me. For the clarity I get from expressing my thoughts, and for
+I'm writing for me.
+For the clarity I get from expressing my thoughts, and for
the joy I get looking back at where I was months or years ago.
.Pp
Why host them publicly?
@@ -46,10 +49,10 @@ I want to be the change I want to see in the internet and migrate from
centralized social networks back to a decentralized network of personal and
self-hosted sites.
.Pp
-And who knows, maybe one day someone will read this and have felt the same. I guess I'm writing for that person too.
-.Pp
+And who knows, maybe one day someone will read this and have felt the same.
+I guess I'm writing for that person too.
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Xr blog 7
.El
diff --git a/self-hosted.7 b/self-hosted.7
@@ -19,7 +19,9 @@ hobby-project, `euchre.live`.
If I was going to pay for a tiny VM, it was a no-brainer to move my personal
site to it too.
.Pp
-This turned out to be a great learning experience -- getting hands on experience
+This turned out to be a great learning experience
+\(em
+getting hands on experience
with reverse proxies, DNS, and a variety of operating systems and webservers
(first hosted on Alpine Linux and migrated to OpenBSD).
Additionally, I could self-host git repos, which has long been a nerd-goal of mine :)
@@ -29,7 +31,7 @@ but for now, I really just wanted to give a brief update on where I landed and
what the current stack is.
.Pp
I'm currently running (in no particular order):
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Sy OS :
OpenBSD
@@ -37,7 +39,7 @@ OpenBSD
.Sy Web server :
OpenBSD's
.Xr httpd 8
-.Bl -compact -dash
+.Bl -dash -compact
.It
Serves the `www.` static content
.It
@@ -48,14 +50,14 @@ Also serves
.Sy Reverse proxy :
OpenBSD's
.Xr relayd 8
-.Bl -compact -dash
+.Bl -dash -compact
.It
Used to send traffic between `euchre.live` (which uses a Mojolicious
web server as the backend) and `alexkarle.com` based on URL
.El
.It
.Sy `www` content :
-.Bl -compact -dash
+.Bl -dash -compact
.It
100% static content
.It
@@ -68,7 +70,7 @@ templating Perl script that I home-rolled
.El
.It
.Sy Git :
-.Bl -compact -dash
+.Bl -dash -compact
.It
Public repos served with
.Sy git-daemon(1)
@@ -82,7 +84,7 @@ static HTML of content generated via post-receive hook with
.El
That's all for now!
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Xr blog 7
.It
diff --git a/template.7 b/template.7
@@ -7,7 +7,7 @@
.Sh DESCRIPTION
entry
.Sh SEE ALSO
-.Bl -compact -bullet
+.Bl -bullet -compact
.It
.Xr blog 7
.El
