Skip to content
FUSE filesystem to mount squashfs archives
C Shell C++
Find file
Latest commit fd925a8 @vasi 32-bit fix
Failed to load latest commit information.
m4 We really do need to manually set _FILE_OFFSET_BITS
win Works on Windows!
.gitattributes Create VS2013 project
.gitignore Don't keep vcxproj.user in git
CONFIGURATION Move configuration options to a new file
LICENSE Licensing of squashfs_fs.h is ok! Add LIBS for programs, not convenience libraries
NEWS Add NEWS file
TODO Use silent rules by default Add script for autoreconf
cache.c Rationalize headers
cache.h C89 compatible
common.h Rationalize headers Force large files
decompress.c Works on Windows!
decompress.h C89 compatible
dir.c Rationalize headers
dir.h Rationalize headers
file.c 32-bit fix
file.h More comments
fs.c Leak fix 2
fs.h Rationalize headers
fuseprivate.c Rationalize headers
fuseprivate.h Rationalize headers __le64/uint64_t may give the compiler a headache
hash.c Rationalize headers
hash.h C89 compatible
hl.c Force single-threading in high-level mode, too
ll.c Make valgrind shut up already
ll.h Rationalize headers
ll_inode.c Document the different low-level inode strategies
ls.c Header fix
nonstd-daemon.c Rationalize headers
nonstd-enoattr.c xattrs on linux
nonstd-internal.h Compile on NetBSD
nonstd-makedev.c Fix newline warning
nonstd-pread.c Rationalize headers
nonstd-stat.c Consistent naming: sq_* -> sqfs_*
nonstd.h Rationalize headers
squashfs_fs.h Update Makefile
squashfuse.1 Fix manpage
squashfuse.h Rationalize headers
stack.c First stab at pathnames in traverse
stack.h Rationalize headers
swap.c __le64/uint64_t may give the compiler a headache
swap.h Rationalize headers
table.c Rationalize headers
table.h Rationalize headers
traverse.c Windows doesn't like strncat()
traverse.h Rationalize headers
util.c Works on Windows!
util.h Works on Windows!
xattr.c Rationalize headers
xattr.h Rationalize headers


         squashfuse - Mount SquashFS archives using FUSE


Squashfuse lets you mount SquashFS archives in user-space. It supports almost
all features of the SquashFS format, yet is still fast and memory-efficient. So
that everyone can use it, squashfuse supports many different operating systems
and is available under a permissing license.

SquashFS is an efficiently compressed, read-only storage format. Support for it
has been built into the Linux kernel since 2009. It is very common on Live CDs
and embedded Linux distributions.

Quick start:
  $ ./configure && make
  $ ./squashfuse foo.squashfs mountpoint

1. Table of contents
0. Introduction
1. Table of contents
2. Getting started
   - System requirements
   - Getting the source
   - Building
   - Usage
3. About squashfuse
   - Is squashfuse for you?
   - What's included?
   - Features
   - Known bugs
4. References
   - Licensing
   - Acknowledgements
   - Links

2. Getting started

2a. System requirements
To build and use squashfuse, you must be able to use the terminal of your
operating system.

Runtime requirements:
  - FUSE 2.5 or later
  - At least one of the following compression libraries
      - zlib
      - lzo2
      - xz (aka. liblzma)
      - lz4
  - (optional) libattr, for better extended attribute support on Linux

Build requirements:
  - A C compiler
  - make (any variant)
  - sed
  - (optional) pkg-config, for detection of dependencies

To build from the development repository, rather than a tarball, you'll need:
  - autoconf 2.60 or later
  - automake 1.11 or later
  - libtool 2

Known fully-supported platforms:
  - Linux
  - Mac OS X
  - FreeBSD
  - NetBSD
  - OpenIndiana
  - Android
  - other platforms may work too!

For a precise list of packages you will need on your OS, and other platform
notes, please see the file `PLATFORMS'.

2b. Getting the source
The squashfuse distribution can be downloaded from SourceForge:

The development repository uses git, at GitHub:

2c. Installation
Squashfuse is built with the usual `configure && make'. If you need more
detailed instructions:

0. Ensure you're at your terminal, in the directory containing this README.

1. (if needed) If the file `configure' is already present, skip this step.
   Otherwise, run `./' to generate one.

2. Run `./configure' to set up the build. You can find useful configuration
   options in the file `CONFIGURATION', or by running `./configure --help'.

   If configure fails, check that you really have all the requirements
   installed. You may also want to check the `PLATFORMS' file to see if there
   are any special notes for your operating system.

3. Run `make' to build `squashfuse'.

