345715
.TH MKSQUASHFS 1 "2014\-05\-13" "4.3" "create and append squashfs filesystems"
345715
345715
.SH NAME
345715
mksquashfs \- tool to create and append to squashfs filesystems
345715
345715
.SH SYNOPSIS
345715
\fBmksquashfs\fR \fISOURCE\fR [\fISOURCE2\fR \fI...\fR] \fIDESTINATION\fR [\fIOPTIONS\fR]
345715
345715
.SH DESCRIPTION
345715
Squashfs is a highly compressed read\-only filesystem for Linux. It uses zlib compression to compress both files, inodes and directories. Inodes in the system are very small and all blocks are packed to minimize data overhead. Block sizes greater than 4K are supported up to a maximum of 64K.
345715
.PP
345715
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.
345715
345715
.SH OPTIONS
345715
345715
.SS Filesystem build options
345715
.IP "\-comp \fICOMPRESSION\fR" 4
345715
select \fICOMPRESSION\fR compression. Compressors available: gzip (default), lzma (no kernel support), lzo, lz4 and xz.
345715
.IP "\-b \fIBLOCK_SIZE\fR"
345715
set data block to \fIBLOCK_SIZE\fR. Default 131072 bytes. Optionally K or M can be used as a suffix to specify kilobytes or megabytes, respectively.
345715
.IP "\-no\-exports" 4
345715
don't make the filesystem exportable via NFS.
345715
.IP "\-no\-sparse" 4
345715
don't detect sparse files.
345715
.IP "\-no\-xattrs" 4
345715
don't store extended attributes.
345715
.IP "\-xattrs" 4
345715
store extended attributes (default).
345715
.IP "\-noI" 4
345715
do not compress inode table.
345715
.IP "\-noD" 4
345715
do not compress data blocks.
345715
.IP "\-noF" 4
345715
do not compress fragment blocks.
345715
.IP "\-noX" 4
345715
do not compress extended attributes.
345715
.IP "\-no\-fragments" 4
345715
do not use fragments.
345715
.IP "\-always\-use\-fragments" 4
345715
use fragment blocks for files larger than block size.
345715
.IP "\-no\-duplicates" 4
345715
do not perform duplicate checking.
345715
.IP "\-all\-root" 4
345715
make all files owned by root.
345715
.IP "\-force\-uid uid" 4
345715
set all file uids to uid.
345715
.IP "\-force\-gid gid" 4
345715
set all file gids to gid.
345715
.IP "\-nopad" 4
345715
do not pad filesystem to a multiple of 4K.
345715
.IP "\-keep\-as\-directory" 4
345715
if one source directory is specified, create a root directory containing that directory, rather than the contents of the directory.
345715
345715
.SS Filesystem filter options
345715
.IP "\-p \fIPSEUDO_DEFINITION\fR" 4
345715
Add pseudo file definition.
345715
.IP "\-pf \fIPSEUDO_FILE\fR" 4
345715
Add list of pseudo file definitions.
345715
.IP "\-sort \fISORT_FILE\fR" 4
345715
sort files according to priorities in \fISORT_FILE\fR. One file or dir with priority per line. Priority \-32768 to 32767, default priority 0.
345715
.IP "\-ef \fIEXCLUDE_FILE\fR" 4
345715
list of exclude dirs/files. One per line.
345715
.IP "\-wildcards" 4
345715
Allow extended shell wildcards (globbing) to be used in exclude dirs/files
345715
.IP "\-regex" 4
345715
Allow POSIX regular expressions to be used in exclude dirs/files.
345715
345715
.SS Filesystem append options
345715
.IP "\-noappend" 4
345715
do not append to existing filesystem.
345715
.IP "\-root\-becomes \fINAME\fR" 4
345715
when appending source files/directories, make the original root become a subdirectory in the new root called \fINAME\fR, rather than adding the new source items to the original root.
345715
345715
.SS Mksquashfs runtime options:
345715
.IP "\-version" 4
345715
print version, licence and copyright message.
345715
.IP "\-exit\-on\-error" 4
345715
treat normally ignored errors as fatal.
345715
.IP "\-recover \fINAME\fR" 4
345715
recover filesystem data using recovery file \fINAME\fR.
345715
.IP "\-no\-recovery" 4
345715
don't generate a recovery file.
345715
.IP "\-info" 4
345715
print files written to filesystem.
345715
.IP "\-no\-progress" 4
345715
don't display the progress bar.
345715
.IP "\-progress" 4
345715
display progress bar when using the \-info option.
345715
.IP "\-processors \fINUMBER\fR" 4
345715
Use \fINUMBER\fR processors. By default will use number of processors available.
345715
.IP "\-mem \fISIZE\fR" 4
345715
Use \fISIZE\fR physical memory. Optionally K or M can be used as a suffix for kilobytes or megabytes, respectively. Default 25% of memory.
345715
.IP "\-read\-queue \fISIZE\fR" 4
345715
Deprecated. Use \-mem instead.
345715
.IP "\-write\-queue \fISIZE\fR" 4
345715
Deprecated. Use \-mem instead.
345715
.IP "\-fragment\-queue \fISIZE\fR" 4
345715
Deprecated. Use \-mem instead.
345715
345715
.SS Miscellaneous options
345715
.IP "\-root\-owned" 4
345715
alternative name for \-all\-root.
345715
.IP "\-noInodeCompression" 4
345715
alternative name for \-noI.
345715
.IP "\-noDataCompression" 4
345715
alternative name for \-noD.
345715
.IP "\-noFragmentCompression" 4
345715
alternative name for \-noF.
345715
.IP "\-noXattrCompression" 4
345715
alternative name for \-noX.
345715
.IP "\-Xhelp" 4
345715
print compressor options for selected compressor
345715
345715
.SS Compressors available and compressor specific options
345715
.IP "gzip (default)"
345715
.IP "\-Xcompression-level \fIcompression\-level\fR" 4
345715
\fIcompression\-level\fR should be 1 .. 9 (default 9)
345715
.IP "\-Xwindow\-size \fIwindow\-size\fR" 4
345715
\fIwindow\-size\fR should be 8 .. 15 (default 15)
345715
.IP "\-Xstrategy strategy1,strategy2,...,strategyN" 4
345715
Compress using strategy1,strategy2,...,strategyN in turn and choose the best compression. Available strategies: default, filtered, huffman_only, run_length_encoded and fixed
345715
.IP "lzmz (no options) (no kernel support)" 4
345715
.IP "lzo" 4
345715
.IP "\-Xalgorithm \fIalgorithm\fR" 4
345715
Where \fIalgorithm\fR is one of: lzo1x_1, lzo1x_1_11, lzo1x_1_12, lzo1x_1_15 or lzo1x_999. (default lzo1x_999)
345715
.IP "\-Xcompression\-level \fIcompression\-level\fR" 4
345715
\fIcompression\-level\fR should be 1 .. 9 (default 8)
345715
.IP "lz4" 4
345715
.IP "\-Xhc"
345715
Compress using LZ4 High Compression
345715
.IP "xz" 4
345715
.IP "\-Xbcj filter1,filter2,...,filterN" 4
345715
Compress using filter1,filter2,...,filterN in turn (in addition to no filter), and choose the best compression. Available filters: x86, arm, armthumb, powerpc, sparc, ia64.
345715
.IP "\-Xdict\-size \fIDICT_SIZE\fR" 4
345715
Use \fIDICT_SIZE\fR as the XZ dictionary size. The dictionary size can be specified as a percentage of the block size, or as an absolute value. The dictionary size must be less than or equal to the block size and 8192 bytes or larger. It must also be storable in the xz header as either 2^n or as 2^n+2^(n+1). Example dict\-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K etc.
345715
345715
.SH SEE ALSO
345715
unsquashfs(1)
345715
345715
.SH HOMEPAGE
345715
More information about mksquashfs and the squashfs filesystem can be found at <\fIhttp://squashfs.sourceforge.net/\fR>.
345715
345715
.SH AUTHOR
345715
squashfs was written by Phillip Lougher <\fIplougher@users.sourceforge.net\fR>.
345715
.PP
345715
This manual page was written by Daniel Baumann <\fIdaniel.baumann@progress\-technologies.net\fR>. With some updates for 4.3 for use with Fedora.