aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-08-19 15:52:48 +0200
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-08-19 15:58:45 +0200
commit13fc663dc37520a63ba05c71697d2763e16e30e0 (patch)
treed3f2ad6e0ebf73964c700ef7a43122150144106d /doc
parent076c1cdb95c12e2b5bf8de33c9d53d93f35ae1c6 (diff)
Update rdsquashfs man page
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/rdsquashfs.140
1 files changed, 24 insertions, 16 deletions
diff --git a/doc/rdsquashfs.1 b/doc/rdsquashfs.1
index c6c9330..535161c 100644
--- a/doc/rdsquashfs.1
+++ b/doc/rdsquashfs.1
@@ -27,7 +27,8 @@ Unpack the specified sub directory from the image. To unpack everything,
simply specify /.
.TP
\fB\-\-describe\fR, \fB\-d\fR
-Produce a file listing from the image.
+Produce a file listing from the image compatible with the format consumed by
+gensquashfs.
.PP
The following options can be used to control the behaviour of the specified
operation:
@@ -38,36 +39,41 @@ data is unpacked to. If used with \fB\-\-describe\fR, this
is used as a prefix for the input path of
regular files.
.TP
-\fB\-\-jobs\fR, \fB\-j\fR <count>
-Specify a number of parallel jobs to spawn for unpacking file data.
-The file hierarchy is created sequentially but the data unpacking is
-distributed over the given number of jobs so that each job has to unpack
-roughly the same amount of data. This can be used to speed up unpacking
-of large SquashFS archives.
-.TP
\fB\-\-no\-dev\fR, \fB\-D\fR
-Do not unpack device special files.
+Skip device special files when parsing the filesystem tree.
.TP
\fB\-\-no\-sock\fR, \fB\-S\fR
-Do not unpack socket files.
+Skip socket files when parsing the filesystem tree.
.TP
\fB\-\-no\-fifo\fR, \fB\-F\fR
-Do not unpack named pipes.
+Skip named pipes files when parsing the filesystem tree.
.TP
\fB\-\-no\-slink\fR, \fB\-L\fR
-Do not unpack symbolic links.
+Skip symbolic links when parsing the filesystem tree.
.TP
\fB\-\-no\-empty\-dir\fR, \fB\-E\fR
-Do not unpack directories that would end up
-empty after applying the above rules.
+Skip directories that would end up empty after applying the above rules.
+.PP
+The following options are specific to unpacking files from a SquashFS image
+to disk:
+.TP
+\fB\-\-jobs\fR, \fB\-j\fR <count>
+Specify a number of parallel jobs to spawn for unpacking file data.
+The file hierarchy is created sequentially but the data unpacking is
+distributed over the given number of jobs so that each job has to unpack
+roughly the same amount of data. This can be used to speed up unpacking
+of large SquashFS archives.
.TP
\fB\-\-no\-sparse\fR, \fB\-Z\fR
Do not create sparse files. Always unpack sparse files by
writing blocks of zeros to disk.
.TP
\fB\-\-set\-xattr\fR, \fB\-X\fR
-When unpacking files to disk, set the extended attributes from the
-SquashFS image.
+Set the extended attributes from the SquashFS image.
+.TP
+\fB\-\-set\-times\fR, \fB\-T\fR
+Set the create and modify timestamps of the file to the mtime
+from the SquashFS image.
.TP
\fB\-\-chmod\fR, \fB\-C\fR
Change permission flags of unpacked files to
@@ -79,6 +85,8 @@ UID/GID set in the SquashFS image.
.TP
\fB\-\-quiet\fR, \fB\-q\fR
Do not print out progress while unpacking.
+.PP
+Other options:
.TP
\fB\-\-help\fR, \fB\-h\fR
Print help text and exit.