2 files changed, 55 insertions, 0 deletions
diff --git a/doc/Makemodule.am b/doc/Makemodule.am
index 5141be5..1792da9 100644
--- a/doc/Makemodule.am
+++ b/doc/Makemodule.am
@@ -1 +1,2 @@
 dist_man1_MANS += doc/gensquashfs.1 doc/rdsquashfs.1 doc/sqfs2tar.1
+dist_man1_MANS += doc/tar2sqfs.1
diff --git a/doc/tar2sqfs.1 b/doc/tar2sqfs.1
new file mode 100644
index 0000000..c546935
--- /dev/null
+++ b/doc/tar2sqfs.1
@@ -0,0 +1,54 @@
+.TH TAR2SQFS "1" "June 2019" "tar2sqfs" "User Commands"
+.SH NAME
+tar2sqfs \- create a squashfs image from a tar archive
+.SH SYNOPSIS
+.B tar2sqfs
+[\fI\,OPTIONS\/\fR...] \fI\,<sqfsfile>\/\fR
+.SH DESCRIPTION
+Read an uncompressed tar archive from stdin and turn it into a squashfs
+filesystem image.
+
+The idea is to quickly and painlessly turn a tar ball into a squashfs
+filesystem image, so existing tools that work with tar can be used for
+squashfs.
+.PP
+Possible options:
+.TP
+\fB\-\-help\fR, \fB\-h\fR
+Print help text and exit.
+.TP
+\fB\-\-version\fR, \fB\-V\fR
+Print version information and exit.
+.SH LIMITATIONS
+Currently the tool can only process POSIX tar archives with pax extensions, so
+you need to tell your tool that generates the tar ball to not use any other
+extensions.
+
+For GNU tar, this can be done with the flag \fB\-\-posix\fR:
+.IP
+tar cf file.tar \-\-posix bin/ lib/ etc/ usr/
+.TP
+Furthermore, hard links and sparse files are currently not supported. If any
+unsupported section is encountered in a tar archive, the section is skipped and
+a warning message is written to stderr.
+.SH EXAMPLES
+.TP
+Turn an uncompressed tar archive into a squashfs image:
+.IP
+tar2sqfs rootfs.sqfs < rootfs.tar
+.TP
+Turn a gzip'ed tar archive into a squashfs image:
+.IP
+zcat rootfs.tar.gz | tar2sqfs rootfs.sqfs
+.TP
+Turn an LZMA2 compressed tar archive into a squashfs image:
+.IP
+xzcat rootfs.tar.xz | tar2sqfs rootfs.sqfs
+.SH AUTHOR
+Written by David Oberhollenzer.
+.SH COPYRIGHT
+Copyright \(co 2019 David Oberhollenzer
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.