From: Antonio Ospite <ospite@studenti.unina.it>
Date: Thu, 14 Mar 2013 22:04:20 +0000 (+0100)
Subject: doc: add a man page for am7xxx_mode_switch
X-Git-Tag: v0.1.4~39
X-Git-Url: https://git.ao2.it/libam7xxx.git/commitdiff_plain/2c5e1256b0a939eac385f91e13b01e21413ea89d?hp=5f2af5b62b5f7af8f96da2292b45cdf6b2834a6f

doc: add a man page for am7xxx_mode_switch
---

diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
index ed46999..a21e82c 100644
--- a/doc/man/CMakeLists.txt
+++ b/doc/man/CMakeLists.txt
@@ -3,6 +3,7 @@ find_package(Asciidoc)
 if(ASCIIDOC_FOUND)
   add_custom_target(manpages
     ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/am7xxx-play.1.txt -D ${DOC_OUTPUT_PATH}/man
+    COMMAND ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/am7xxx_mode_switch.1.txt -D ${DOC_OUTPUT_PATH}/man
     COMMAND ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/picoproj.1.txt -D ${DOC_OUTPUT_PATH}/man
     WORKING_DIRECTORY ${DOC_OUTPUT_PATH}/man
     COMMENT "Generating man pages with Asciidoc" VERBATIM
@@ -17,6 +18,7 @@ if(ASCIIDOC_FOUND)
 
   install(FILES
     ${DOC_OUTPUT_PATH}/man/am7xxx-play.1
+    ${DOC_OUTPUT_PATH}/man/am7xxx_mode_switch.1
     ${DOC_OUTPUT_PATH}/man/picoproj.1
     DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man1/"
     COMPONENT manpages)
diff --git a/doc/man/am7xxx_mode_switch.1.txt b/doc/man/am7xxx_mode_switch.1.txt
new file mode 100644
index 0000000..c8fb728
--- /dev/null
+++ b/doc/man/am7xxx_mode_switch.1.txt
@@ -0,0 +1,57 @@
+AM7XXX_MODE_SWITCH(1)
+=====================
+:doctype: manpage
+
+
+NAME
+----
+am7xxx_mode_switch - change the operational mode of am7xxx based devices
+
+
+SYNOPSIS
+--------
+*am7xxx_mode_switch*
+
+
+DESCRIPTION
+-----------
+am7xxx_mode_switch(1) is a minimal replacement of usb-modeswitch to use with
+am7xxx devices (e.g. Acer C110 or Philips PPX projectors) to switch from the
+mass storage device mode to the generic display mode.
+
+It is handy on systems where usb-modeswitch is not available, like Windows.
+
+
+EXAMPLE OF USE
+--------------
+
+am7xxx_mode_switch
+
+
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*!0*::
+    Failure (libusb error)
+
+
+AUTHORS
+-------
+Antonio Ospite
+
+
+RESOURCES
+---------
+Main web site: <http://git.ao2.it/libam7xxx.git>
+
+
+COPYING
+-------
+Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.