Warning, /multimedia/kwave/README is written in an unsupported language. File is not indexed.
0001 ---------------------------------------------------------------------------- 0002 | | 0003 | This is "Kwave", a sound editor built on KDE Frameworks 5 | 0004 | | 0005 ---------------------------------------------------------------------------- 0006 0007 ---------------------------------------------------------------------------- 0008 | It is hosted on KDE and on SourceForge, so you are welcome to visit | 0009 | the Kwave homepage at: "http://kwave.sourceforge.net" for details. | 0010 ---------------------------------------------------------------------------- 0011 0012 If you are interested what has been done and what has to be done, then 0013 look at the files "CHANGES" and "TODO" included in this package. 0014 0015 The project is developed and published under the GNU GENERAL PUBLIC LICENSE 0016 (Version 2, from June 1991), take a look at the file "GNU-LICENSE" included 0017 in the source package. 0018 0019 0. PREFACE: 0020 ========== 0021 0022 Please note that required packages for compiling Kwave vary between 0023 different distributions and versions. It is practically impossible 0024 to give a complete list of packages and versions, so if you can't 0025 get along, please feel free to ask on the Kwave mailing list! 0026 0027 1. COMPILING MANUALLY: 0028 ===================== 0029 0030 >>> NOTE: You don't have to do this on an rpm based system, you can 0031 easily build a rpm package of Kwave. Please skip this and 0032 advance to section 2. 0033 0034 It's quite simple. First get the source archive, unpack it in a driectory 0035 of your choice and then generate it in a separate build directory. 0036 For example: 0037 0038 cd ${HOME}/src 0039 tar -xvzf kwave-0.9.3-1.tar.bz2 0040 mkdir kwave-build 0041 cd kwave-build 0042 cmake ../kwave-0.9.3 0043 0044 make 0045 make install 0046 0047 2. RPM-SUPPORT: 0048 ============== 0049 0050 You can build nice binary and/or source rpm packages of kwave in one 0051 of the following ways. Note: Either you do everything as root or you 0052 must have write permissions in the following directories: 0053 0054 * /tmp 0055 * /usr/src/packages/BUILD 0056 * /usr/src/packages/RPMS 0057 * /usr/src/packages/SOURCES 0058 * /usr/src/packages/SPECS 0059 * /usr/src/packages/SRPMS 0060 0061 Installing the rpm package normally requires root permissions. 0062 0063 2.1 Building a binary rpm from archive file: 0064 ------------------------------------------- 0065 0066 Simply get the source archive (for example kwave-0.9.3-1.tar.bz2) and 0067 then type: 0068 0069 rpmbuild -ta kwave-0.9.3-1.tar.bz2 0070 0071 If you want to build for a different architecture than your current, you 0072 might want to add the parameter "--target ...", for example: 0073 0074 rpmbuild -ta --target i586 kwave-0.9.3-1.tar.bz2 0075 0076 compiles for i586 architecture. 0077 0078 0079 2.2 Building a source and binary rpm from the source tree (GIT): 0080 --------------------------------------------------------------- 0081 0082 Assuming that you already have unpacked the source archive in some 0083 directory, like in chapter 1, but instead of the combination 0084 "make" / "make install" you do 0085 0086 make src_rpm (and you get only a source rpm) 0087 ***OR*** 0088 make rpm (and you get both, a binary and a source rpm) 0089 0090 Instructions on how to get the sources via GIT can be found in the 0091 Kwave handbook and on the Kwave project homepage at SourceForge 0092 (see "http://sourceforge.net/p/kwave/code/ci/master/tree/"). 0093 0094 Please note that the online documentation in not included in GIT, it will 0095 created from the corresponding docbook source which is included. 0096 This requires a working docbook/sgml environment that is sometimes 0097 problematic (see below). 0098 0099 0100 3. RELOCATING THE BINARY RPM: 0101 ============================ 0102 0103 The binary rpm package of kwave is "relocatable". This means that you can 0104 build the package on a system with the KDE base directory set to some 0105 location (like for example /usr) and install it on some other system 0106 and/or into a different directory. 0107 0108 rpm -Uvh --prefix=/usr/local kwave-0.9.3-1.i586.rpm 0109 0110 This modifies the path where the program is installed and it is strongly 0111 recommended that this is a directory that is contained in the KDEDIRS 0112 environment variable, otherwise Kwave would be unable to find it's menu 0113 configuration, plugins, preset files and so on... 0114 0115 4. REQUIREMENTS: 0116 =============== 0117 0118 >>> Please read the preface (section 0) before this <<< 0119 0120 The revision codes (numbers after the '-') should not be so important. 0121 As a rule of thumb one can say that the nearer your version number is 0122 the better it will work. 0123 0124 For compilation you need a working autoconf/automake environment, a good 0125 C/C++ compiler, the qt and the kde libraries. 0126 0127 I am currently developing under a Gentoo Linux distribution 0128 (i586 architecture) using at least the following packages: 0129 0130 * cmake >= 2.8.12 (the cmake build system) 0131 * gcc >= 4.7 (the C / C++ compiler) 0132 0133 * make >= 3.80 0134 * libstdc++-v3 >= 3.3.4 (C++ library, including STL) 0135 * glibc >= 2.3 (the GNU C library) 0136 * kernel-headers (needed by glibc-devel) 0137 * gettext >= 0.12 (for internationalization) 0138 * rpm >= 4.0 (optional, for rpm support) 0139 * ImageMagick >= 6.1 (needed to create scaled Kwave icons) 0140 0141 * libmad + libmad-devel >= 0.15 (for MP3 import) 0142 * id3lib >= 3.8.1 (for MP3 tag import, see www.id3lib.org) 0143 * libogg >= 1.1.2 (for Ogg/Vorbis import/export) 0144 * libvorbis >= 1.1.0 (for Ogg/Vorbis import/export) 0145 * flac >= 1.2.0 (for FLAC import/export) 0146 * fftw >= 3.0 (for Sonagram plugin / FFT) 0147 * pulseaudio >= 0.9.16 (for record/playback via PulseAudio) 0148 * samplerate >= 0.1.3 (for sample rate conversion) 0149 * gettext (for msgmerge) 0150 0151 Some tools that are normally installed in every distribution: 0152 * sed, bash, msgcat, msgmerge, msgfmt, xgettext, cat, find, bzip2, perl 0153 0154 Nearly everything from ftp.kde.org, especially the following 0155 packets should be sufficient for building: 0156 0157 [WARNING: this list might be a bit outdated] 0158 0159 * the following Qt packages Qt >= 5.14 0160 - qtcore 0161 - qtconcurrent 0162 - qtnetwork 0163 - qtgui 0164 - qtmultimedia 0165 - qtwidgets 0166 * the following KDE Frameworks packages, KF5 >= 5.33 0167 - extra-cmake-modules 0168 - kconfig 0169 - kconfigwidgets 0170 - kcoreaddons 0171 - kcrash 0172 - kdbusaddons 0173 - kdoctools 0174 - ki18n 0175 - kiconthemes 0176 - kio 0177 - kservice 0178 - ktextwidgets 0179 - kxmlgui 0180 - kwidgetsaddons 0181 0182 additionally, for generating the online help; 0183 0184 - poxml (for po2xml and xml2pot) 0185 - kdoctools (for checkXML5) 0186 0187 known distributions / architectures: 0188 ------------------------------------ 0189 0190 see the Kwave homepage: http://kwave.sf.net/distributions.html 0191 0192 Compilation might also work on many other distributions and different 0193 versions of compilers and libraries, or even on different architectures. 0194 0195 So if you have success in compiling and using kwave under a different system, 0196 please let me know ! 0197 0198 If the program does NOT compile, please let me know too - and/or consider 0199 an update of your system if your packages are older than those mentioned 0200 above. 0201 0202 currently tested distributions: 0203 ------------------------------------------- 0204 0205 see http://kwave.sourceforge.net/distributions.html 0206 0207 5. KNOWN PROBLEMS / SOME HINTS: 0208 ============================== 0209 0210 * missing files: 0211 ------------- 0212 Depending on your distribution, one ore more components might require 0213 additional packages. Often you will need the "-devel" packages for 0214 building (only) Kwave, e.g. it might not be sufficient to have the 0215 package "libaudiofile" installed, additionally the corresponding package 0216 "audiofile-devel" might be required too! 0217 0218 Hint for SuSE users: 0219 => on CD1 (or on the DVD1) there is a file named "ARCHIVES.gz". 0220 If you want to find out which package does contain a missing program or 0221 file, you can do the following: 0222 0223 gzip -dc ARCHIVES.gz | grep name_of_the_missing_file 0224 0225 * warnings about invalid character set when creating online documentation: 0226 ----------------------------------------------------------------------- 0227 This is quite "normal", because some tools are not aware of the 0228 UTF-8 encoding that is used in the .docbook and the .po files. 0229 0230 * hint: compiling in parallel with distcc: 0231 --------------------------------------- 0232 I successfully compiled Kwave on many systems with the following 0233 method: 0234 0235 CC=distcc CXX="distcc g++" cmake ...your parameters... 0236 make -j <JOBS> 0237 0238 (replace <JOBS> with a number of parallel jobs, for example the 0239 number of CPUs on all hosts + number of distcc hosts) 0240 0241 6. SOME HISTORY: 0242 =============== 0243 0244 This project has been started by Martin Wilz in summer 1998 and has been 0245 developed and improved by him an some other people. In November 1999 I started 0246 to fix some little bugs here and there and stepped into the source code of 0247 the program deeper and deeper. Up to today I have extended, rewritten or 0248 revised nearly every component of the program and spend much time on it. 0249 Since summer 1999 I have taken over the project leadership and I am still 0250 working on it. 0251 0252 So good luck, and feel free to keep me informed about bugs and wishes... 0253 0254 Thomas Eschenbacher <Thomas.Eschenbacher@gmx.de> 0255