diff options
| -rw-r--r-- | README.md (renamed from README) | 83 |
1 files changed, 34 insertions, 49 deletions
| @@ -1,10 +1,10 @@ | |||
| 1 | About | 1 | # usbmud |
| 2 | ===== | 2 | |
| 3 | ## About | ||
| 3 | 4 | ||
| 4 | A socket daemon to multiplex connections from and to iOS devices. | 5 | A socket daemon to multiplex connections from and to iOS devices. |
| 5 | 6 | ||
| 6 | Background | 7 | ## Background |
| 7 | ========== | ||
| 8 | 8 | ||
| 9 | usbmuxd stands for "USB multiplexing daemon". This daemon is in charge of | 9 | usbmuxd stands for "USB multiplexing daemon". This daemon is in charge of |
| 10 | multiplexing connections over USB to an iOS device. To users, it means | 10 | multiplexing connections over USB to an iOS device. To users, it means |
| @@ -26,34 +26,35 @@ Due to iOS 7 the daemon now also manages pairing records with iOS devices and | |||
| 26 | the host in "/var/lib/lockdown" (Linux) or "/var/db/lockdown" (Mac OS X). | 26 | the host in "/var/lib/lockdown" (Linux) or "/var/db/lockdown" (Mac OS X). |
| 27 | Ensure proper permissions are setup for the daemon to access the directory. | 27 | Ensure proper permissions are setup for the daemon to access the directory. |
| 28 | 28 | ||
| 29 | Requirements | 29 | ## Requirements |
| 30 | ============ | ||
| 31 | 30 | ||
| 32 | Development Packages of: | 31 | Development Packages of: |
| 33 | libimobiledevice | 32 | * libimobiledevice |
| 34 | libplist | 33 | * libplist |
| 35 | libusb | 34 | * libusb |
| 36 | 35 | ||
| 37 | Software: | 36 | Software: |
| 38 | make | 37 | make |
| 39 | autoheader | 38 | autoheader |
| 40 | automake | 39 | automake |
| 41 | autoconf | 40 | autoconf |
| 42 | libtool | 41 | libtool |
| 43 | pkg-config | 42 | pkg-config |
| 44 | gcc | 43 | gcc |
| 45 | udev (Linux only) | 44 | udev (Linux only) |
| 46 | 45 | ||
| 47 | Optional: | 46 | Optional: |
| 48 | systemd (Linux only) | 47 | systemd (Linux only) |
| 49 | 48 | ||
| 50 | Installation | 49 | ## Installation |
| 51 | ============ | ||
| 52 | 50 | ||
| 53 | To compile run: | 51 | To compile run: |
| 54 | ./autogen.sh | 52 | |
| 55 | make | 53 | ```bash |
| 56 | sudo make install | 54 | ./autogen.sh |
| 55 | make | ||
| 56 | sudo make install | ||
| 57 | ``` | ||
| 57 | 58 | ||
| 58 | The daemon is automatically started by udev or systemd depending on what you | 59 | The daemon is automatically started by udev or systemd depending on what you |
| 59 | have configured it on hotplug of an iOS device and exits if the last device | 60 | have configured it on hotplug of an iOS device and exits if the last device |
| @@ -62,32 +63,17 @@ was unplugged. | |||
| 62 | For debugging purposes it is helpful to start usbmuxd using the foreground '-f' | 63 | For debugging purposes it is helpful to start usbmuxd using the foreground '-f' |
| 63 | argument and enable verbose mode '-v' to get suitable logs. | 64 | argument and enable verbose mode '-v' to get suitable logs. |
| 64 | 65 | ||
| 65 | Who/What/Where? | 66 | ## Who/What/Where? |
| 66 | =============== | ||
| 67 | |||
| 68 | Home: | ||
| 69 | http://www.libimobiledevice.org/ | ||
| 70 | |||
| 71 | Code: | ||
| 72 | git clone http://git.libimobiledevice.org/usbmuxd.git | ||
| 73 | |||
| 74 | Code (Mirror): | ||
| 75 | git clone https://github.com/libimobiledevice/usbmuxd.git | ||
| 76 | |||
| 77 | Tickets: | ||
| 78 | http://github.com/libimobiledevice/usbmuxd/issues | ||
| 79 | |||
| 80 | Mailing List: | ||
| 81 | http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel | ||
| 82 | |||
| 83 | IRC: | ||
| 84 | irc://irc.freenode.net#libimobiledevice | ||
| 85 | 67 | ||
| 86 | Twitter: | 68 | * Home: http://www.libimobiledevice.org/ |
| 87 | https://twitter.com/libimobiledev | 69 | * Code: `git clone http://git.libimobiledevice.org/usbmuxd.git` |
| 70 | * Code (Mirror): `git clone https://github.com/libimobiledevice/usbmuxd.git` | ||
| 71 | * Tickets: http://github.com/libimobiledevice/usbmuxd/issues | ||
| 72 | * Mailing List: http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel | ||
| 73 | * IRC: irc://irc.freenode.net#libimobiledevice | ||
| 74 | * Twitter: https://twitter.com/libimobiledev | ||
| 88 | 75 | ||
| 89 | Credits | 76 | ## Credits |
| 90 | ======= | ||
| 91 | 77 | ||
| 92 | The first usbmuxd daemon implementation was authored by Hector Martin. | 78 | The first usbmuxd daemon implementation was authored by Hector Martin. |
| 93 | 79 | ||
| @@ -95,5 +81,4 @@ Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. | |||
| 95 | libimobiledevice is an independent software library and has not been | 81 | libimobiledevice is an independent software library and has not been |
| 96 | authorized, sponsored, or otherwise approved by Apple Inc. | 82 | authorized, sponsored, or otherwise approved by Apple Inc. |
| 97 | 83 | ||
| 98 | README Updated on: | 84 | README Updated on: 2015-12-13 |
| 99 | 2015-01-28 | ||
