Prepare Makefile and README for release 0.5.0
[omfs_fuse.git] / README
blobf27eeadad0b72a843c372a06629b20e07c0d8055
1 README for omfs_fuse 
2 Bob Copeland <me@bobcopeland.com>
4 This is a reference implementation of the Optimized MPEG File System
5 using FUSE (File System in Userspace).  OMFS is a proprietary file 
6 system developed by SonicBlue and used by the Rio Karma and ReplayTV.
8 There is also a native Linux out-of-tree filesystem driver written
9 by myself.  The kernel driver is currently about 60% faster than this
10 FUSE implementation. Unlike the kernel driver, omfs_fuse has improved 
11 handling of continuation inodes, has a better block allocation algorithm,
12 supports ReplayTV filesystems with little-endian disk formats, and 
13 doesn't require building and installing a kernel module.
15 To use:
16     $ omfs [opts] -a <device-file> <mount-point>   # mount a device
17     $ fusermount -u <mount-point>                  # unmount
19 The filesystem is by default mounted read-write, but write support is
20 still somewhat experimental.  Use the "-o ro" mount option to enable 
21 read-only mode.