Move to Markdown file for README

This commit is contained in:
Samantha Arias 2019-10-07 19:00:43 -05:00 committed by Markus Birth
parent b55f7a85ba
commit f9aef61c30
Signed by: mbirth
GPG Key ID: A9928D7A098C3A9A

View File

@ -1,4 +1,4 @@
jmtpfs:
# jmtpfs
jmtpfs is a FUSE and libmtp based filesystem for accessing MTP (Media Transfer
Protocol) devices. It was specifically designed for exchaning files between
@ -14,16 +14,16 @@ Since it is meant as an Android file transfer utility, and I don't have
any non-Android MTP devices to test with, playlists and other non-file
based data are not supported.
Building and installing:
## Building and installing:
See the INSTALL file.
Usage:
## Usage:
Run jmtpfs with a directory as a parameter, and it will mount to that directory
the first MTP device it finds. You can then access the files on the device as
if it were a normal disk.
```
[jason@colossus ~]$ jmtpfs ~/mtp
Device 0 (VID=04e8 and PID=6860) is a Samsung GT-P7310/P7510/N7000/I9100/Galaxy Tab 7.7/10.1/S2/Nexus/Note.
Android device detected, assigning default bug flags
@ -46,32 +46,32 @@ burstlyImageCache Music Pictures test.txt
Hello Android!
[jason@colossus Internal Storage]$ rm test.txt
[jason@colossus Internal Storage]$
```
Pass the -l option will list the attached MTP devices.
```
[jason@colossus ~]$ workspace/jmtpfs/src/jmtpfs -l
Device 0 (VID=04e8 and PID=6860) is a Samsung GT-P7310/P7510/N7000/I9100/Galaxy Tab 7.7/10.1/S2/Nexus/Note.
Available devices (busLocation, devNum, productId, vendorId, product, vendor):
2, 19, 0x6860, 0x04e8, GT-P7310/P7510/N7000/I9100/Galaxy Tab 7.7/10.1/S2/Nexus/Note, Samsung
```
You can choose which device to mount with the -device option.
```
[jason@colossus ~]$ workspace/jmtpfs/src/jmtpfs -device=2,19 ~/mtp
Device 0 (VID=04e8 and PID=6860) is a Samsung GT-P7310/P7510/N7000/I9100/Galaxy Tab 7.7/10.1/S2/Nexus/Note.
Android device detected, assigning default bug flags
[jason@colossus ~]$ ls ~/mtp
Internal Storage
```
Unmount with fusermount.
```
[jason@colossus ~]$ ls ~/mtp
Internal Storage
[jason@colossus ~]$ fusermount -u ~/mtp
[jason@colossus ~]$ ls ~/mtp
[jason@colossus ~]$
```
Performance and implementation notes:
## Performance and implementation notes:
libmtp (and I assume the MTP protocol itself) doesn't support seeking within a
file or partial file reads or writes. You have to fetch or send the entire
@ -88,7 +88,7 @@ writing it back to the device under the new name, and then deleting the
original file. This makes renames, especially for large files, slow. This
has special significance when using rsync to copy files to the device. Rsync
copies to a temporary file, and then when the copy is complete it renames the
temporary file to the real filename. So when rsyncing to a jmtpfs filessystem,
temporary file to the real filename. So when rsyncing to a jmtpfs filesystem,
for each file, the data gets copied to the device, read back, and then copied
to the device again. There is a true rename (but not move) supported by libmtp,
but this appears to confuse some Android apps, so I don't use it. Image files,