improve man page generation with help2man

1 files changed, 13 insertions, 0 deletions

diff --git a/hadori.help2man b/hadori.help2man
new file mode 100644
index 0000000..859dd2f
--- /dev/null
+++ b/hadori.help2man
@@ -0,0 +1,13 @@
+# roff markup for the list generated using "pandoc -t man" and pasted here
+[NAME]
+hadori \- hardlink identical files
+[DESCRIPTION]
+This might look like yet another hardlinking tool, but it is the only one which only memorizes one filename per inode. That results in less memory consumption and faster execution compared to its
+alternatives. Therefore (and because all the other names are already taken) it's called "HArdlinking DOne RIght".
+
+Advantages over other hardlinking tools:
+.IP \[bu] 2
+predictability: arguments are scanned in order, each first version is
+kept
+.IP \[bu] 2
+much lower CPU and memory consumption