| Index: emcore/trunk/tools/emcorefs/README |
| — | — | @@ -0,0 +1,78 @@ |
| | 2 | + ____ ___ ____ _____ _____ ____
|
| | 3 | + ___ _ __ ___ / ___/ _ \| _ \| ____| ___/ ___|
|
| | 4 | + / _ \ '_ ` _ \| | | | | | |_) | _| | |_ \___ \
|
| | 5 | + | __/ | | | | | |___ |_| | _ <| |___| _| ___) |
|
| | 6 | + \___|_| |_| |_|\____\___/|_| \_\_____|_| |____/
|
| | 7 | +
|
| | 8 | +emCOREFS is a FUSE-based filesystem that uses emCORE's Monitor API
|
| | 9 | +to provide communication with device's FS. It is still in very early
|
| | 10 | +state, but some features (directory listing, reading files) are done.
|
| | 11 | +
|
| | 12 | +For communication with the device, this application uses libusb 1.0.
|
| | 13 | +
|
| | 14 | +Building
|
| | 15 | +--------
|
| | 16 | +You need:
|
| | 17 | +1. GCC/Make
|
| | 18 | +2. pkg-config
|
| | 19 | +3. libusb >= 1.0
|
| | 20 | +4. libfuse >= 2.8
|
| | 21 | +5. maybe other packages
|
| | 22 | +
|
| | 23 | +Compiling:
|
| | 24 | +make - standard build, no debug messages, only fatal errors on
|
| | 25 | + startup are shown.
|
| | 26 | +make debug - debug build, some debug/error messages are shown.
|
| | 27 | + libusb debug messages are enabled, too.
|
| | 28 | +
|
| | 29 | +Testing:
|
| | 30 | +make test - run the build without FUSE debugging messages, going
|
| | 31 | + into the background if it connects to the device successfully.
|
| | 32 | +make testdebug - run the build in the foreground, showing FUSE debug
|
| | 33 | + messages in the terminal.
|
| | 34 | +
|
| | 35 | +Running
|
| | 36 | +-------
|
| | 37 | +You need FUSE >= 2.8 installed.
|
| | 38 | +Currently only tested on Linux (Ubuntu 11.04 in my case). Maybe an
|
| | 39 | +OSX-compatible version would appear at some point.
|
| | 40 | +Starting: ./emcorefs <mountpoint>
|
| | 41 | +Stopping: fusermount -u <mountpoint as seen in /etc/mtab>
|
| | 42 | +
|
| | 43 | +Known bugs/issues
|
| | 44 | +-----------------
|
| | 45 | +* Read-only support at the moment.
|
| | 46 | +* Running FUSE with multithreading breaks file reading because of
|
| | 47 | + the way these are implemented on emCORE's side.
|
| | 48 | + Workaround: use the "-s" option.
|
| | 49 | +* Most errors are not handled properly, EIO (Input/output error) is
|
| | 50 | + given in many cases where there's a more descriptive error
|
| | 51 | + message available. Will be fixed in the future.
|
| | 52 | +
|
| | 53 | +Future plans
|
| | 54 | +------------
|
| | 55 | +* Implement write support.
|
| | 56 | +* Merge some functions that are doing similar tasks to reduce code
|
| | 57 | + duplication. Return proper error codes in FS operations.
|
| | 58 | +
|
| | 59 | +Bug reporting
|
| | 60 | +-------------
|
| | 61 | +Main developer: Vencislav "user890104" Atanasov
|
| | 62 | +How to contact: http://www.freemyipod.org/wiki/Contact
|
| | 63 | +
|
| | 64 | +License terms
|
| | 65 | +-------------
|
| | 66 | +emCOREFS is distributed under the same license terms as emCORE.
|
| | 67 | +
|
| | 68 | +emCORE is free software: you can redistribute it and/or
|
| | 69 | +modify it under the terms of the GNU General Public License as
|
| | 70 | +published by the Free Software Foundation, either version 2 of the
|
| | 71 | +License, or (at your option) any later version.
|
| | 72 | +
|
| | 73 | +emCORE is distributed in the hope that it will be useful,
|
| | 74 | +but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| | 75 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
| | 76 | +See the GNU General Public License for more details.
|
| | 77 | +
|
| | 78 | +You should have received a copy of the GNU General Public License
|
| | 79 | +along with emCORE. If not, see <http://www.gnu.org/licenses/>.
|
