summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am3
-rw-r--r--docs/usbmuxd.880
2 files changed, 83 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..70a61ca
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,3 @@
1man_MANS = usbmuxd.8
2
3EXTRA_DIST = $(man_MANS)
diff --git a/docs/usbmuxd.8 b/docs/usbmuxd.8
new file mode 100644
index 0000000..590afdc
--- /dev/null
+++ b/docs/usbmuxd.8
@@ -0,0 +1,80 @@
1.TH "usbmuxd" 8
2.SH NAME
3usbmuxd \- Expose a socket to multiplex connections from and to iOS devices.
4.SH SYNOPSIS
5.B usbmuxd
6[OPTIONS]
7
8.SH DESCRIPTION
9
10usbmuxd stands for "USB multiplexing daemon". This daemon is in charge of
11multiplexing connections over USB to an iOS device. To users, it means
12you can sync your music, contacts, photos, etc. over USB. To developers, it
13means you can connect to any listening localhost socket on the device. usbmuxd
14is not used for tethering data transfer which uses a dedicated USB interface as
15a virtual network device. Multiple connections to different TCP ports can happen
16in parallel. The higher-level layers are handled by libimobiledevice.
17
18When usbmuxd is running (normally started, or stopped as a result of "udev"
19auto-insertion messages or by systemd) it provides a socket interface in
20"/var/run/usbmuxd" that is designed to be compatible with the socket interface
21that is provided on Mac OS X.
22
23You should also create a "usbmux" user that has access to USB devices on your
24system. Alternatively, you can pass a different username using the -U argument.
25
26Due to iOS 7 the daemon now also manages pairing records with iOS devices and
27the host in "/var/lib/lockdown" (Linux) or "/var/db/lockdown" (Mac OS X).
28Ensure proper permissions are setup for the daemon to access the directory.
29
30.SH OPTIONS
31.TP
32.B \-U, \-\-user USER
33Change to this user after startup (needs USB privileges).
34.TP
35.B \-f, \-\-foreground
36Do not daemonize (implies one -v).
37.TP
38.B \-n, \-\-disable-hotplug
39Disables automatic discovery of devices on hotplug. Starting another instance
40will trigger discovery instead.
41.TP
42.B \-z, \-\-enable-exit
43Enable "--exit" request from other instances and exit automatically if no
44device is attached.
45.TP
46.B \-u, \-\-udev
47Run in udev operation mode (implies -n and -z).
48.TP
49.B \-s, \-\-systemd
50Run in systemd operation mode (implies -z and -f).
51.TP
52.B \-x, \-\-exit
53Notify a running instance to exit if there are no devices connected (sends
54SIGUSR1 to running instance) and exit.
55.TP
56.B \-X, \-\-force-exit
57Notify a running instance to exit even if there are still devices connected
58(always works) and exit.
59.TP
60.B \-v, \-\-verbose
61be verbose (use twice or more to increase verbose level).
62.TP
63.B \-V, \-\-version
64print version information and exit.
65.TP
66.B \-h, \-\-help
67prints usage information.
68
69.SH AUTHOR
70The first usbmuxd daemon implementation was authored by Hector Martin.
71
72Now mainly developed by Nikias Bassen, Martin Szulecki and contributors (see AUTHORS file).
73
74.SH SEE ALSO
75idevice_id(1), iproxy(1).
76
77.SH ON THE WEB
78https://libimobiledevice.org
79
80https://github.com/libimobiledevice/usbmuxd