4. (optional) If you want to use squashfuse in this directory, that's ok.
   But if you'd rather install it, run `make install'. If you need root
   privileges, `sudo make install' may work.

2d. Usage
You'll need a SquashFS archive to use squashfuse. If you don't already have
one, you can create one using the `mksquashfs' utility from the squashfs-tools

To create a SquashFS archive:
  $ mksquashfs DIRECTORY ARCHIVE

To mount a SquashFS archive with squashfuse:

To unmount when you're done:
  $ umount MOUNTPOINT         # On Mac/BSD
  $ fusermount -u MOUNTPOINT  # On Linux

For more options, see the man page squashfuse(1).

3. About squashfuse

3a. Is squashfuse for you?
Squashfuse is a great option if you have a SquashFS archive, and:
  - You're not running Linux, or
  - You don't have root access, or
  - You're too concerned about security to use root, or
  - You find it inconvenient to elevate privileges, or
  - SquashFS is not built into your kernel, but FUSE is, or
  - You want to hack on the SquashFS format without risking kernel panics.

Squashfuse is probably not the right tool for the job, if:
  - You don't have FUSE.
    More and more systems have FUSE, but some don't. Squashfuse requires it.
  - You have a very old SquashFS archive.
    Neither squashfuse nor the Linux kernel support SquashFS versions less
    than 4.0. Use `unsquashfs' from the squashfs-tools project.

  - You want to create or modify a SquashFS archive.
    Neither squashfuse nor the Linux kernel support write access, use
    `mksquashfs' from squashfs-tools.

  - You want to extract an entire SquashFS archive.
    If you don't want to mount anything, it's more efficient and convenient
    to just use unsquashfs.

  - You want your root filesystem `/' to be SquashFS.
    This isn't well-tested, though it may be possible.
  - You're highly concerned about bugs.
    The SquashFS kernel module has seen much more testing than squashfuse.

If you don't yet use SquashFS, consider starting, now that squashfuse exists.
For many uses, the chief drawbacks of SquashFS were requiring Linux and root
access, but squashfuse has that covered.

  - Use SquashFS for archival and backup, instead of tar.
    It offers faster creation (multi-core), and browsing without unpacking.
  - Use SquashFS instead of zip. 
    It has better compression, and faster directory lookup.
  - Use SquashFS instead of compressed disk images like DMG, uzip or Partimage.
    It has better compression and portability.

3b. What's included?
Squashfuse currently comprises three programs:

  * squashfuse      Allows you to mount a squashfs filesystem.
  * squashfuse_ll   Like `squashfuse', but implemented using the low-level
                    FUSE API. It's a tiny bit faster, but less portable.
  * squashfuse_ls   Lists all the files in a squashfs archive. A demonstration
                    of using the squashfuse core in the absence of FUSE.

3c. Features
Squashfuse supports the following SquashFS features: 
  - zlib, LZO, LZMA2 and LZ4 decompression
  - Fast, indexed directory lookup
  - Fast, indexed seeking within files
  - Caching of decompressed blocks
  - De-duplicated files
  - Sparse files
  - Extended attributes
  - Files larger than 4GB

Squashfuse is missing the following features:
  - LZMA1 compression (deprecated)
  - Support for SquashFS versions less than 4.0
  - Multi-core decompression

3c. Known bugs
- On 32-bit systems with a large inode cache, when mounting a large SquashFS
  archive created with the "-no-exports" option, squashfuse_ll may use a large
  amount of memory. This is due to a bug in the FUSE API, where ino_t is shrunk
  to 32-bits.

4. References

4a. Licensing
Squashfuse is copyright (c) 2012-2014 Dave Vasilevsky <>
Squashfuse is distributed under the 2-clause BSD license. See the file LICENSE
for details.

4b. Acknowledgements
Thanks to:

* Phillip Lougher, for designing the SquashFS format, and implementing support
  in the kernel. Also for providing permission to use and distribute
  squashfs_fs.h under a BSD-style license.

* Maël Kerbiriou, for implementing LZ4 support.

4c. Links
* SquashFS
  - SquashFS home page, includeing squashfs-tools:
  - squashfs-tools for non-Linux:

  - FUSE home page:
  - OSXFUSE (FUSE for Macs):

* Other implementations of the SquashFS format
  - Linux kernel:
  - 7-zip / p7zip:
  - GRUB 2 bootloader:
Something went wrong with that request. Please try again.