summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2021-11-11 20:59:32 +0100
committerPhilipp Gesang <phg@phi-gamma.net>2021-11-11 17:13:48 +0100
commitd397ec65aac136557d795c2e912c7f9985050edd (patch)
tree08f025120113021296279f80399ad46bb7626581
parentfbffcbbaaf3529572f7f55ff0c21735b9a29562b (diff)
downloadvtcol-d397ec65aac136557d795c2e912c7f9985050edd.tar.gz
add built instructions for manpage
-rw-r--r--.gitignore3
-rw-r--r--Makefile16
-rw-r--r--README.rst8
3 files changed, 26 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 2510987..ae0df3a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,6 @@ todo
# cargo junk
Cargo.lock
+
+# manpage
+doc/vtcol.1.gz
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..013dc99
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,16 @@
+manpage = doc/vtcol.1.gz
+
+cargo-target = ./target
+
+$(manpage): doc/vtcol.rst
+ rst2man $< |gzip > $@
+
+man: $(manpage)
+
+doc: man
+
+clean:
+ rm -f -- $(manpage)
+ rm -rf -- $(cargo-target)
+
+.PHONY: clean
diff --git a/README.rst b/README.rst
index 1809902..21b80b2 100644
--- a/README.rst
+++ b/README.rst
@@ -62,7 +62,13 @@ Building
Use Cargo to obtain a binary: ::
- cargo build
+ $ cargo build
+
+To generate the manpage, run ::
+
+ $ make man
+
+*rst2man* from the *Docutils* suite needs to be installed for this.
Background
----------