summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README87
1 files changed, 49 insertions, 38 deletions
diff --git a/README b/README
index dd43b88..07710d4 100644
--- a/README
+++ b/README
@@ -1,50 +1,54 @@
-INSTALLATION
-================================================================================
+About
+=====
-For:
- Apple iPhone, iPod Touch, iPad and Apple TV devices
+A fuse filesystem implementation to access the contents of iOS devices.
-You must have:
+Requirements
+============
+
+Development Packages of:
+ libfuse (and the associated kernel modules)
libimobiledevice
- libfuse-dev (and the associated kernel modules)
- libglib2.0-dev
+ libplist
+
+Software:
+ usbmuxd
make
autoheader
automake
autoconf
+ libtool
+ pkg-config
gcc
+Installation
+============
+
To compile run:
./autogen.sh
./configure
make
- sudo make install # (if you want to install it into your system directories)
-
-On Ubuntu/Debian, you can do:
- sudo apt-get install build-essential automake autoconf \
- libfuse-dev libglib2.0-dev
-
-(make sure that you have compiled libimobiledevice first)
+ sudo make install
+Of course you could already use the tool from the src/ directory locally.
-USAGE
-================================================================================
+Usage
+=====
-Now comes the fun bit!
-
-To mount:
+To mount the media partition from the device:
$ ifuse <mountpoint>
Note:
- If you mount your device as regular user, system migth complain that file
- /etc/fuse.conf is not readable. It means you do not belong to the 'fuse'
- group (see below).
+ If you mount your device as regular user, the system might complain that
+ the file /etc/fuse.conf is not readable. It means you do not belong to the
+ 'fuse' group (see below).
+
+To unmount as a regular user you must run:
-To unmount you do:
$ fusermount -u <mountpoint>
-By default, iFuse (via the AFC protocol) gives access to the '/var/root/Media/'
+By default, ifuse (via the AFC protocol) gives access to the '/var/root/Media/'
chroot on the device (containing music/pictures). This is the right and safe
way to access the device. However, if the device has been jailbroken, a full
view of the device's filesystem might be available using the following command
@@ -57,9 +61,9 @@ AFC2 service on the device to enable root filesystem usage. For instance
blackra1n does not install it and thus does not enable root filesystem access!
Use with care as the AFC protocol was not made to access the root filesystem.
-If using libimobiledevice >= 1.1.0, ifuse can be used with the iTunes
+If using libimobiledevice >= 1.1.0, ifuse can also be used with the iTunes
file/document sharing feature. It allows you to exchange files with an
-application on the device direclty through it's documents folder by specifing
+application on the device directly through it's documents folder by specifing
the application identifier like this:
$ ifuse --appid <appid> <mountpoint>
@@ -72,7 +76,8 @@ Addtional help can be shown using:
$ ifuse --help
-==== Setting up FUSE ====
+Setting up FUSE
+===============
Note that on some systems, you may have to load the 'fuse' kernel
module first and to ensure that you are a member of the 'fuse' group:
@@ -87,20 +92,27 @@ You can check your membership of the 'fuse' group with:
If you have just added yourself, you will need to logout and log back
in for the group change to become visible.
-== Who/what/where? ==
+Who/What/Where?
+===============
+
+Home:
+ http://www.libimobiledevice.org
-web:
- http://libimobiledevice.org
+Code:
+ git clone http://git.sukimashita.com/ifuse.git
-code:
- git clone git://cgit.sukimashita.com/ifuse.git/
+Code (Mirror):
+ git clone https://github.com/libimobiledevice/ifuse.git
-tickets:
- http://libiphone.lighthouseapp.com/
+Tickets:
+ https://github.com/libimobiledevice/ifuse/issues
-mailing list:
+Mailing List:
http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
+IRC:
+ irc://irc.freenode.net#libimobiledevice
+
Credits
=======
@@ -108,6 +120,5 @@ Apple, iPhone, iPod, iPad, Apple TV and iPod Touch are trademarks of Apple Inc.
ifuse is an independent software program and has not been
authorized, sponsored, or otherwise approved by Apple Inc.
-README updated on:
- 2011-01-09
-
+README Updated on:
+ 2013-11-12