README.md
1ABOUT
2=====
3
4SIMPLE-MTPFS (Simple Media Transfer Protocol FileSystem) is a file system for
5Linux (and other operating systems with a FUSE implementation, such as Mac OS X
6or FreeBSD) capable of operating on files on MTP devices attached via USB to
7local machine. On the local computer where the SIMPLE-MTPFS is mounted, the
8implementation makes use of the FUSE (Filesystem in Userspace) kernel module.
9The practical effect of this is that the end user can seamlessly interact with
10MTP device files.
11
12LATEST VERSION
13==============
14
15Latest sources of the software can be found at: [simple-mtpfs][]
16
17INSTALLATION
18============
19
20Simple-mtpfs depends on fuse (version >= **2.7.3**) and libmtp. It also
21requires the C++ compiler to support **C++11** standard.
22
23To install the driver, follow these steps:
24
25 $ mkdir build && cd build
26 $ ../configure
27 $ make
28 $ make install (as root)
29
30Due to MTP nature, it is necessary to use a folder, where the temporary files
31downloaded will be downloaded. The project can be configured to use custom
32directory for such files. To configure the simple-mtpfs to use desired
33temporary directory, add `--with-tmpdir=TMPDIR` option to configure script.
34Default value for temporary directory is `/tmp`.
35
36If you got the sources from git repository, first you have to run:
37
38 $ ./autogen.sh
39
40MOUNTING
41========
42
43To mount MTP-based device to your local filesystem, simply run:
44
45 $ simple-mtpfs mountpoint [options]
46
47If you have more than one MTP device attached to the computer, it is possible
48to specify which device, you are willing to mount. Either by entering its **order
49number** or special file usually placed in `/dev`:
50
51MOUNTING BY NUMBER
52------------------
53
54 $ simple-mtpfs --device <number> mountpoint [options]
55
56Where the `<number>` should contain a numeric order of the device, you are
57about to mount. To get a list of all attached devices, execute following:
58
59 $ simple-mtpfs --list-devices
60 <number>: <device name>
61 <number>: <device name>
62 ...
63
64MOUNTING BY SPECIAL FILE
65------------------------
66
67Enter special device file as the first argument to simple-mtpfs. The special device
68file is usually named as `/dev/libmtp-*`.
69
70 $ simple-mtpfs <device> mountpoint [options]
71
72UNMOUNTING
73==========
74
75To unmount MTP device, execute following command:
76
77 $ fusermount -u <mountpoint>
78
79BUG REPORTS
80===========
81
82Report bugs to [phatina@gmail.com](mailto:phatina@gmail.com) or
83[simple-mtpfs issues][].
84
85[simple-mtpfs]: https://github.com/phatina/simple-mtpfs "simple-mtpfs repository on github"
86[simple-mtpfs issues]: https://github.com/phatina/simple-mtpfs/issues "Report a bug"
87