Merge tag 'v0.1.4' into debian
[libam7xxx.git] / debian / patches / 0001-doc-add-a-man-page-for-am7xxx_mode_switch.patch
1 From efddab9c02e7eae1e8bae843fe4d95718478de1b Mon Sep 17 00:00:00 2001
2 From: Antonio Ospite <ospite@studenti.unina.it>
3 Date: Thu, 14 Mar 2013 23:04:20 +0100
4 Subject: [PATCH] doc: add a man page for am7xxx_mode_switch
5 X-Face: z*RaLf`X<@C75u6Ig9}{oW$H;1_\2t5)({*|jhM<pyWR#k60!#=#>/Vb;]yA5<GWI5`6u&+
6  ;6b'@y|8w"wB;4/e!7wYYrcqdJFY,~%Gk_4]cq$Ei/7<j&N3ah(m`ku?pX.&+~:_/wC~dwn^)MizBG
7  !pE^+iDQQ1yC6^,)YDKkxDd!T>\I~93>J<_`<4)A{':UrE
8
9 ---
10  doc/man/CMakeLists.txt           |    2 ++
11  doc/man/am7xxx_mode_switch.1.txt |   57 ++++++++++++++++++++++++++++++++++++++
12  2 files changed, 59 insertions(+)
13  create mode 100644 doc/man/am7xxx_mode_switch.1.txt
14
15 diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
16 index ed46999..a21e82c 100644
17 --- a/doc/man/CMakeLists.txt
18 +++ b/doc/man/CMakeLists.txt
19 @@ -3,6 +3,7 @@ find_package(Asciidoc)
20  if(ASCIIDOC_FOUND)
21    add_custom_target(manpages
22      ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/am7xxx-play.1.txt -D ${DOC_OUTPUT_PATH}/man
23 +    COMMAND ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/am7xxx_mode_switch.1.txt -D ${DOC_OUTPUT_PATH}/man
24      COMMAND ${ASCIIDOC_A2X_EXECUTABLE} -f manpage ${CMAKE_CURRENT_SOURCE_DIR}/picoproj.1.txt -D ${DOC_OUTPUT_PATH}/man
25      WORKING_DIRECTORY ${DOC_OUTPUT_PATH}/man
26      COMMENT "Generating man pages with Asciidoc" VERBATIM
27 @@ -17,6 +18,7 @@ if(ASCIIDOC_FOUND)
28  
29    install(FILES
30      ${DOC_OUTPUT_PATH}/man/am7xxx-play.1
31 +    ${DOC_OUTPUT_PATH}/man/am7xxx_mode_switch.1
32      ${DOC_OUTPUT_PATH}/man/picoproj.1
33      DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man1/"
34      COMPONENT manpages)
35 diff --git a/doc/man/am7xxx_mode_switch.1.txt b/doc/man/am7xxx_mode_switch.1.txt
36 new file mode 100644
37 index 0000000..d80cb60
38 --- /dev/null
39 +++ b/doc/man/am7xxx_mode_switch.1.txt
40 @@ -0,0 +1,57 @@
41 +AM7XXX_MODE_SWITCH(1)
42 +=====================
43 +:doctype: manpage
44 +
45 +
46 +NAME
47 +----
48 +am7xxx_mode_switch - change the operational mode of am7xxx based devices
49 +
50 +
51 +SYNOPSIS
52 +--------
53 +*am7xxx_mode_switch*
54 +
55 +
56 +DESCRIPTION
57 +-----------
58 +am7xxx_mode_switch(1) is a minimal replacement of usb-modeswitch to use with
59 +am7xxx devices (e.g. Acer C110 or Philips PPX projectors) to switch from the
60 +mass storage device mode to the generic display mode.
61 +
62 +It is handy on systems where usb-modeswitch is not available, like Windows.
63 +
64 +
65 +EXAMPLE OF USE
66 +--------------
67 +
68 +am7xxx_mode_switch
69 +
70 +
71 +EXIT STATUS
72 +-----------
73 +*0*::
74 +    Success
75 +
76 +*!0*::
77 +    Failure (libusb error)
78 +
79 +
80 +AUTHORS
81 +-------
82 +Antonio Ospite
83 +
84 +
85 +RESOURCES
86 +---------
87 +Main web site: <http://git.ao2.it/libam7xxx.git>
88 +
89 +
90 +COPYING
91 +-------
92 +Copyright \(C) 2012  Antonio Ospite <ospite@studenti.unina.it>
93 +
94 +This program is free software: you can redistribute it and/or modify
95 +it under the terms of the GNU General Public License as published by
96 +the Free Software Foundation, either version 3 of the License, or
97 +(at your option) any later version.
98 -- 
99 1.7.10.4
100