update man-page installation instructions

Jens Getreu · Jens Getreu · commit f31fda01fa6c · 2017-01-21T17:51:15.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ target
 *.sw?
 *.html
 *.1
+*.1.gz
diff --git a/doc/src/README.rst b/doc/src/README.rst
@@ -80,11 +80,11 @@ Binaries
     Download `stringsext binaries`_ and verify  hashes_.
 
 Manual page
-    `stringsext.1`_
+    `stringsext.1.gz`_
 
 .. _`stringsext binaries`: https://getreu.net/public/downloads/doc/stringsext/./target/
 .. _hashes: https://getreu.net/public/sha256sum.txt
-.. _`stringsext.1`: https://getreu.net/public/downloads/doc/stringsext/./man/stringsext.1
+.. _`stringsext.1.gz`: https://getreu.net/public/downloads/doc/stringsext/./man/man1/stringsext.1.gz
 
 
 
@@ -104,14 +104,20 @@ Building and installing
    Enter the *Stringsext* source directory where the file ``Cargo.toml`` resides. Then execute::
 
       cargo build --release
-
+      ./make-doc
 
 #. Install
 
-   a. Linux ::
+   a. Linux:
+
+      .. code:: bash
 
+         # install binary
          sudo cp target/release/stringsext /usr/local/bin/
-         sudo cp man/stringsext.1 /usr/local/man/man1/
+
+         # install man-page
+         sudo cp man/stringsext.1.gz /usr/local/man/man1/
+         sudo dpkg-reconfigure man-db   # e.g. Debian, Ubuntu
 
    b. Windows
 
diff --git a/make-doc b/make-doc
@@ -1,15 +1,16 @@
 #!/bin/sh
 
 mkdir -p ./doc/build
-
+mkdir --parents ./man/man1
 
 # Man page
-rst2man.py ./doc/src/stringsext--man.rst > ./man/stringsext.1
+rst2man.py ./doc/src/stringsext--man.rst > ./man/man1/stringsext.1
 rst2html.py --stylesheet=./doc/src/docutils_basic.css ./doc/src/stringsext--man.rst ./doc/build/stringsext--man.html
-
+# You can also use pandoc
+#pandoc -s doc/src/stringsext--man.rst -t man -o man/man1/stringsext.1
+gzip man/man1/stringsext.1
 
 # index page
-#rst2html.py --stylesheet=./doc/src/voidspace.css ./doc/src/README.rst ./doc/build/README.html
 rst2html.py --stylesheet=./doc/src/docutils_basic.css ./doc/src/README.rst ./doc/build/README.html
 
 

-Original file line number
+Diff line change
 *.sw?
 *.html
 *.1
 +*.1.gz