1MKSQUASHFS(1)       create and append squashfs filesystems       MKSQUASHFS(1)
2
3
4

NAME

6       mksquashfs - tool to create and append to squashfs filesystems
7
8

SYNOPSIS

10       mksquashfs SOURCE [SOURCE2 ...] DESTINATION [OPTIONS]
11
12

DESCRIPTION

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

OPTIONS

27   Filesystem build options
28       -comp COMPRESSION
29           select  COMPRESSION  compression.   Compressors   available:   gzip
30           (default), lzo, xz.
31
32       -b BLOCK_SIZE
33           set data block to BLOCK_SIZE. Default 131072 bytes.
34
35       -no-exports
36           don't make the filesystem exportable via NFS.
37
38       -no-sparse
39           don't detect sparse files.
40
41       -no-xattrs
42           don't store extended attributes.
43
44       -xattrs
45           store extended attributes (default).
46
47       -noI
48           do not compress inode table.
49
50       -noD
51           do not compress data blocks.
52
53       -noF
54           do not compress fragment blocks.
55
56       -noX
57           do not compress extended attributes.
58
59       -no-fragments
60           do not use fragments.
61
62       -always-use-fragments
63           use fragment blocks for files larger than block size.
64
65       -no-duplicates
66           do not perform duplicate checking.
67
68       -all-root
69           make all files owned by root.
70
71       -force-uid uid
72           set all file uids to uid.
73
74       -force-gid gid
75           set all file gids to gid.
76
77       -nopad
78           do not pad filesystem to a multiple of 4K.
79
80       -keep-as-directory
81           if  one source directory is specified, create a root directory con‐
82           taining that directory, rather than the contents of the directory.
83
84
85   Filesystem filter options
86       -p PSEUDO_DEFINITION
87           Add pseudo file definition.
88
89       -pf PSEUDO_FILE
90           Add list of pseudo file definitions.
91
92       -sort SORT_FILE
93           sort files according to priorities in SORT_FILE. One  file  or  dir
94           with  priority per line. Priority -32768 to 32767, default priority
95           0.
96
97       -ef EXCLUDE_FILE
98           list of exclude dirs/files. One per line.
99
100       -wildcards
101           Allow extended shell wildcards (globbing) to  be  used  in  exclude
102           dirs/files
103
104       -regex
105           Allow POSIX regular expressions to be used in exclude dirs/files.
106
107
108   Filesystem append options
109       -noappend
110           do not append to existing filesystem.
111
112       -root-becomes NAME
113           when  appending  source  files/directories,  make the original root
114           become a subdirectory in the new  root  called  NAME,  rather  than
115           adding the new source items to the original root.
116
117
118   Mksquashfs runtime options:
119       -version
120           print version, licence and copyright message.
121
122       -recover NAME
123           recover filesystem data using recovery file NAME.
124
125       -no-recovery
126           don't generate a recovery file.
127
128       -info
129           print files written to filesystem.
130
131       -no-progress
132           don't display the progress bar.
133
134       -processors NUMBER
135           Use  NUMBER  processors.  By  default will use number of processors
136           available.
137
138       -read-queue SIZE
139           Set input queue to SIZE Mbytes. Default 64 Mbytes.
140
141       -write-queue SIZE
142           Set output queue to SIZE Mbytes. Default 512 Mbytes.
143
144       -fragment-queue SIZE
145           Set fragment queue to SIZE Mbytes. Default 64 Mbytes.
146
147
148   Miscellaneous options
149       -root-owned
150           alternative name for -all-root.
151
152       -noInodeCompression
153           alternative name for -noI.
154
155       -noDataCompression
156           alternative name for -noD.
157
158       -noFragmentCompression
159           alternative name for -noF.
160
161       -noXattrCompression
162           alternative name for -noX.
163
164
165   Compressors available and compressor specific options
166       gzip (no options) (default)
167
168       lzo (no options)
169
170       xz
171
172       -Xbcj filter1,filter2,...,filterN
173           Compress using filter1,filter2,...,filterN in turn (in addition  to
174           no  filter),  and  choose  the best compression. Available filters:
175           x86, arm, armthumb, powerpc, sparc, ia64.
176
177       -Xdict-size DICT_SIZE
178           Use DICT_SIZE as the XZ dictionary size. The dictionary size can be
179           specified  as  a  percentage  of  the block size, or as an absolute
180           value. The dictionary size must be less than or equal to the  block
181           size  and  8192 bytes or larger. It must also be storable in the xz
182           header as either 2^n or as 2^n+2^(n+1). Example dict-sizes are 75%,
183           50%, 37.5%, 25%, or 32K, 16K, 8K etc.
184
185

SEE ALSO

187       unsquashfs(1)
188
189

HOMEPAGE

191       More  information  about  mksquashfs and the squashfs filesystem can be
192       found at <http://squashfs.sourceforge.net/>.
193
194

AUTHOR

196       squashfs  was  written  by  Phillip   Lougher   <plougher@users.source‐
197       forge.net>.
198
199       This   manual   page   was   written  by  Daniel  Baumann  <daniel.bau‐
200       mann@progress-technologies.net>.
201
202
203
2044.2                               2012-06-30                     MKSQUASHFS(1)
Impressum