MIKMOD (1)
play soundtracker etc. modules on a Unix machine.
SYNOPSIS
mikmod [\fB-options\fR]... [\fBmodule\fR|\fBplaylist\fR]...
DESCRIPTION
MikMod is a very portable module player based on libmikmod, written
originally by Jean-Paul Mikkers (MikMak). It will play the IT, XM, MOD, MTM,
S3M, STM, ULT, FAR, MED, DSM, AMF, IMF and 669 module formats. It works under
AIX, FreeBSD, HP-UX, IRIX, Linux, NetBSD, OpenBSD, OSF/1, SunOS and Solaris.
It is controllable via a curses interface and will extract and play modules
from a variety of different archive formats.
OPTIONS
Options can be given in any order, and are case-sensitive. For the options
which have both a short and a long form, the long form can be prefixed by one
or two dashes. Note that the settings in your $HOME/.mikmodrc will override the
defaults shown in this man page.
OUTPUT OPTIONS
Use the specified device driver for output, 0 is autodetect. The default is 0.
Output settings, 8 or 16 bit in stereo or mono. The default is "16s".
Set mixing frequency in hertz. The default is 44100.
Use interpolated mixing. This will generally improve audio quality, at the
expense of a bit more CPU usage. Note that this option alters the behaviour of
software drivers only ; hardware drivers are not affected.
Do not use interpolated mixing (default).
Use high quality software mixer. This improves audio quality, but requires a lot
more CPU power. Note that this option alters the behaviour of software drivers
only ; hardware drivers are not affected.
Do not use high quality software mixer (default).
Do not use surround mixing (default).
Sets reverb amount from 0 (no reverb) to 15 (max reverb). The default is 0 (no
reverb).
SH PLAYBACK OPTIONS
Set volume from 0% (silence) to 100%. The default is 100%.
Fade out the volume during the last pattern of each module.
Do not fade out the volume during the last pattern of each module (default).
Enable in-module backwards loops.
Disable in-module backwards loops (default).
Process panning effects (default). This should be disabled (using --nopanning)
for very old demo modules which use the panning effects for synchronization
purposes.
Do not process panning effects.
Enable protracker extended speed effect (default). This should be disabled
(using --noprotracker) for very old demo modules which use the extended speed
effect for synchronization purposes.
Disable protracker extended speed effect.
LOADING OPTIONS
Look for hidden patterns in module. Most modules don't have hidden patterns,
but you can find "bonus" patterns (or just silence) in some modules.
Do not look for hidden patterns in module (default).
Playlist mode. The allowed values here are 0, to loop the current module ; 1,
to play the whole playlist once ; 2, to play the whole playlist repeatedly,
and 3, to play the whole playlist randomly. The default is 2.
Don't halt MikMod if a module cannot be read or is an unknown format.
Halt MikMod if a module cannot be read or is an unknown format (default).
SCHEDULING OPTIONS
The following options need root privileges (or a setuid root binary), and
don't work under all systems.
Renice to -20 if possible to gain more CPU priority. This option is only
available under FreeBSD, Linux, NetBSD, OpenBSD and OS/2.
Do not renice to -20 (default).
Reschedule mikmod to gain real-time priority (and thus more CPU time).
DANGEROUS! USE WITH CAUTION! This option is only available under FreeBSD,
Linux and OS/2.
Do not reschedule MikMod to gain real-time priority (default).
DISPLAY OPTIONS
Quiet mode. Disables interactive commands and displays only errors.
Terse display like MikMod 2, i.e. without the information panels.
INFORMATION OPTIONS
Display the list of the known drivers and module loaders.
Display a summary of the options.
CONFIGURATION OPTION
Neither parse nor update the $HOME/.mikmodrc configuration file. This file
contains your default settings, so that you don't have to specify them each
time you run MikMod. The file is read when you run MikMod and updated on exit.
Using this option prevents MikMod from accessing this file.
RUNTIME COMMANDS
At play time, the following keystrokes offer control over MikMod :
Display instruments panel (if present in the module).
Display song message panel (if present in the module).
Display the playlist panel.
Set volume from 10% (digit 1) to 100% (digit 0).
Restart current pattern / Skip to previous pattern.
Skip to next pattern in current module.
Go to the end of the panel.
Decrease speed variable (module plays faster).
Increase speed variable (module plays slower).
Decrease tempo variable (module plays slower).
Increase tempo variable (module plays faster).
Toggle interpolation mixing.
Switch to previous module in playlist.
Switch to next module in playlist.
PLAYLIST MENU
When the playlist panel is displayed, pressing the return key will popup
a menu. The menu commands are :
Continue list playback from the currently highlighted module.
Remove module from the playlist.
Save the current playlist in the file 'playlist.mpl' in the current directory.
MODULE FORMATS
ARCHIVE FORMATS
MikMod should recognize and extract the following common archive formats.
However, to use each of these you will need to find the appropriate
program(s) for MikMod to use to extract them. These are commonly available
and you will most likely find them with this distribution of MikMod.
Info-zip or PkZip archives, commonly used on DOS/Windows platforms.
Lharc archives, commonly used on the Amiga.
Zoo archives, quite rare those days...
Tar archives, even compressed with gzip or bzip2.
FILES
AUTHORS
MikMod is the result of the work of many people, including :
Jean-Paul Mikkers, Jake Stine, Miodrag Vallat, Frank Loemker, Steve McIntyre,
Peter Amstutz, "MenTaLguY", Dimitri Boldyrev, Shlomi Fish, Stefan Tibus,
Tinic Urou.
LOCATING NEWER VERSIONS...
The official MikMod homepage is located on
http://www.multimania.com/miodrag/mikmod
New releases can also be found after a short delay on
ftp://metalab.unc.edu/pub/Linux/apps/sound/players
and on metalab (formerly known as sunsite) mirrors.