Add README describing the pre-generated manpages

Signed-off-by: Phillip Lougher <phillip@squashfs.org.uk>
onekey-sec · Mar 17, 2022 · 246542d · 246542d
1 parent 69a0cad
commit 246542d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/manpages/.gitattributes b/manpages/.gitattributes
@@ -0,0 +1 @@
+README !export-ignore
diff --git a/manpages/README b/manpages/README
@@ -0,0 +1,13 @@
+These pre-generated manpages are built using the Squashfs-tools Makefile
+defaults with the gzip, lzo, lz4, xz, and zstd compression algorithms
+selected.
+
+The manpages are intended to be used by the installer if help2man isn't
+available on the system.
+
+But, they can obviously also be viewed by anyone who doesn't want to build
+or install Squashfs-tools, by running man -l, i.e.
+
+% man -l mksquashfs.1
+
+Will display the manpage for Mksquashfs.