1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.5.
.TH SQFSCAT "1" "March 2023" "sqfscat version 4.6.1" "User Commands"
.SH NAME
sqfscat - tool to cat files from a squashfs filesystem to stdout
.SH SYNOPSIS
.B sqfscat
[\fI\,OPTIONS\/\fR] \fI\,FILESYSTEM \/\fR[\fI\,list of files to cat to stdout\/\fR]
.SH DESCRIPTION
Squashfs is a highly compressed read-only filesystem for Linux.
It uses either gzip/xz/lzo/lz4/zstd compression to compress both files, inodes
and directories. Inodes in the system are very small and all blocks are
packed to minimise data overhead. Block sizes greater than 4K are supported
up to a maximum of 1Mbytes (default block size 128K).
Squashfs is intended for general read-only filesystem use, for archival
use (i.e. in cases where a .tar.gz file may be used), and in constrained
block device/memory systems (e.g. embedded systems) where low overhead is
needed.
.SH OPTIONS
.TP
\fB\-v\fR, \fB\-version\fR
print version, licence and copyright information.
.TP
\fB\-p\fR NUMBER, \fB\-processors\fR NUMBER
use NUMBER processors. By default will use the number of processors available.
.TP
\fB\-o\fR BYTES, \fB\-offset\fR BYTES
skip BYTES at start of FILESYSTEM. Optionally a suffix of K, M or G can be given to specify Kbytes, Mbytes or Gbytes respectively (default 0 bytes).
.TP
\fB\-ig\fR, \fB\-ignore\-errors\fR
treat errors writing files to stdout as non\-fatal.
.TP
\fB\-st\fR, \fB\-strict\-errors\fR
treat all errors as fatal.
.TP
\fB\-no\-exit\fR, \fB\-no\-exit\-code\fR
don't set exit code (to nonzero) on non\-fatal errors.
.TP
\fB\-da\fR SIZE, \fB\-data\-queue\fR SIZE
set data queue to SIZE Mbytes. Default 256 Mbytes.
.TP
\fB\-fr\fR SIZE, \fB\-frag\-queue\fR SIZE
set fragment queue to SIZE Mbytes. Default 256 Mbytes.
.TP
\fB\-no\-wild\fR, \fB\-no\-wildcards\fR
do not use wildcard matching in filenames.
.TP
\fB\-r\fR, \fB\-regex\fR
treat filenames as POSIX regular expressions rather than use the default shell wildcard expansion (globbing).
.TP
\fB\-h\fR, \fB\-help\fR
output options text to stdout.
.SH "DECOMPRESSORS AVAILABLE"
gzip, lzo, lz4, xz, zstd
.SH "EXIT STATUS"
.TP
0
The file or files were output to stdout OK.
.TP
1
FATAL errors occurred, e.g. filesystem corruption, I/O errors. Sqfscat did not continue and aborted.
.TP
2
Non\-fatal errors occurred, e.g. not a regular file, or failed to resolve pathname. Sqfscat continued and did not abort.
.PP
See \fB\-ignore\-errors\fR, \fB\-strict\-errors\fR and \fB\-no\-exit\-code\fR options for how they affect
the exit status.
.SH EXAMPLES
.TP
sqfscat IMAGE.SQFS hello
Output the contents of "hello" to stdout.
.TP
sqfscat IMAGE.SQFS hello world
Output the contents of "hello" and then "world" to stdout.
.TP
sqfscat IMAGE.SQFS "*.[ch]"
Output the contents of all the files in the root directory that match the
wildcard *.[ch], to stdout, e.g. hello.c, hello.h, world.c, world.h.
.PP
Note: when passing wildcarded names to Sqfscat, they should be quoted (as in
the above examples), to ensure that they are not processed by the shell.
.SH AUTHOR
Written by Phillip Lougher <phillip@squashfs.org.uk>
.SH COPYRIGHT
Copyright \(co 2023 Phillip Lougher <phillip@squashfs.org.uk>
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2,
or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.SH "SEE ALSO"
mksquashfs(1), unsquashfs(1), sqfstar(1)
.PP
The README for the Squashfs\-tools 4.6.1 release, describing the new features can be
read here https://github.com/plougher/squashfs\-tools/blob/master/README\-4.6.1
.PP
The Squashfs\-tools USAGE guide can be read here
https://github.com/plougher/squashfs\-tools/blob/master/USAGE\-4.6
|
