1FUSECOMPRESS(1) Compressed filesystem FUSECOMPRESS(1)
2
6 fusecompress - mounts an compressed virtual filesystem
7
9 fusecompress [OPTION]... rootDir mountPoint
10
12 FuseCompress creates a virtual compressed filesystem which stores com‐
13 pressed data in the rootDir directory and makes the uncompressed data
14 visible at the mountPoint directory.
15 Compression type (or uncompressed state) of files in the rootDir is not
17 changed during work. Use fusecompress_offline if you want to decompress
18 file(s) or change compression type of the file(s).
19 Examples:
21 Storage directory is /tmp/fc and mount point is /mnt/fc in all follow‐
23 ing examples.
24 o Mount directory
26 fusecompress /tmp/fc /mnt/fc
28 o Unmount directory
30 fusermount -u /mnt/fc
32 Tips and tricks:
34 How to obtain compression ratio?
36 o Run this command in the mountPoint directory when mounted
38 with FuseCompress:
39 du -sh # actual size on disk
41 du -sh --apparent-size # actual size of files
42 File and magic utilities:
44 Put this config into ~/.magic or /etc/magic file to allow file utility
46 recognize FuseCompress file format:
47 0 string \037\135\211 FuseCompress(ed) data
49
52 -h, --help
53 Prints help.
54 -v, --version
56 Prints version.
57 -o, --options
59 fc_c:arg set compression method (lzo/bzip2/zlib/lzma)
61 (default:zlib)
62 fc_b:arg set size of the blocks in kilobytes (default:100)
64 fc_d run in debug mode
66 fc_ma:"arg1;arg2" files with passed mime types to be always not
68 compressed
69 fc_mr:"arg1;arg2" files with passed mime types to be always com‐
71 pressed
72 Other options are passed directly to the fuse library. See fuse
74 documentation for full list of supported options.
75 Useful parameters for fuse library:
77 Fuse library must be configured to support this features - con‐
79 figuration file /etc/fuse.conf must contains at least this
80 option: user_allow_other.
81 allow_other
83 This option overrides the security measure restricting file
85 access to the user mounting the filesystem. So all users
86 (including root) can access the files. This option is by default
87 only allowed to root, but this restriction can be removed with a
88 configuration option described in the previous section.
89 allow_root
91 This option is similar to 'allow_other' but file access is lim‐
93 ited to the user mounting the filesystem and root. This option
94 and 'allow_other' are mutually exclusive.
95 nonempty
97 This option allows you to use the same directory for rootDir and
99 mountPoint.
100 Lzo is the fastest, bzip2 has high compression ratio, but it is
102 the slowest, zlib is somewhere between them in terms of speed
103 and compression ratio and lzma has highest compression ratio,
104 it's compression speed is better than bzip2 and decompression is
105 fast. The none compression method is there for testing only as
106 it doesn't compress data, it copies the data without any modifi‐
107 cation (fusecompress' header is added).
108 Block size influences compression ratio. Bigger block size
110 allows better compression ratio, but random access to data will
111 be slower and memory requirements will be bigger.
112
115 This program is distributed in the hope that it will be useful, but
116 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
117 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
118 "COPYING" file distributed with fusecompress for complete details.
119
121 fusecompress was written by Milan Svoboda <milan.svoboda@centrum.cz>.
122
124 fusecompress_offline
1251.99.16 2008-06-06 FUSECOMPRESS(1)