Menu
▾
▴
[Performous-commit] Vincent Le Ligeour : Added tools man pages and fixed some typos
|
From: Yoda-JM <yo...@us...> - 2009-12-13 21:20:40
|
Module: performous
Branch: master
Commit: d691c8f544d77787dd6b29a35d6c1dfdf5ce795a
Author: Vincent Le Ligeour <yo...@us...>
Date: Sun Dec 13 22:04:38 2009 +0100
Added tools man pages and fixed some typos
---
docs/ss_adpcm_decode.3 | 18 ++++++++++++++++++
docs/ss_cover_conv.3 | 21 +++++++++++++++++++++
docs/ss_extract.3 | 27 +++++++++++++++++++++++++++
docs/ss_ipu_conv.3 | 15 +++++++++++++++
docs/ss_ipu_decode.3 | 15 +++++++++++++++
docs/ss_pak_extract.3 | 16 ++++++++++++++++
tools/cover_conv.cpp | 2 +-
tools/ipu_decode.cpp | 4 ++--
8 files changed, 115 insertions(+), 3 deletions(-)
diff --git a/docs/ss_adpcm_decode.3 b/docs/ss_adpcm_decode.3
index e69de29..aaf64eb 100644
--- a/docs/ss_adpcm_decode.3
+++ b/docs/ss_adpcm_decode.3
@@ -0,0 +1,18 @@
+.TH "ss_adpcm_decode" "1" "" "" ""
+.SH "NAME"
+ss_adpcm_decode \- Tool for converting ADPCM Singstar audio format to WAV
+.SH "SYNOPSIS"
+\fBss_adpcm_decode\fR [archive.pak] input.mib output.wav
+.TP
+[ \fBarchive.pak\fR ]
+Optional Singstar archive name to look in
+.TP
+\fBinput.mib\fR
+ADPCM source file
+.TP
+\fBoutput.wav\fR
+WAV destination file
+.SH "DESCRIPTION"
+Tool for converting ADPCM Singstar audio format to WAV
+.SH "SEE ALSO"
+\fIperformous\fR(6)
diff --git a/docs/ss_cover_conv.3 b/docs/ss_cover_conv.3
index e69de29..e098f90 100644
--- a/docs/ss_cover_conv.3
+++ b/docs/ss_cover_conv.3
@@ -0,0 +1,21 @@
+.TH "ss_cover_conv" "1" "" "" ""
+.SH "NAME"
+ss_cover_conv \- Tool for converting Singstar song cover
+.SH "SYNOPSIS"
+\fBss_cover_conv\fR [\-h|\-\-help] pak_file track_id output_image
+.TP
+\fB\-h\fR [ \fB\-\-help\fR ]
+you are viewing it
+.TP
+\fBpak_file\fR
+Singstar Pak file to look in
+.TP
+\fBtrack_id\fR
+Singstar track id to extract
+.TP
+\fBoutput_image\fR
+Output image (format will be automatically detected)
+.SH "DESCRIPTION"
+Tool for converting internal Singstar song cover (TX2 format) into a standard format
+.SH "SEE ALSO"
+\fIperformous\fR(1)
diff --git a/docs/ss_extract.3 b/docs/ss_extract.3
index e69de29..5395e09 100644
--- a/docs/ss_extract.3
+++ b/docs/ss_extract.3
@@ -0,0 +1,27 @@
+.TH ss_extract "1" "" "" ""
+.SH "NAME"
+ss_extract \- Tool for converting Singstar DVDs to Ultrastar format
+.SH "SYNOPSIS"
+\fBss_extract\fR [\-h|\-\-help] [\-\-dvd arg] [\-l|\-\-list] [\-\-song arg] [\-\-video arg] [\-\-audio arg]
+.TP
+\fB\-h\fR [ \fB\-\-help\fR ]
+you are viewing it
+.TP
+\fB\-\-dvd\fR arg
+path to Singstar DVD root
+.TP
+\fB\-l\fR [ \fB\-\-list\fR ]
+list tracks only
+.TP
+\fB\-\-song\fR arg
+only extract the given track (ID or partial name)
+.TP
+\fB\-\-video\fR arg (=mkv)
+specify video format (none, mkv, mpeg2)
+.TP
+\fB\-\-audio\fR arg (=ogg)
+specify audio format (none, ogg, wav)
+.SH "DESCRIPTION"
+Tool for converting original Singstar DVDs to the format used by Performous.
+.SH "SEE ALSO"
+\fIperformous\fR(6)
diff --git a/docs/ss_ipu_conv.3 b/docs/ss_ipu_conv.3
index e69de29..32eee37 100644
--- a/docs/ss_ipu_conv.3
+++ b/docs/ss_ipu_conv.3
@@ -0,0 +1,15 @@
+.TH "ss_ipu_conv" "1" "" "" ""
+.SH "NAME"
+ss_ipu_conv \- Tool for converting Singstar videos
+.SH "SYNOPSIS"
+\fBss_ipu_conv\fR infile.ipu outfile.m2v
+.TP
+\fBinfile.ipu\fR
+Singstar ipu video file
+.TP
+\fBoutfile.m2v\fR
+Video output file (MPEG2-Video)
+.SH "DESCRIPTION"
+Tool for converting Singstar videos
+.SH "SEE ALSO"
+\fIperformous\fR(6)
diff --git a/docs/ss_ipu_decode.3 b/docs/ss_ipu_decode.3
index e69de29..8517b65 100644
--- a/docs/ss_ipu_decode.3
+++ b/docs/ss_ipu_decode.3
@@ -0,0 +1,15 @@
+.TH "ss_ipu_decode" "1" "" "" ""
+.SH "NAME"
+ss_ipu_decode \- Tool for decoding Singstar videos
+.SH "SYNOPSIS"
+\fBss_ipu_decode\fR input output
+.TP
+\fBinput\fR
+Singstar ipu video file
+.TP
+\fBoutput\fR
+Video output file
+.SH "DESCRIPTION"
+Tool for decoding Singstar videos
+.SH "SEE ALSO"
+\fIperformous\fR(6)
diff --git a/docs/ss_pak_extract.3 b/docs/ss_pak_extract.3
index e69de29..5ff3ada 100644
--- a/docs/ss_pak_extract.3
+++ b/docs/ss_pak_extract.3
@@ -0,0 +1,16 @@
+.TH "" "" "" "" ""
+.SH "NAME"
+performous\-tools \- Tools for Performous karaoke game
+.SH "SYNOPSIS"
+\fBss_extract\fR [\-h|\-\-help] [\-\-dvd arg] [\-l|\-\-list] [\-\-song arg] [\-\-video arg] [\-\-audio arg]
+\fBss_adpcm_decode\fR [\-h|\-\-help] [archive.pak] input.mib output.wav
+\fBss_cover_conv\fR [\-h|\-\-help] [pak_file] [track_id] [output_image]
+\fBss_ipu_conv\fR [\-h|\-\-help] infile.ipu outfile.m2v
+\fBss_ipu_decode\fR [\-h|\-\-help] input output
+\fBss_pak_extract\fR [\-h|\-\-help] file.pak \-\-extract [files]
+\fBss_pak_extract\fR file.pak \-\-dump file
+\fBss_pak_extract\fR file.pak \-\-list
+.SH "DESCRIPTION"
+Tools for converting original Singstar DVDs to the format used by Performous.
+.SH "SEE ALSO"
+\fIperformous\fR(1)
diff --git a/tools/cover_conv.cpp b/tools/cover_conv.cpp
index a0ede50..af70268 100644
--- a/tools/cover_conv.cpp
+++ b/tools/cover_conv.cpp
@@ -9,7 +9,7 @@
int main( int argc, char **argv) {
if(argc != 4 ) {
- std::cout << "Usage: " << argv[0] << " [pak_file] [track_id] [output_image]" << std::endl;
+ std::cout << "Usage: " << argv[0] << " [-h|--help] pak_file track_id output_image" << std::endl;
return EXIT_FAILURE;
}
diff --git a/tools/ipu_decode.cpp b/tools/ipu_decode.cpp
index dec7587..90373d3 100644
--- a/tools/ipu_decode.cpp
+++ b/tools/ipu_decode.cpp
@@ -110,13 +110,13 @@ int main( int argc, char** argv) {
struct IPUFile ipu;
if( argc < 3 ) {
- std::cout << "Usage: " << argv[0] << "input output" << std::endl;
+ std::cout << "Usage: " << argv[0] << " input output" << std::endl;
return EXIT_FAILURE;
}
m_f1.open(argv[1], std::ios::binary);
m_f2.open(argv[2], std::ios::binary);
- if (!m_f1.is_open()) throw std::runtime_error("Could not open PAK file");
+ if (!m_f1.is_open()) throw std::runtime_error("Could not open IPU file");
m_f1.seekg(0x4, std::ios::cur);
m_f1.read((char*)&ipu.file_size,sizeof(int));
|
