|
| 1 | +FuseCompress |
| 2 | +============ |
| 3 | + |
| 4 | +http://fusecompress.googlecode.com/ |
| 5 | + |
| 6 | + |
| 7 | +We are not responsible for any badness that may happen to you while using |
| 8 | +this software. |
| 9 | + |
| 10 | +NEWS |
| 11 | +~~~~ |
| 12 | + 0.9.2 The source code is arranged in folders. Update man pages. Developments documents. Don't inline function. |
| 13 | + 0.9.1.1 Buffer overflow from command line parsing fixed. Fix bug that |
| 14 | + caused permition problems on read-only files. |
| 15 | + 0.9.1 File format has been changed. It allows better cooperation with |
| 16 | + file and magic utility. |
| 17 | + 0.9.0 First release that can be marked as stable. Many bugs fixed. |
| 18 | + 0.8.8 User can choose compression method via program parameter. |
| 19 | + 0.8.7 Correct rename bug, don't freeze on unmounting when in debug mode. |
| 20 | + 0.8.6 Correct time of last status chnage, correct cleaning during unmount. |
| 21 | + Remove hard-coded minimal filesize for compressing. |
| 22 | + 0.8.4 Support lzo compression. |
| 23 | + 0.8.3 Problem with files bigger than 2GB fixed. |
| 24 | + 0.8.2 Write-only bug corrected. |
| 25 | + 0.8.1 README updated. |
| 26 | + 0.8 Major update. New format for storing compressed files is used. |
| 27 | + |
| 28 | +LICENSE |
| 29 | +~~~~~~~ |
| 30 | +This program is distributed under the terms of the GNU Public License |
| 31 | +version 2. |
| 32 | + |
| 33 | +TODO |
| 34 | +~~~~ |
| 35 | +See http://code.google.com/p/fusecompress/issues/list |
| 36 | + |
| 37 | +INSTALLATION |
| 38 | +~~~~~~~~~~~~ |
| 39 | +To compile a release build, run |
| 40 | + |
| 41 | +./autogen.sh (If there is no "configure" file) |
| 42 | +./configure |
| 43 | +make |
| 44 | + |
| 45 | +For more information, see |
| 46 | +http://code.google.com/p/fusecompress/wiki/BuildHOWTO |
| 47 | + |
| 48 | +USAGE |
| 49 | +~~~~~ |
| 50 | + fusecompress [OPTIONS] /storage/directory [/mount/point] |
| 51 | + -h print this help |
| 52 | + -v print version |
| 53 | + -c lzo/bz2/gz/lzma/null choose default compression method |
| 54 | + -l LEVEL set compression level (1 to 9) |
| 55 | + -o ... pass arguments to fuse library |
| 56 | + |
| 57 | +You can mount filesystem over existing directory with files by omitting the |
| 58 | +last parameter. Files will be compressed when you work with filesystem. Even |
| 59 | +a simple 'find /storage' will compress them. Note that some of the last |
| 60 | +files found are not compressed - this increases performance on frequently |
| 61 | +accessed files. These files are compressed when the filesystem is unmounted |
| 62 | +or (if mounted with "-o noterm" (default for root)) when the fusecompress |
| 63 | +process receives a SIGTERM signal. |
| 64 | + |
| 65 | +Useful parameters for FUSE library: |
| 66 | + |
| 67 | +The FUSE library must be configured to support these features - the configuration |
| 68 | +file /etc/fuse.conf must contains at least the option "user_allow_other". |
| 69 | + |
| 70 | +allow_other |
| 71 | + |
| 72 | + This option overrides the security measure restricting file |
| 73 | + access to the user mounting the filesystem. So all users |
| 74 | + (including root) can access the files. This option is by |
| 75 | + default only allowed (and automatically enabled) for root, |
| 76 | + but this restriction can be removed with the configuration |
| 77 | + option described in the previous section. |
| 78 | + |
| 79 | +allow_root |
| 80 | + |
| 81 | + This option is similar to 'allow_other', but file access is limited |
| 82 | + to the user mounting the filesystem and root. This option and |
| 83 | + 'allow_other' are mutually exclusive. |
| 84 | + |
| 85 | +More information can be found at |
| 86 | +http://code.google.com/p/fusecompress/wiki/Usage |
| 87 | + |
| 88 | +TIPS AND TRICKS |
| 89 | +~~~~~~~~~~~~~~~ |
| 90 | +How can I find out about the compression ratio? |
| 91 | + |
| 92 | + Run this command in the FuseCompressed directory when mounted |
| 93 | + with FuseCompress: |
| 94 | + du -sh |
| 95 | + du -sh --apparent-size |
| 96 | + |
| 97 | + The first command prints the total uncompressed size of all |
| 98 | + files in the current directory and its subdirectories while |
| 99 | + the second one prints the total compressed size. |
| 100 | + |
| 101 | + When the FuseCompress filesystem is not mounted, run `ls -l |
| 102 | + my_file.dat` and compare the file size with the value |
| 103 | + obtained with `file my_file.dat`. |
| 104 | + |
| 105 | +File and magic utilities: |
| 106 | + |
| 107 | +Put this config file into ~/.magic or /etc/magic to allow the file utility |
| 108 | +to recognize the FuseCompress file format: |
| 109 | + |
| 110 | +0 string \037\135\211 FuseCompressed data |
| 111 | +>3 byte 0x00 (null format) |
| 112 | +>3 byte 0x01 (bz2 format) |
| 113 | +>3 byte 0x02 (gz format) |
| 114 | +>3 byte 0x03 (lzo format) |
| 115 | +>3 byte 0x04 (lzma format) |
| 116 | +>3 byte >0x04 (unknown format) |
| 117 | +>4 long x uncompressed size: %d |
| 118 | + |
| 119 | +AUTHORS |
| 120 | +~~~~~~~ |
| 121 | +Milan Svoboda < [email protected]> (original author) |
| 122 | +Anders Aagaard < [email protected]> (direct compress feature) |
| 123 | +Ulrich Hecht < [email protected]> (LZMA module, tools, test suite, bugfixes, maintainer) |
| 124 | + |
| 125 | +Feel free to contact Ulrich Hecht with suggestions and bug reports. |
| 126 | + |
| 127 | +Thanks to Dobos S�ndor for testing. |
| 128 | +Thanks to Roland Kletzing for exhaustive testing and suggestions. |
0 commit comments