diff options
| -rw-r--r-- | doc/gensquashfs.1 | 8 | ||||
| -rw-r--r-- | doc/rdsquashfs.1 | 7 | ||||
| -rw-r--r-- | doc/sqfs2tar.1 | 10 | ||||
| -rw-r--r-- | doc/tar2sqfs.1 | 37 |
4 files changed, 34 insertions, 28 deletions
diff --git a/doc/gensquashfs.1 b/doc/gensquashfs.1 index 6214741..9ef4ee8 100644 --- a/doc/gensquashfs.1 +++ b/doc/gensquashfs.1 @@ -53,8 +53,8 @@ instead of setting defaults on all input paths. The root inode and the modification time on the SquashFS image itself will still be set to defaults. .TP \fB\-\-one\-file\-system\fR, \fB\-o\fR -When using \fB\-\-pack\-dir\fR only, stay in local filesystem and do not cross -mount points. +When using \fB\-\-pack\-dir\fR only, stay in the local filesystem and do not +cross mount points. .TP \fB\-\-defaults\fR, \fB\-d\fR <options> A comma separated list of default values for @@ -94,6 +94,10 @@ labels to the elements packed into the SquashFS image. \fB\-\-exportable\fR, \fB\-e\fR Generate an export table for NFS support. .TP +\fB\-\-no\-tail\-packing\fR, \fB\-T\fR +Do not perform tail end packing on files that are larger than the specified +block size. +.TP \fB\-\-force\fR, \fB\-f\fR Overwrite the output file if it exists. .TP diff --git a/doc/rdsquashfs.1 b/doc/rdsquashfs.1 index 338138a..a5e1d77 100644 --- a/doc/rdsquashfs.1 +++ b/doc/rdsquashfs.1 @@ -46,13 +46,14 @@ Skip device special files when parsing the filesystem tree. Skip socket files when parsing the filesystem tree. .TP \fB\-\-no\-fifo\fR, \fB\-F\fR -Skip named pipes files when parsing the filesystem tree. +Skip named pipes when parsing the filesystem tree. .TP \fB\-\-no\-slink\fR, \fB\-L\fR Skip symbolic links when parsing the filesystem tree. .TP \fB\-\-no\-empty\-dir\fR, \fB\-E\fR -Skip directories that would end up empty after applying the above rules. +Skip empty directories, including ones that are empty after applying +the above rules. .PP The following options are specific to unpacking files from a SquashFS image to disk: @@ -70,7 +71,7 @@ from the SquashFS image. .TP \fB\-\-chmod\fR, \fB\-C\fR Change permission flags of unpacked files to -those store in the SquashFS image. +those stored in the SquashFS image. .TP \fB\-\-chown\fR, \fB\-O\fR Change ownership of unpacked files to the 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 diff --git a/doc/tar2sqfs.1 b/doc/tar2sqfs.1 index 70bb485..da344ec 100644 --- a/doc/tar2sqfs.1 +++ b/doc/tar2sqfs.1 @@ -5,21 +5,15 @@ tar2sqfs \- create a SquashFS image from a tar archive .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. +Quickly and painlessly turn a tar ball into a SquashFS filesystem image. .PP Possible options: .TP \fB\-\-root\-becomes\fR, \fB\-r\fR <dir> -If set, only pack entries that are underneath the specified directory and the -prefix is stripped. The meta data for the directory itself is copied to the -root inode, i.e. the ownership, permissions, extended attributes (unless -\f\-\-no\-xattr\R is set), and modification time -(unless \fB\-\-no\-keep\-time\fR is set). +If set, only pack entries that are underneath the specified directory. The +prefix is stripped and the meta data for the directory itself is copied to the +root inode (i.e. the ownership, permissions, extended attributes, +modification time). If this option is not set, tar2sqfs implicitly treats \fB./\fR or absolute paths this way, i.e. if the archive contains an entry for \fB./\fR, it becomes @@ -77,11 +71,11 @@ mtime=<value>;\fB$SOURCE\_DATE\_EPOCH\fR if set, 0 otherwise Replace the time stamps from the tar archive with default time stamps for all entries. -The default behavior if not specified, is to preserve the time stamps from the -archive to the extent possible (SquashFS has second resolution and 32 bit time -stamps; tar can use extensions to specify much larger timestamps with arbitrary -precision). The root inode and the modification time on the SquashFS image -itself will always still be set to defaults. +The default behavior is to preserve the time stamps from the archive to the +extent possible (SquashFS has second resolution and 32 bit time stamps; tar can +use extensions to specify much larger timestamps with arbitrary precision). The +root inode (unless \fB\-\-root\-becomes\fR is used) and the modification time on +the SquashFS image itself will still be set to defaults. .TP \fB\-\-no\-xattr\fR, \fB\-x\fR Do not copy extended attributes from archive. Default behaviour is to copy all @@ -93,6 +87,10 @@ Abort if a tar record cannot be read instead of skipping it. \fB\-\-exportable\fR, \fB\-e\fR Generate an export table for NFS support. .TP +\fB\-\-no\-tail\-packing\fR, \fB\-T\fR +Do not perform tail end packing on files that are larger than the +specified block size. +.TP \fB\-\-force\fR, \fB\-f\fR Overwrite the output file if it exists. .TP @@ -106,19 +104,18 @@ Print help text and exit. Print version information and exit. .SH COMPATIBILITY Currently the program can process v7 format, pre-POSIX ustar, POSIX tar and GNU -tar archives. PAX extension headers are also supported. +tar archives. PAX extension headers are also supported. Global PAX headers are +ignored. The support for GNU tar is limited to commonly used subset (i.e. some legacy extensions that GNU tar itself no longer generates are not supported; neither are mutli volume archives). -Hard links are currently not supported and silently converted to symlinks. - Extended attributes are supported through the SCHILY.xattr PAX extension (favoured by GNU tar and star) or through the LIBARCHIVE.xattr PAX extension. If any unsupported section or extended attribute key is encountered in an -archive a warning message is written to stderr. If the \fB\-\-no\-skip\fR +archive, a warning message is written to stderr. If the \fB\-\-no\-skip\fR option is set, processing aborts. By default, unknown sections and unsupported extended attributes are simply skipped after issuing a warning. .SH ENVIRONMENT |