.TH "XMP" "1" "Version 3\&.4\&.0" "Aug 2011" "Extended Module Player" 
.PP 
.SH "NAME" 
xmp - Extended Module Player
.PP 
.SH "SYNOPSIS" 
\fBxmp\fP
[\fB-8, --8bit\fP]
[\fB-a, --amplify\fP \fIfactor\fP]
[\fB-b, --bits\fP \fIbits\fP]
[\fB-c, --stdout\fP]
[\fB--chorus\fP \fIdepth\fP]
[\fB-D\fP \fIdevice-specific parameters\fP]
[\fB-d, --driver\fP \fIdriver\fP]
[\fB--fix-sample-loop\fP]
[\fB-F, --click-filter\fP]
[\fB-f, --frequency\fP \fIrate\fP]
[\fB-h, --help\fP]
[\fB-I, --instrument-path\fP]
[\fB-i, --interpolate\fP]
[\fB--load-only\fP]
[\fB-l, --loop\fP]
[\fB-M, --mute\fP \fIchannel-list\fP]
[\fB-m, --mono\fP]
[\fB--nocmd\fP]
[\fB--nofilter\fP]
[\fB-n, --nearest\fP]
[\fB--nopan\fP]
[\fB--norc\fP]
[\fB-o, --output-file\fP \fIfilename\fP]
[\fB-P, --pan\fP \fIpan\fP]
[\fB--probe-only\fP]
[\fB-R --random\fP]
[\fB--realtime\fP]
[\fB--reverb\fP \fIdepth\fP]
[\fB-r --reverse\fP]
[\fB--show-time\fP]
[\fB-S, --solo\fP \fIchannel-list\fP]
[\fB-s, --start\fP \fIpos\fP]
[\fB--stereo\fP]
[\fB-T, --tempo\fP \fIbpm\fP]
[\fB-t, --time\fP \fItime\fP]
[\fB-u, --unsigned\fP]
[\fB-V, --version\fP]
[\fB-v, --verbose\fP]
\fImodules\fP
.PP 
.SH "DESCRIPTION" 
\fBxmp\fP is a tracked music module player\&. It plays many
module formats including Fasttracker II (XM), Noise/Fast/Protracker (MOD),
Scream Tracker 3 (S3M) and Impulse Tracker (IT)\&. Use \f(CWxmp --help\fP
for a complete list of supported formats\&.
.PP 
\fBxmp\fP can play through several output devices including the Open
Sound System sequencer, linear and ulaw PCM audio devices or mixing
to a raw or WAV file\&.
.PP 
.SH "OPTIONS" 
.IP "\fB-8, --8bit\fP" 
Convert 16 bit samples to 8 bit\&. You may want to use this mode to
save memory in the sound device (AWE cards will ignore this mode and
always work with 16 bit samples)\&.
.IP "\fB-a, --amplify\fP \fIfactor\fP" 
Amplification factor for the software mixer\&. Valid amplification factors
are 0 (normal), 1 (x2), 2 (x4) and 3 (x8)\&. Warning\&: amplification
factors higher than 0 may cause distorted or noisy output\&.
.IP "\fB-b, --bits\fP \fIbits\fP" 
Set the software mixer resolution (8 or 16 bits)\&. If ommited,
The audio device will be opened at the highest resolution available\&.
.IP "\fB-c, --stdout\fP" 
Mix the module to stdout\&.
.IP "\fB--chorus\fP \fIdepth\fP" 
Set chorus depth (if available)\&.
.IP "\fB-D\fP \fIdevice-specific parameter\fP" 
Pass a configuration parameter to the device driver\&. See the
\fBDEVICE DRIVER PARAMETERS\fP section below for a
list of known parameters\&. 
.IP "\fB-d, --driver\fP \fIdriver\fP" 
Select the output driver\&. If not specified, \fBxmp\fP will try to
probe each available driver\&.
.IP "\fB--fix-sample-loop\fP" 
Force sample loop start in samples instead of 16-bit words\&. This
option affects only MOD files\&.
.IP "\fB-F, --click-filter\fP" 
Use the LPF filter to remove clicks from the software mixer output\&.
.IP "\fB-f, --frequency\fP \fIrate\fP" 
Set the software mixer sampling rate in hertz\&.
.IP "\fB-h, --help\fP" 
Show a short summary of command-line options\&.
.IP "\fB-I, --instrument-path\fP \fIpath\fP" 
Set the pathname to the directory containing external samples\&.
.IP "\fB-i, --interpolate\fP" 
Enable software mixer linear interpolation\&.
.IP "\fB--load-only\fP" 
Exit after loading the module&.
.IP "\fB-l, --loop\fP" 
Enable module looping and backward pattern jumps\&.
.IP "\fB-M, --mute\fP \fIchannel-list\fP" 
Mute the specified channels\&. \fIchannel-list\fP is a comma-separated
list of decimal channel ranges\&. Example: 0,2-4,8-16\&.
.IP "\fB-m, --mono\fP" 
Force mono output (default is stereo in stereo-capable devices)\&.
.IP "\fB--nocmd\fP" 
Disable interactive commands\&.
.IP "\fB--nofilter\fP" 
Disable IT filters\&. When using the software mixer, IT filters can
significantly increase CPU usage on slow machines\&. In this case,
disable filtering with this option\&.
.IP "\fB-n, --nearest\fP" 
Enable software mixer nearest neighbor interpolation\&.
.IP "\fB--nopan\fP" 
Disable dynamic panning\&. This option can be used to prevent
clicking when playing in AWE32 cards\&. Module formats that rely only
in dynamic pan setting to produce stereo output (e\&.g\&. XM) will use
the MOD channel panning (LRRL)\&.
.IP "\fB--norc\fP" 
Don't read the configuration files\&.
.IP "\fB-o, --output-file\fP \fIfilename\fP" 
Set the output file name when mixing to raw or WAV files\&. If \'-\' is
given as the file name, the output will be sent to stdout\&.
.IP "\fB-P, --pan\fP \fInum\fP" 
Set the percentual panning amplitude\&.
.IP "\fB--probe-only\fP" 
Exit after probing the audio device\&.
.IP "\fB-R, --random\fP" 
Play modules in random order\&.
.IP "\fB--realtime\fP" 
Play modules in realtime priority (available for FreeBSD)\&.
.IP "\fB-r, --reverse\fP" 
Reverse the left/right stereo channels\&.
.IP "\fB--reverb\fP \fIdepth\fP" 
Set reverb depth (if available)\&.
.IP "\fB--show-time\fP" 
Display elapsed and remaining time\&.
.IP "\fB-S, --solo\fP \fIchannel-list\fP" 
Play only the specified channels\&. \fIchannel-list\fP is a
comma-separated list of decimal channel ranges\&. Example: 0,2-4,8-16\&.
.IP "\fB-s, --start\fP \fIpos\fP" 
Start playing the module from the position \fIpos\fP\&.
.IP "\fB--stereo\fP" 
Force stereo output\&.
.IP "\fB-T, --tempo\fP \fIbpm\fP" 
Set the initial tempo in beats per minute (default is 125)\&.
.IP "\fB-t, --time\fP \fItime\fP" 
Specifies the maximum playing time to \fItime\fP seconds\&.
.IP "\fB-u, --unsigned\fP" 
Tell the software mixer to use unsigned samples when mixing to
a file (default is signed)\&.
.IP "\fB-V, --version\fP" 
Print version information\&.
.IP "\fB-v, --verbose\fP" 
Verbose mode (incremental)\&. If specified more than once, the
verbosity level will be increased (no messages will be displayed
when the player runs in background)\&.
.PP 
.SH "DEVICE DRIVER PARAMETERS" 
Use the option \fB-D\fP to send parameters directly to the device
drivers\&. Multiple \fB-D\fP options can be specified in the command line\&.
.PP 
OSS sequencer:
.IP "\fB-D\fP \fIawechorus=mode\fP" 
Set the chorus mode in AWE cards. Valid modes range from 0 to 7
(CHORUS_1, CHORUS_2, CHORUS_3, CHORUS_4, FEEDBACK, FLANGER,
SHORTDELAY, SHORTDELAY2)\&.
.IP "\fB-D\fP \fIawereverb=mode\fP" 
Set the reverb mode in AWE cards\&. Valid modes range from 0 to 7
(ROOM1, ROOM2, ROOM3, HALL1, HALL2, PLATE, DELAY, PANNINGDELAY)\&.
.IP "\fB-D\fP \fIopl2\fP" 
Open the sequencer in OPL2 FM mode instead of sample mode\&. This
parameter is required to play modules with FM instruments (RAD,
AMD, S3M)\&.
.IP "\fB-D\fP \fIdev=device_name\fP" 
Set the sequencer device to open\&. Default is /dev/sequencer\&.
.PP 
OSS software mixing:
.IP "\fB-D\fP \fIfrag=num,size\fP" 
Set the maximum number of fragments to \fInum\fP and the size of
each fragment to \fIsize\fP bytes (must be a power of two)\&.
The number and size of fragments set a tradeoff between the buffering
latency and sensibility to system load\&. To get better synchronization,
reduce the values\&. To avoid gaps in the sound playback, increase
the values\&.
.IP "\fB-D\fP \fIdev=device_name\fP" 
Set the audio device to open\&. Default is /dev/dsp\&.
.IP "\fB-D\fP \fInosync\fP" 
Don\'t sync the OSS audio device between modules\&.
.PP 
HP-UX and Solaris audio:
.IP "\fB-D\fP \fIgain=value\fP" 
Set the audio gain\&. Valid \fIvalue\fP goes from 0 to 255\&.
The default is 128\&.
.IP "\fB-D\fP \fIport={s|h|l}\fP" 
Set the audio port\&. Valid arguments are \fIs\fP for the internal
speaker, \fIh\fP for headphones and \fIl\fP for line out\&. The default
is the internal speaker\&.
.IP "\fB-D\fP \fIbuffer=size\fP" 
Set the size in bytes of the audio buffer\&. The default value is 32 Kb\&.
.PP 
File output:
.IP "\fB-D\fP \fIbig-endian\fP" 
Generate big-endian 16-bit samples (default is the machine byte ordering)\&.
.IP "\fB-D\fP \fIlittle-endian\fP" 
Generate little-endian 16-bit samples (default is the machine byte ordering)\&.
.PP
.SH "INTERACTIVE COMMANDS" 
The following single key commands can be used when playing modules:
.IP "\fBq\fP" 
Stop the currently playing module and quit the player\&.
.IP "\fBf\fP" 
Jump to the next pattern\&.
.IP "\fBb\fP" 
Jump to the previous pattern\&.
.IP "\fBn\fP" 
Jump to the next module\&.
.IP "\fBp\fP" 
Jump to the previous module\&.
.IP "\fBSPACE\fP" 
Pause the module\&.
.IP "\fB1\fP, \fB2\fP, \fB3\fP, \fB4\fP, \fB5\fP, \fB6\fP, \fB7\fP, \fB8\fP, \fB9\fP, \fB0\fP" 
Mute/unmute channels 1 to 10\&.
.IP "\fB!\fP" 
Unmute all channels\&.
.PP 
Interactive mode can be disabled using the \fB--nocmd\fP command
line option\&.
.PP 
.SH "NOTES" 
When using the OSS sequencer with an AWE card, xmp will wipe out any
soundfonts already loaded in the card\&.
.PP
.SH "EXAMPLES" 
Play module muting channels 0 to 3 and 6\&:
.IP "" 
\f(CWxmp --mute=0-3,6 module\&.mod\&.gz\fP
.PP 
Play modules in /dev/dsp using the default device settings (unsigned 8bit,
8 kHz mono):
.IP "" 
\f(CWxmp -o/dev/dsp -f8000 -m -b8 -u module\&.lha\fP
.PP 
Play all XM modules in the /mod directory and all subdirectories in
random order, ignoring any configuration set in the xmp\&.conf file\&:
.IP "" 
\f(CWxmp --norc -R `find /mod -name "*\&.xm*" -print`\fP
.PP 
.SH "ENVIRONMENT" 
.IP "\fBXMP_INSTRUMENT_PATH\fP" 
Pathname to directory containing samples if not contained in the module\&.
.PP 
.IP "\fBXMP_MED2_INSTRUMENT_PATH\fP" 
Overrides samples directory for the MED2 loader\&.
.PP 
.SH "FILES" 
\f(CW/etc/xmp/xmp\&.conf\&, $HOME/\&.xmp/xmp\&.conf\&, /etc/xmp/modules\&.conf\&, $HOME/\&.xmp/modules\&.conf\fP
.PP 
.SH "AUTHOR" 
Claudio Matsuoka and Hipolito Carraro Jr. Portions of code
used in xmp have been contributed by several other authors,
see docs/CREDITS for the complete list.
.PP