Menu
▾
▴
[Performous-commit] Tapio Vierros : Moved man pages to a subdir (cleaner looking docs dir), also updated slightly.
|
From: Tapio V. <aa...@us...> - 2010-09-14 21:34:46
|
Module: performous
Branch: master
Commit: 72459cc6678c368a88fe5d2b3375ff4d482fbe6f
Author: Tapio Vierros <tap...@gm...>
Date: Wed Sep 15 00:32:56 2010 +0300
Moved man pages to a subdir (cleaner looking docs dir), also updated slightly.
---
docs/CMakeLists.txt | 45 +-------------------------------------
docs/man/CMakeLists.txt | 41 ++++++++++++++++++++++++++++++++++
docs/{ => man}/gh_fsb_decrypt.1 | 0
docs/{ => man}/gh_xen_decrypt.1 | 0
docs/{ => man}/performous.h2m | 5 ++-
docs/{ => man}/ss_adpcm_decode.1 | 0
docs/{ => man}/ss_chc_decode.1 | 0
docs/{ => man}/ss_cover_conv.1 | 0
docs/{ => man}/ss_extract.1 | 0
docs/{ => man}/ss_ipu_conv.1 | 0
docs/{ => man}/ss_ipu_decode.1 | 0
docs/{ => man}/ss_pak_extract.1 | 0
12 files changed, 45 insertions(+), 46 deletions(-)
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 7fa9733..790aefd 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -1,46 +1,3 @@
-
if(UNIX)
- find_program(HELP2MAN help2man DOC "Location of the help2man program")
- find_program(GZIP gzip DOC "Location of the gzip program")
- mark_as_advanced(HELP2MAN)
- mark_as_advanced(GZIP)
- if(HELP2MAN AND GZIP)
- set(MANFILE ${CMAKE_CURRENT_BINARY_DIR}/performous.6.gz)
- set(H2MFILE ${CMAKE_CURRENT_SOURCE_DIR}/performous.h2m)
- set(PERFORMOUS_EXEC ${CMAKE_BINARY_DIR}/game/performous)
- add_custom_command(
- OUTPUT ${MANFILE}
- COMMAND ${HELP2MAN} ${PERFORMOUS_EXEC} -s 6 -i ${H2MFILE} -N | ${GZIP} > ${MANFILE}
- MAIN_DEPENDENCY ${H2MFILE}
- DEPENDS ${PERFORMOUS_EXEC}
- COMMENT "Building Performous man page"
- VERBATIM
- )
- add_custom_target(manpage ALL DEPENDS ${MANFILE})
- install(FILES ${MANFILE} DESTINATION share/man/man6)
- else(HELP2MAN AND GZIP)
- message("WARNING: One of the following is missing: help2man, gzip; performous man page will not be generated")
- endif(HELP2MAN AND GZIP)
- if(ENABLE_TOOLS AND GZIP)
- set(TOOLS
- "ss_pak_extract" "ss_extract" "ss_cover_conv"
- "ss_adpcm_decode" "ss_ipu_decode" "ss_ipu_conv"
- "gh_xen_decrypt" "ss_chc_decode")
- set(MAN_SECTION "1")
- foreach(TOOL ${TOOLS})
- set(TOOL_MANFILE ${CMAKE_CURRENT_SOURCE_DIR}/${TOOL}.${MAN_SECTION})
- set(TOOL_MANFILE_GZ ${CMAKE_CURRENT_BINARY_DIR}/${TOOL}.${MAN_SECTION}.gz)
- add_custom_command(
- OUTPUT ${TOOL_MANFILE_GZ}
- COMMAND ${GZIP} -c ${TOOL_MANFILE} > ${TOOL_MANFILE_GZ}
- MAIN_DEPENDENCY ${TOOL_MANFILE}
- COMMENT "Building ${TOOL} man page"
- VERBATIM
- )
- add_custom_target(${TOOL}.${MAN_SECTION} ALL DEPENDS ${TOOL_MANFILE_GZ})
- install(FILES ${TOOL_MANFILE_GZ} DESTINATION share/man/man${MAN_SECTION})
- endforeach(TOOL)
- endif(ENABLE_TOOLS AND GZIP)
+ add_subdirectory(man)
endif(UNIX)
-
-
diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt
new file mode 100644
index 0000000..7261ee6
--- /dev/null
+++ b/docs/man/CMakeLists.txt
@@ -0,0 +1,41 @@
+find_program(HELP2MAN help2man DOC "Location of the help2man program")
+find_program(GZIP gzip DOC "Location of the gzip program")
+mark_as_advanced(HELP2MAN)
+mark_as_advanced(GZIP)
+if(HELP2MAN AND GZIP)
+ set(MANFILE ${CMAKE_CURRENT_BINARY_DIR}/performous.6.gz)
+ set(H2MFILE ${CMAKE_CURRENT_SOURCE_DIR}/performous.h2m)
+ set(PERFORMOUS_EXEC ${CMAKE_BINARY_DIR}/game/performous)
+ add_custom_command(
+ OUTPUT ${MANFILE}
+ COMMAND ${HELP2MAN} ${PERFORMOUS_EXEC} -s 6 -i ${H2MFILE} -N | ${GZIP} > ${MANFILE}
+ MAIN_DEPENDENCY ${H2MFILE}
+ DEPENDS ${PERFORMOUS_EXEC}
+ COMMENT "Building Performous man page"
+ VERBATIM
+ )
+ add_custom_target(manpage ALL DEPENDS ${MANFILE})
+ install(FILES ${MANFILE} DESTINATION share/man/man6)
+else(HELP2MAN AND GZIP)
+ message("WARNING: One of the following is missing: help2man, gzip; performous man page will not be generated")
+endif(HELP2MAN AND GZIP)
+if(ENABLE_TOOLS AND GZIP)
+ set(TOOLS
+ "ss_pak_extract" "ss_extract" "ss_cover_conv"
+ "ss_adpcm_decode" "ss_ipu_decode" "ss_ipu_conv"
+ "gh_xen_decrypt" "ss_chc_decode")
+ set(MAN_SECTION "1")
+ foreach(TOOL ${TOOLS})
+ set(TOOL_MANFILE ${CMAKE_CURRENT_SOURCE_DIR}/${TOOL}.${MAN_SECTION})
+ set(TOOL_MANFILE_GZ ${CMAKE_CURRENT_BINARY_DIR}/${TOOL}.${MAN_SECTION}.gz)
+ add_custom_command(
+ OUTPUT ${TOOL_MANFILE_GZ}
+ COMMAND ${GZIP} -c ${TOOL_MANFILE} > ${TOOL_MANFILE_GZ}
+ MAIN_DEPENDENCY ${TOOL_MANFILE}
+ COMMENT "Building ${TOOL} man page"
+ VERBATIM
+ )
+ add_custom_target(${TOOL}.${MAN_SECTION} ALL DEPENDS ${TOOL_MANFILE_GZ})
+ install(FILES ${TOOL_MANFILE_GZ} DESTINATION share/man/man${MAN_SECTION})
+ endforeach(TOOL)
+endif(ENABLE_TOOLS AND GZIP)
diff --git a/docs/gh_fsb_decrypt.1 b/docs/man/gh_fsb_decrypt.1
similarity index 100%
rename from docs/gh_fsb_decrypt.1
rename to docs/man/gh_fsb_decrypt.1
diff --git a/docs/gh_xen_decrypt.1 b/docs/man/gh_xen_decrypt.1
similarity index 100%
rename from docs/gh_xen_decrypt.1
rename to docs/man/gh_xen_decrypt.1
diff --git a/docs/performous.h2m b/docs/man/performous.h2m
similarity index 86%
rename from docs/performous.h2m
rename to docs/man/performous.h2m
index 98e578d..cad1c42 100644
--- a/docs/performous.h2m
+++ b/docs/man/performous.h2m
@@ -84,11 +84,12 @@ Toggle pitch wave rendering (only when karaoke mode is disabled)
Hot reload song from disk (useful for making or repairing songs)
[audio device configuration]
-Performous normally autodetects microphones and playback devices correctly, but if this fails on your machine, you will need to configure them from command line because in-game configuration is not yet implemented. Once you have them working, enter the configuration menu and press \fBCtrl+S\fR to save them to your config file so that they don't need to specified when starting the program.
+Performous normally autodetects microphones and playback devices correctly, but if this fails on your machine, you will need to configure them in the Audio Devices -screen. Advanced configuration is possible through the command line, just remember to enter the configuration menu and press \fBCtrl+S\fR to save them to your config file so that they don't need to be specified every time the program starts.
-Additionally, the current version prints a list of ALSA devices detected to console. Use this as a reference for your configuration.
+The list of available PortAudio devices is printed to the console, but it can also be seen from the GUI.
[see also]
You can find more information at http://performous.org/ or
+http://wiki.performous.org or
http://sourceforge.net/projects/performous/
diff --git a/docs/ss_adpcm_decode.1 b/docs/man/ss_adpcm_decode.1
similarity index 100%
rename from docs/ss_adpcm_decode.1
rename to docs/man/ss_adpcm_decode.1
diff --git a/docs/ss_chc_decode.1 b/docs/man/ss_chc_decode.1
similarity index 100%
rename from docs/ss_chc_decode.1
rename to docs/man/ss_chc_decode.1
diff --git a/docs/ss_cover_conv.1 b/docs/man/ss_cover_conv.1
similarity index 100%
rename from docs/ss_cover_conv.1
rename to docs/man/ss_cover_conv.1
diff --git a/docs/ss_extract.1 b/docs/man/ss_extract.1
similarity index 100%
rename from docs/ss_extract.1
rename to docs/man/ss_extract.1
diff --git a/docs/ss_ipu_conv.1 b/docs/man/ss_ipu_conv.1
similarity index 100%
rename from docs/ss_ipu_conv.1
rename to docs/man/ss_ipu_conv.1
diff --git a/docs/ss_ipu_decode.1 b/docs/man/ss_ipu_decode.1
similarity index 100%
rename from docs/ss_ipu_decode.1
rename to docs/man/ss_ipu_decode.1
diff --git a/docs/ss_pak_extract.1 b/docs/man/ss_pak_extract.1
similarity index 100%
rename from docs/ss_pak_extract.1
rename to docs/man/ss_pak_extract.1
|
