README.md

   1 fuse-aexplorer
   2 ===============
   3
   4 A crude re-implementation of the Amiga Explorer protocol, for Linux/FUSE.
   5
   6 All knowledge of the protocol is either based on Mark Street's lxamiga or
   7 [lxamiga.pl](https://github.com/marksmanuk/lxamiga) or gained by
   8 monitoring communication between the original Windows version of
   9 Amiga Explorer and the Amiga side.
  10
  11 This software is highly experimental and use is fully AT YOUR OWN RISK.
  12 Please don't blame me or Cloanto or anyone if anything breaks.
  13
  14 If you experience any issues (and that's almost guaranteed), please use
  15 [Cloanto's official Windows software](https://www.amigaforever.com/ae/)
  16 instead. It's a great, stable software package.
  17
  18
  19 Usage:
  20 -------
  21
  22 ./fuse-aexplorer /mnt/amiga /dev/ttyUSB0 19200
  23
  24 cp -a myfile "/mnt/amiga/RAM\:Ram\ Disk/"
  25
  26
  27
  28
  29 DATA LOSS WARNING
  30 ==================
  31
  32 Comments and attributes without an equivalence in Linux are lost
  33 whenever a write operation (including changing attributes) is
  34 performed on a file.
  35
  36 I'm sure there's more, but I've forgotten about it.
  37
  38
  39
  40 Things that are broken
  41 =======================
  42
  43 A lot. The Amiga Explorer protocol really isn't meant to be used as
  44 a "network file system".
  45
  46 Examples:
  47
  48  - Reading only a part of a file isn't possible.
  49    There is a hack to only read the start of it, thus making Thunar
  50    and other GIO programs not get stuck completely.
  51
  52  - Changing a part of a file or appending data isn't possible - it
  53    has to be rewritten from scratch.
  54    We're buffering a file and send it when flush() is called.
  55
  56  - Setting a file's modification date can only be done when
  57    writing it from scratch.
  58    Use 'cp -a' to copy your files.
  59
  60  - Files and folders being deleted on the Amiga while we know that they
  61    exist (i.e. their attributes are cached) causes undefined behavior.
  62
  63  - And many more hacks!
  64    Really, go use the original software instead!
  65
  66
  67
  68 TODO
  69 =====
  70
  71 Search the code for TODO and NOTE.
  72
  73 :-)
  74
  75
  76
  77 Thanks
  78 =======
  79
  80 Cloanto for Amiga Explorer. Great stuff and a life saver.
  81
  82 Mark Street for lxamiga and
  83 [lxamiga.pl](https://github.com/marksmanuk/lxamiga) - this gave me a
  84 head start in understanding the protocol.
  85
  86
  87
  88 License
  89 ========
  90
  91 GNU General Public License v2 only.