summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Martin Szulecki2020-06-08 13:21:28 +0200
committerGravatar Martin Szulecki2020-06-08 13:21:28 +0200
commitc8a3d421acb27c14bca4f84021b9bd6aad2b62a1 (patch)
tree4fc0e24d3fcddd9718be351b6e64fdf0d0c9f5aa
parent32c626a1caaaeff98cd9a8abab4692bb9d8b3415 (diff)
downloadusbmuxd-c8a3d421acb27c14bca4f84021b9bd6aad2b62a1.tar.gz
usbmuxd-c8a3d421acb27c14bca4f84021b9bd6aad2b62a1.tar.bz2
Improve README.md content markdown, update links and credits
-rw-r--r--README.md32
1 files changed, 18 insertions, 14 deletions
diff --git a/README.md b/README.md
index 9a2d869..e5aab05 100644
--- a/README.md
+++ b/README.md
@@ -7,23 +7,28 @@ A socket daemon to multiplex connections from and to iOS devices.
## Background
usbmuxd stands for "USB multiplexing daemon". This daemon is in charge of
-multiplexing connections over USB to an iOS device. To users, it means
-you can sync your music, contacts, photos, etc. over USB. To developers, it
-means you can connect to any listening localhost socket on the device. usbmuxd
-is not used for tethering data transfer which uses a dedicated USB interface as
-a virtual network device. Multiple connections to different TCP ports can happen
-in parallel. The higher-level layers are handled by libimobiledevice.
+multiplexing connections over USB to an iOS device.
+
+To users, it means you can sync your music, contacts, photos, etc. over USB.
+
+To developers, it means you can connect to any listening localhost socket on the
+device. usbmuxd is not used for tethering data transfer which uses a dedicated
+USB interface as a virtual network device.
+
+Multiple connections to different TCP ports can happen in parallel.
+The higher-level layers are handled by libimobiledevice.
When usbmuxd is running (normally started or stopped as a result of _udev_
auto-insertion messages, or by _systemd_) it provides a socket interface in
`/var/run/usbmuxd` that is designed to be compatible with the socket interface
that is provided on macOS.
-You should also create a `usbmux` user that has access to USB devices on your
-system. Alternatively, you can pass a different username using the `-U` argument.
+You should also create an `usbmux` user that has access to USB devices on your
+system. Alternatively, just pass a different username using the `-U` argument.
The daemon also manages pairing records with iOS devices and the host in
`/var/lib/lockdown` (Linux) or `/var/db/lockdown` (macOS).
+
Ensure proper permissions are setup for the daemon to access the directory.
## Requirements
@@ -49,7 +54,6 @@ Optional:
## Installation
To compile run:
-
```bash
./autogen.sh
make
@@ -65,20 +69,20 @@ argument and enable verbose mode `-v` to get suitable logs.
## Who/What/Where?
-* Home: https://www.libimobiledevice.org/
+* Home: https://libimobiledevice.org/
* Code: `git clone https://git.libimobiledevice.org/usbmuxd.git`
* Code (Mirror): `git clone https://github.com/libimobiledevice/usbmuxd.git`
* Tickets: https://github.com/libimobiledevice/usbmuxd/issues
* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
-* IRC: irc://irc.freenode.net#libimobiledevice
* Twitter: https://twitter.com/libimobiledev
## Credits
-The first usbmuxd daemon implementation was authored by Hector Martin.
+The initial usbmuxd daemon implementation was authored by Hector Martin.
Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
-libimobiledevice is an independent software library and has not been
+
+usbmuxd is an independent software application and has not been
authorized, sponsored, or otherwise approved by Apple Inc.
-README Updated on: 2019-05-16
+README Updated on: 2020-06-08