1$Id: README,v 1.6 2006/09/16 11:54:18 toad32767 Exp $ 2 3-------------------------------------------------- 4 UModPlayer B5 5 Getting Started 6-------------------------------------------------- 7 81. System requirements 9~~~~~~~~~~~~~~~~~~~~~~~~ 10 11 * LibAo 12 * LibAiff >= 1.1 13 * LibModPlug >= 0.8 14 * UNIX system and development tools 15 16 172. Building UModPlayer 18~~~~~~~~~~~~~~~~~~~~~~~ 19 20First of all, make sure you have installed the above-listed libraries. 21 222.1. Configuring LibAo 23----------------------- 24In the case of LibAo, note that you need the core library plus the 25audio drivers you want (i.e., 'alsa09' if you want ALSA 0.9+ support 26for Linux; or 'sun' if you are a SunOS/NetBSD/OpenBSD user ). 27 28In the case of Linux, many Linux distributions come already with LibAo 29installed. In that case you need to install only the development packages, 30such as `libao-dev'. 31 32In the case of NetBSD, you have LibAo in pkgsrc: audio/libao + audio/libao-sun. 33 34You might want to specify a default audio driver for LibAo. Please refer to 35libao.conf(5). Usually the libao.conf file is stored in /etc. 36 37In example: 38 default_driver=esound 39 40for using ESound as a default audio driver for all LibAo applications, including 41UModPlayer. 42 432.2. Compiling UModPlayer 44-------------------------- 45You can compile UModPlayer as usual: 46 47$ ./configure 48$ make 49 50UModPlayer will be configured by default to be installed on '/usr/local/bin'. 51Use the `--prefix' option of the <configure> script to change this: 52 53$ ./configure --prefix=/usr # to install in /usr/bin 54$ ./configure --prefix=/home/user # to install in /home/user/bin 55 562.3. Installing UModPlayer 57--------------------------- 58To install UModPlayer: 59 60# make install 61 62(The above command must be run as 'root', or 63as a user who have write-access to the installation directory). 64 653. Using UModPlayer 66~~~~~~~~~~~~~~~~~~~~~ 67 68To get help about command line options, you can take a look a the man page: 69 70$ man umodplayer 71 72Or the built-in UModPlayer help: 73 74$ umodplayer --help 75 76To get help about interactive interface, use the 'help' command: 77 78$ umodplayer 79umodplayer[/home/user]% help 80umodplayer[/home/user]% quit 81$ 82 83Please remember to configure UModPlayer. Use the configuration commands 84such as 'volume', 'surround', 'samplerate', etc.; as well as the 'setadvanced' command 85for the advanced configuration. 86 87You can save the config with the 'saveconfig' command, and reset it to the default settings 88with the 'reset' command. 89 90 914. Reporting bugs, sending patches, fixes, etc: 92~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 93 94Any contribution would be welcomed and appreciated. 95Please mail them to the project mantainer. 96As of UModPlayer B4, the maintainer is: 97 98 Marco Trillo <marcotrillo@gmail.com> 99 100 1015. Licensing of UModPlayer 102~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 103 104UModPlayer is released by its autors to the Public Domain. 105In case this is not legally possible, its authors grant 106anyone the right to use, redistribute and modify it for 107any purpose without any conditions (unless such conditions 108are required by law). 109 110 111