Add man pages for tools

9 files changed, 219 insertions, 2 deletions

diff --git a/.gitignore b/.gitignore
index 62b6ec1..b9b4f77 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,7 +33,7 @@ libtool
 py-compile
 stamp-h1
 src/.libs
-docs/*
+docs/html
 libimobiledevice-1.0.pc
 dev/.libs/*
 dev/afccheck
diff --git a/Makefile.am b/Makefile.am
index 586a02e..56e70bb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
 AUTOMAKE_OPTIONS = foreign
 ACLOCAL_AMFLAGS = -I m4
-SUBDIRS = src include fdi swig dev tools
+SUBDIRS = src include fdi swig dev tools docs
 
 DISTCHECK_CONFIGURE_FLAGS = --enable-dev-tools
 
diff --git a/configure.ac b/configure.ac
index 594ce21..fcabbca 100644
--- a/configure.ac
+++ b/configure.ac
@@ -147,6 +147,7 @@ fdi/Makefile
 dev/Makefile
 tools/Makefile
 swig/Makefile
+docs/Makefile
 libimobiledevice-1.0.pc
 doxygen.cfg
 ])
diff --git a/docs/idevice_id.1 b/docs/idevice_id.1
new file mode 100644
index 0000000..c06fb5e
--- /dev/null
+++ b/docs/idevice_id.1
@@ -0,0 +1,49 @@
+.TH "idevice_id" 1
+.SH NAME
+idevice_id \- Prints device name or a list of attached iPhone/iPod Touch devices.
+.SH SYNOPSIS
+.B idevice_id
+[OPTIONS] [UUID]
+
+.SH DESCRIPTION
+
+Prints device name or a list of attached iPhone/iPod Touch devices.
+The UUID is a 40-digit hexadecimal number of the device
+for which the name should be retrieved.
+
+.SH OPTIONS
+.TP
+.B \-l, \-\-list
+list UUID of all attached devices
+.TP 
+.B \-d, \-\-debug
+enable communication debugging.
+.TP 
+.B \-h, \-\-help
+prints usage information.
+.TP 
+
+.SH AUTHORS
+ Zach C.
+
+ Jonathan Beck
+
+ Matt Colyer
+
+ Martin Aumueller
+
+ Christophe Fergeau
+
+ Martin S.
+
+ Paul Sladen
+
+ Patrick Walton
+
+ Zoltan Balaton
+
+ Nikias Bassen
+
+ Todd Zullinger
+
+Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1
new file mode 100644
index 0000000..5ae867e
--- /dev/null
+++ b/docs/idevicebackup.1
@@ -0,0 +1,36 @@
+.TH "idevicebackup" 1
+.SH NAME
+idevicebackup \- Create or restore backup for iPhone/iPod Touch devices.
+.SH SYNOPSIS
+.B idevicebackup
+[OPTIONS] CMD [DIRECTORY]
+
+.SH DESCRIPTION
+
+Create or restore backup from the current or specified directory.
+
+.SH OPTIONS
+.TP
+.B \-u, \-\-uuid UUID
+target specific device by its 40-digit device UUID.
+.TP 
+.B \-d, \-\-debug
+enable communication debugging.
+.TP 
+.B \-h, \-\-help
+prints usage information.
+
+.SH COMMANDS
+.TP
+.B backup
+saves a device backup into DIRECTORY.
+.TP
+.B restore
+restores a device backup from DIRECTORY.
+
+.SH AUTHORS
+Martin Szulecki
+
+Nikias Bassen
+
+Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1
new file mode 100644
index 0000000..55d81e9
--- /dev/null
+++ b/docs/ideviceimagemounter.1
@@ -0,0 +1,41 @@
+.TH "ideviceimagemounter" 1
+.SH NAME
+ideviceimagemounter \- Mount disk images on the iPhone/iPod Touch.
+.SH SYNOPSIS
+.B ideviceimagemounter
+[OPTIONS] IMAGE_FILE IMAGE_SIGNATURE_FILE
+
+.SH DESCRIPTION
+
+Mounts the specified disk image on the iPhone/iPod Touch device.
+
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+enable communication debugging.
+.TP
+.B \-u, \-\-uuid UUID
+target specific device by its 40-digit device UUID.
+.TP
+.B \-l, \-\-list
+list mount information
+.TP
+.B \-t, \-\-imagetype NAME
+the image type to use, default is 'Developer'
+.TP
+.B \-x, \-\-xml
+use XML output
+.TP
+.B \-h, \-\-help
+prints usage information
+.TP
+.B IMAGE_FILE
+the image filename to mount
+.TP
+.B IMAGE_SIGNATURE_FILE
+corresponding signature file for image filename
+
+.SH AUTHOR
+Nikias Bassen
+
+Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/ideviceinfo.1 b/docs/ideviceinfo.1
new file mode 100644
index 0000000..e350dd0
--- /dev/null
+++ b/docs/ideviceinfo.1
@@ -0,0 +1,35 @@
+.TH "ideviceinfo" 1
+.SH NAME
+ideviceinfo \- Show information about the first connected iPhone/iPod Touch.
+.SH SYNOPSIS
+.B ideviceinfo
+[OPTIONS]
+
+.SH DESCRIPTION
+
+Show information about the first connected iPhone/iPod Touch.
+
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+enable communication debugging.
+.TP
+.B \-u, \-\-uuid UUID
+target specific device by its 40-digit device UUID.
+.TP
+.B \-q, \-\-domain NAME
+set domain of query to NAME. Default: None.
+.TP
+.B \-k, \-\-key NAME
+only query key specified by NAME. Default: All keys.
+.TP
+.B \-x, \-\-xml
+output information as xml plist instead of key/value pairs.
+.TP
+.B \-h, \-\-help
+prints usage information
+
+.SH AUTHOR
+Martin Szulecki
+
+Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicescreenshot.1 b/docs/idevicescreenshot.1
new file mode 100644
index 0000000..cf0ed15
--- /dev/null
+++ b/docs/idevicescreenshot.1
@@ -0,0 +1,29 @@
+.TH "idevicescreenshot" 1
+.SH NAME
+idevicescreenshot \- Gets a screenshot from the connected iPhone/iPod Touch.
+.SH SYNOPSIS
+.B idevicescreenshot
+[OPTIONS]
+
+.SH DESCRIPTION
+
+Gets a screenshot from the connected iPhone/iPod Touch.
+
+NOTE: A mounted developer disk image is required on the device, otherwise
+ the screenshotr service is not available.
+
+.SH OPTIONS
+.TP
+.B \-d, \-\-debug
+enable communication debugging.
+.TP
+.B \-u, \-\-uuid UUID
+target specific device by its 40-digit device UUID.
+.TP
+.B \-h, \-\-help
+prints usage information
+
+.SH AUTHOR
+Nikias Bassen
+
+Man page written to conform with Debian by Julien Lavergne.
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1
new file mode 100644
index 0000000..178d7c5
--- /dev/null
+++ b/docs/idevicesyslog.1
@@ -0,0 +1,26 @@
+.TH "idevicesyslog" 1
+.SH NAME
+idevicesyslog \- Relay syslog of a connected iPhone/iPod Touch.
+.SH SYNOPSIS
+.B idevicesyslog
+[OPTIONS]
+
+.SH DESCRIPTION
+
+Relay syslog of a connected iPhone/iPod Touch.
+
+.SH OPTIONS
+.TP 
+.B \-d, \-\-debug
+enable communication debugging.
+.TP
+.B \-u, \-\-uuid UUID
+target specific device by its 40-digit device UUID
+.TP 
+.B \-h, \-\-help
+prints usage information.
+
+.SH AUTHOR
+Martin Szulecki
+
+Man page written to conform with Debian by Julien Lavergne.