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