aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristine Dodrill <me@christine.website>2018-12-09 20:32:20 +0000
committerChristine Dodrill <me@christine.website>2018-12-09 20:32:20 +0000
commitf5279a6acc1fa11e4f39a3370190974c39e27afd (patch)
tree9d24001551994c360ac2e95b0da67b4220189edf /docs
parent0bdaf44363bfb3622b7d5a3e51a961443d966ec5 (diff)
downloadx-f5279a6acc1fa11e4f39a3370190974c39e27afd.tar.xz
x-f5279a6acc1fa11e4f39a3370190974c39e27afd.zip
docs/man: build markdown versions of manpages
Diffstat (limited to 'docs')
-rw-r--r--docs/man/README.md11
-rwxr-xr-xdocs/man/prepare.sh5
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/man/README.md b/docs/man/README.md
new file mode 100644
index 0000000..b0a74fc
--- /dev/null
+++ b/docs/man/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/man/prepare.sh b/docs/man/prepare.sh
index 2180c32..c56f8f1 100755
--- a/docs/man/prepare.sh
+++ b/docs/man/prepare.sh
@@ -1,3 +1,8 @@
#!/bin/sh
+for file in *.1
+do
+ mandoc -T markdown $file > ../$file.md
+done
+
gzip *.1