Hello folks !


This is MikMod, version 3.1.5, a module player for Unix.
As usual with each new version, there's a lot of bugfixes and improvements.
Check out the file 'NEWS' for more information.


BUILDING MIKMOD
---------------

If you're building MikMod under OS/2, please refer to the 'README' file
located in the 'os2' subdirectory.

If you want to build MikMod under Windows, an extension package including
Windows specific code will be released shortly after this release. Check out
the www site.

The first thing you need is to get and compile the libmikmod sound library,
which is not bundled with MikMod anymore !
Latest releases of libmikmod can be found on the official homepage (see url
at the end of this file), as well as on
  ftp://metalab.unc.edu/pub/Linux/apps/sound/libs
and all metalab (formerly known as sunsite) mirrors.

You'll need an ANSI C compiler to build MikMod.

To prevent clobbering the sources, I recommend building MikMod in an
alternate directory, for example 'build' :

  mkdir build
  cd build

In this directory, run MikMod's configure script :

  ../configure

The configure script will attempt to guess correct values for various
system-dependent variables used during the build process, and will
create appropriate Makefiles for proper compilation. 

If you're not familiar with configure scripts and their standard
options, you can find more general information about them in the file
INSTALL.

After you've successfully run configure, simply run

  make

to get all things build. Then, run

  make install

to have the player installed. Depending on where you choose to install it
(using the --prefix= option to configure), you may need root privileges for
this operation.


USING MIKMOD
------------

Run MikMod without parameters to get the available options, or display
its man page (if you did "make install") with

  man mikmod

Also, after you've run MikMod for the first time, you might want to
customize your $HOME/.mikmodrc, so you won't need to supply the same
options to MikMod all the time.

Once you're in the player, if you haven't choosed terse mode (a la
MikMod 2), pressing the H key will give you an help screen with the list
of the keys you can use. I hope it's understandable.

If you're playing MikMod in quiet mode (with the -q/-quiet switch), you can
tell MikMod to jump to the next/previous song by sending the MikMod process
SIGUSR1 or SIGUSR2 respectivly. In other words, let's say you're doing
something like this:

$ mikmod myalltimefavmods.mpl -quiet &
[1] 7531

You've told MikMod to read the songs out of the playlist myalltimefavmods,
to not spit out any output (-quiet), and to run in the background.
Your shell will give you the process ID, in this case it's 7531.  You
can also find this out from "ps", "top", or a number of process
management utilities.  Now, let's say a song you don't like as much comes
on, or for some reason one seems to be looping forever, you can do
this...

$ kill -s SIGUSR1 7531

or

$ kill -USR1 %1

(if your shell supports the %n process notation)
and MikMod will start playing the next file in the list.
If you want the previous file, just use SIGUSR2 in place of SIGUSR1.
This feature also works when MikMod is in interactive mode (with the
curses interface), but is less useful then, since you have full player
control...

If you used the playlist features of the previous MikMod versions, your
old playlist won't work anymore since the playlist format has changed.
Now the playlist files must have an .mpl extension. To convert your old
playlists into the new format, use the
'convert_playlist' awk script :

  ./convert_playlist < my_old_playlist > my_new_playlist.mpl


THANKS
------

I would like to thank everyone who contributed to MikMod. Their names
are in the AUTHORS file. Thanks a lot !


LICENSE
-------

The MikMod module player is covered by the GNU General Public License,
which you can find in 'COPYING'.


CONTACT INFO
------------

Please send all your MikMod related e-mail to me, at :
  miodrag@multimania.com

MikMod and libmikmod home page is located at :
  http://www.multimania.com/miodrag/mikmod
(the previous URL at mygale.org is still valid and will redirect to
multimania, as it is in fact the same domain...)

Latest releases of MikMod can be found on the official homepage, as
well as on
  ftp://metalab.unc.edu/pub/Linux/apps/sound/players
and all metalab (formerly known as sunsite) mirrors.

-- Miodrag ("Miod") Vallat, 03/01/1999
   miodrag@multimania.com
