From eed59ed26515b4915bc69ce3b2cc1c543d40b98b Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Sun, 3 May 2020 18:51:59 +0200 Subject: Update man pages Add missing options, rephrase some things to be a bit more clear and fix a bunch of typos. Signed-off-by: David Oberhollenzer --- doc/sqfs2tar.1 | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'doc/sqfs2tar.1') diff --git a/doc/sqfs2tar.1 b/doc/sqfs2tar.1 index 35cc6b8..0fc69f6 100644 --- a/doc/sqfs2tar.1 +++ b/doc/sqfs2tar.1 @@ -42,7 +42,10 @@ detection is not performed and duplicate data records are generated instead. .TP \fB\-\-no\-skip\fR, \fB\-s\fR -Abort if a file cannot be stored in a tar record instead of skipping it. +Abort if a file cannot be stored in a tar archive. For instance, the tar format +does not support socket files, but SquashFS does. The default behaviour of +\fBsqfs2tar\fR is to emit a warning to stderr and skip the entry. If this flag +is set, processing is aborted and \fBsqfs2tar\fR exits with an error status. .TP \fB\-\-help\fR, \fB\-h\fR Print help text and exit. @@ -59,12 +62,13 @@ If any file or directory is encountered that cannot be converted, it is skipped and a warning is written to stderr. Unless the \fB\-\-no\-skip\fR option is set, which aborts processing if a file cannot be converted. -This is mainly affects socket files which are supported by SquashFS but not by +This mainly affects socket files which are supported by SquashFS but not by POSIX tar, GNU tar or PAX. Since the tar format contains a sequence of files with absolute names, it has no direct concept of a tree or an unnamed root node. Consequently, meta data -from the SquashFS root inode is lost. +from the SquashFS root inode is lost, unless the \fB\-\-root\-becomes\fR option +is used. .SH EXAMPLES Turn a SquashFS image into a tar archive: .IP -- cgit v1.2.3