From 096bb6ed89596b10efbdf6f732106ff5295449fd Mon Sep 17 00:00:00 2001
From: Paul Sladen
Date: Sun, 29 Mar 2009 19:46:08 +0200
Subject: [PATCH] Expand README

Signed-off-by: Nikias Bassen <nikias@gmx.li>
---
 README | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 51 insertions(+), 12 deletions(-)

(limited to 'README')

diff --git a/README b/README
index b36c0c0..42ca40a 100644
--- a/README
+++ b/README
@@ -1,26 +1,65 @@
-Build
-=====
+Background
+==========
+
+'usbmuxd' stands for "USB multiplexing daemon".  To the user/developer
+what it actually does is to proxy requests over a USB cable on directly
+to a listening TCP port on the iPhone.
+
+Multiple connections to different TCP ports can happen in parallel.
+An example (and useful) tool called 'iproxy' is included that allows
+you to forward localhost ports to the device---allows SSH over USB on
+jailbroken devices, or allowing access the lockdown daemon (and then
+to all of the file access, sync, notification and backup services
+running on the device).
+
+This higher-level layers are handled by libiphone.  The version of 
+libiphone compatible with the 'usbmuxd' infrastructure is called
+'libiphone-usbmuxd'.  'ifuse' is then able to sit on top of this.
+
+
+Building
+========
 
   make
+  sudo make install
+
 
-Use
-===
+Running (with magic)
+====================
 
-  sudo ./usbmuxd &
+  (Unplug + replug your iPhone)
   ./iproxy 2222 22 &
   ssh -p 2222 root@localhost
 
-Muwahahaha.  Hopefully you get the normal SSH login prompt.
+Hopefully you get the normal SSH login prompt.  You may still lots of
+debugging output for the moment.  If this is getting in the way of
+your ssh login, then run the 'ssh' command from a different xterminal
+or virtual console.
+
+
+Running (without magic)
+=======================
+
+If 'udev' is _not_ automatically running on your machine and picking
+up the new .rules file, you will need to start usbmuxd by hand first.
+Check it's running and that there is only one copy with 'ps aux | grep
+usbmuxd'.
+
+  sudo usbmuxd &
+  ./iproxy 2222 22 &
+  ssh -p 2222 root@localhost
 
 
-SSH
-===
+Tip: Starting SSH if disabled
+=============================
 
-If your iphone is rooted, but isn't running SSH, you will need to
-mount it with 'ifuse --afc2' (to access the root directory of the
-device).
+If your iphone is rooted, but SSH isn't started and you _cannot_ (for
+instance, cracked/broken screen) get to the Services control panel on
+the device, then you can start the SSH service over the USB by
+mounting the (jailbroken) filesystem.
 
-And then edit:
+You will need to mount it usbing 'ifuse --afc2' (to access the root
+directory of the device), and then edit:
 
   /Library/LaunchDaemons/com.openssh.sshd.plist
 
-- 
cgit v1.1-32-gdbae