diff options
-rw-r--r-- | README.md | 32 |
1 files changed, 18 insertions, 14 deletions
@@ -7,23 +7,28 @@ A socket daemon to multiplex connections from and to iOS devices. | |||
7 | ## Background | 7 | ## Background |
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. |
11 | you can sync your music, contacts, photos, etc. over USB. To developers, it | 11 | |
12 | means you can connect to any listening localhost socket on the device. usbmuxd | 12 | To users, it means you can sync your music, contacts, photos, etc. over USB. |
13 | is not used for tethering data transfer which uses a dedicated USB interface as | 13 | |
14 | a virtual network device. Multiple connections to different TCP ports can happen | 14 | To developers, it means you can connect to any listening localhost socket on the |
15 | in parallel. The higher-level layers are handled by libimobiledevice. | 15 | device. usbmuxd is not used for tethering data transfer which uses a dedicated |
16 | USB interface as a virtual network device. | ||
17 | |||
18 | Multiple connections to different TCP ports can happen in parallel. | ||
19 | The higher-level layers are handled by libimobiledevice. | ||
16 | 20 | ||
17 | When usbmuxd is running (normally started or stopped as a result of _udev_ | 21 | When usbmuxd is running (normally started or stopped as a result of _udev_ |
18 | auto-insertion messages, or by _systemd_) it provides a socket interface in | 22 | auto-insertion messages, or by _systemd_) it provides a socket interface in |
19 | `/var/run/usbmuxd` that is designed to be compatible with the socket interface | 23 | `/var/run/usbmuxd` that is designed to be compatible with the socket interface |
20 | that is provided on macOS. | 24 | that is provided on macOS. |
21 | 25 | ||
22 | You should also create a `usbmux` user that has access to USB devices on your | 26 | You should also create an `usbmux` user that has access to USB devices on your |
23 | system. Alternatively, you can pass a different username using the `-U` argument. | 27 | system. Alternatively, just pass a different username using the `-U` argument. |
24 | 28 | ||
25 | The daemon also manages pairing records with iOS devices and the host in | 29 | The daemon also manages pairing records with iOS devices and the host in |
26 | `/var/lib/lockdown` (Linux) or `/var/db/lockdown` (macOS). | 30 | `/var/lib/lockdown` (Linux) or `/var/db/lockdown` (macOS). |
31 | |||
27 | Ensure proper permissions are setup for the daemon to access the directory. | 32 | Ensure proper permissions are setup for the daemon to access the directory. |
28 | 33 | ||
29 | ## Requirements | 34 | ## Requirements |
@@ -49,7 +54,6 @@ Optional: | |||
49 | ## Installation | 54 | ## Installation |
50 | 55 | ||
51 | To compile run: | 56 | To compile run: |
52 | |||
53 | ```bash | 57 | ```bash |
54 | ./autogen.sh | 58 | ./autogen.sh |
55 | make | 59 | make |
@@ -65,20 +69,20 @@ argument and enable verbose mode `-v` to get suitable logs. | |||
65 | 69 | ||
66 | ## Who/What/Where? | 70 | ## Who/What/Where? |
67 | 71 | ||
68 | * Home: https://www.libimobiledevice.org/ | 72 | * Home: https://libimobiledevice.org/ |
69 | * Code: `git clone https://git.libimobiledevice.org/usbmuxd.git` | 73 | * Code: `git clone https://git.libimobiledevice.org/usbmuxd.git` |
70 | * Code (Mirror): `git clone https://github.com/libimobiledevice/usbmuxd.git` | 74 | * Code (Mirror): `git clone https://github.com/libimobiledevice/usbmuxd.git` |
71 | * Tickets: https://github.com/libimobiledevice/usbmuxd/issues | 75 | * Tickets: https://github.com/libimobiledevice/usbmuxd/issues |
72 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel | 76 | * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel |
73 | * IRC: irc://irc.freenode.net#libimobiledevice | ||
74 | * Twitter: https://twitter.com/libimobiledev | 77 | * Twitter: https://twitter.com/libimobiledev |
75 | 78 | ||
76 | ## Credits | 79 | ## Credits |
77 | 80 | ||
78 | The first usbmuxd daemon implementation was authored by Hector Martin. | 81 | The initial usbmuxd daemon implementation was authored by Hector Martin. |
79 | 82 | ||
80 | Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. | 83 | Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. |
81 | libimobiledevice is an independent software library and has not been | 84 | |
85 | usbmuxd is an independent software application and has not been | ||
82 | authorized, sponsored, or otherwise approved by Apple Inc. | 86 | authorized, sponsored, or otherwise approved by Apple Inc. |
83 | 87 | ||
84 | README Updated on: 2019-05-16 | 88 | README Updated on: 2020-06-08 |