Add man page for usbmuxd daemon

4 files changed, 74 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index 789b9b0..a5c0fa5 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,8 @@
 AUTOMAKE_OPTIONS = foreign
 ACLOCAL_AMFLAGS = -I m4
-SUBDIRS = src $(UDEV_SUB) $(SYSTEMD_SUB)
+SUBDIRS = src $(UDEV_SUB) $(SYSTEMD_SUB) docs
+
+EXTRA_DIST = docs
 
 DISTCHECK_CONFIGURE_FLAGS =                             \
         --with-udevrulesdir=$$dc_install_base/$(udevrulesdir) \
diff --git a/configure.ac b/configure.ac
index cd43a97..b89b286 100644
--- a/configure.ac
+++ b/configure.ac
@@ -144,6 +144,7 @@ Makefile
 src/Makefile
 udev/Makefile
 systemd/Makefile
+docs/Makefile
 ])
 
 echo -n "
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..12e0e57
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,3 @@
+man_MANS = usbmuxd.1
+
+EXTRA_DIST = $(man_MANS)
diff --git a/docs/usbmuxd.1 b/docs/usbmuxd.1
new file mode 100644
index 0000000..cfea4f7
--- /dev/null
+++ b/docs/usbmuxd.1
@@ -0,0 +1,67 @@
+.TH "usbmuxd" 1
+.SH NAME
+usbmuxd \- Expose a socket to multiplex connections from and to iOS devices.
+.SH SYNOPSIS
+.B usbmuxd
+[OPTIONS]
+
+.SH DESCRIPTION
+
+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.
+
+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 Mac OS X.
+
+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.
+
+Due to iOS 7 the daemon now also manages pairing records with iOS devices and
+the host in "/var/lib/lockdown" (Linux) or "/var/db/lockdown" (Mac OS X).
+Ensure proper permissions are setup for the daemon to access the directory.
+
+.SH OPTIONS
+.TP
+.B \-U, \-\-user USER
+change to this user after startup (needs USB privileges).
+.TP
+.B \-u, \-\-udev
+run in udev operation mode (USB hotplug will be signaled to the daemon using udev).
+.TP
+.B \-x, \-\-exit
+tell a running instance to exit if there are no devices connected.
+.TP 
+.B \-X, \-\-force-exit
+tell a running instance to exit, even if there are still devices connected (always works).
+.TP 
+.B \-f, \-\-foreground
+do not daemonize (implies one -v).
+.TP 
+.B \-v, \-\-verbose
+be verbose (use twice or more to increase verbose level).
+.TP 
+.B \-V, \-\-version
+print version information and exit.
+.TP 
+.B \-h, \-\-help
+prints usage information.
+
+.SH AUTHOR
+The first usbmuxd daemon implementation was authored by Hector Martin.
+
+Now mainly developed by Nikias Bassen, Martin Szulecki and contributors (see AUTHORS file).
+
+.SH SEE ALSO
+
+http://www.libimobiledevice.org
+
+http://github.com/libimobiledevice/usbmuxd/
+
+idevice_id(1), iproxy(1).