sqfscat(1)

1SQFSCAT(1)                       User Commands                      SQFSCAT(1)
2
3
4

NAME

6       sqfscat - tool to cat files from a squashfs filesystem to stdout
7

SYNOPSIS

9       sqfscat [OPTIONS] FILESYSTEM [list of files to cat to stdout]
10

DESCRIPTION

12       Squashfs  is  a  highly  compressed read-only filesystem for Linux.  It
13       uses either gzip/xz/lzo/lz4/zstd compression to  compress  both  files,
14       inodes  and  directories.   Inodes in the system are very small and all
15       blocks are packed to minimise data overhead. Block sizes  greater  than
16       4K are supported up to a maximum of 1Mbytes (default block size 128K).
17
18       Squashfs is intended for general read-only filesystem use, for archival
19       use (i.e. in cases where a .tar.gz file  may  be  used),  and  in  con‐
20       strained  block device/memory systems (e.g. embedded systems) where low
21       overhead is needed.
22

OPTIONS

24       -v, -version
25              print version, licence and copyright information.
26
27       -p NUMBER, -processors NUMBER
28              use NUMBER processors.  By default will use the number  of  pro‐
29              cessors available.
30
31       -o BYTES, -offset BYTES
32              skip  BYTES  at start of FILESYSTEM. Optionally a suffix of K, M
33              or G can be given to specify Kbytes, Mbytes  or  Gbytes  respec‐
34              tively (default 0 bytes).
35
36       -ig, -ignore-errors
37              treat errors writing files to stdout as non-fatal.
38
39       -st, -strict-errors
40              treat all errors as fatal.
41
42       -no-exit, -no-exit-code
43              don't set exit code (to nonzero) on non-fatal errors.
44
45       -da SIZE, -data-queue SIZE
46              set data queue to SIZE Mbytes.  Default 256 Mbytes.
47
48       -fr SIZE, -frag-queue SIZE
49              set fragment queue to SIZE Mbytes.  Default 256 Mbytes.
50
51       -no-wild, -no-wildcards
52              do not use wildcard matching in filenames.
53
54       -r, -regex
55              treat filenames as POSIX regular expressions rather than use the
56              default shell wildcard expansion (globbing).
57
58       -h, -help
59              output options text to stdout.
60

DECOMPRESSORS AVAILABLE

62       gzip, lzo, lz4, xz, zstd, lzma
63

EXIT STATUS

65       0      The file or files were output to stdout OK.
66
67       1      FATAL errors occurred, e.g. filesystem corruption,  I/O  errors.
68              Sqfscat did not continue and aborted.
69
70       2      Non-fatal errors occurred, e.g. not a regular file, or failed to
71              resolve pathname.  Sqfscat continued and did not abort.
72
73       See -ignore-errors, -strict-errors and -no-exit-code  options  for  how
74       they affect the exit status.
75

EXAMPLES

77       sqfscat IMAGE.SQFS hello
78              Output the contents of "hello" to stdout.
79
80       sqfscat IMAGE.SQFS hello world
81              Output the contents of "hello" and then "world" to stdout.
82
83       sqfscat IMAGE.SQFS "*.[ch]"
84              Output  the contents of all the files in the root directory that
85              match the wildcard *.[ch], to stdout,  e.g.   hello.c,  hello.h,
86              world.c, world.h.
87
88       Note:  when  passing wildcarded names to Sqfscat, they should be quoted
89       (as in the above examples), to ensure that they are  not  processed  by
90       the shell.
91

AUTHOR

93       Written by Phillip Lougher <phillip@squashfs.org.uk>
94

COPYRIGHT

96       Copyright © 2022 Phillip Lougher <phillip@squashfs.org.uk>
97
98       This program is free software; you can redistribute it and/or modify it
99       under the terms of the GNU General Public License as published  by  the
100       Free  Software  Foundation;  either  version 2, or (at your option) any
101       later version.
102
103       This program is distributed in the hope that it  will  be  useful,  but
104       WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty  of MER‐
105       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  General
106       Public License for more details.
107