XMP(1)                      Extended Module Player
XMP(1)



NNAAMMEE
       xmp - Extended Module Player

SSYYNNOOPPSSIISS
       xxmmpp  [--88,, ----88bbiitt]
       [--bb,, ----bbiittss _b_i_t_s]
       [--cc,, ----ssttddoouutt]
       [----cchhoorruuss _d_e_p_t_h] [--DD
       _d_e_v_i_c_e_-_s_p_e_c_i_f_i_c
       _p_a_r_a_m_e_t_e_r_s] [--dd,,
       ----ddrriivveerr  _d_r_i_v_e_r]
       [----ffiixx--ssaammppllee--lloooopp]
       [--ff,,  ----ffrreeqquueennccyy
       _r_a_t_e] [--hh,, ----hheellpp]
       [--ii,, ----iinntteerrppoollaattee]
       [----llooaadd--oonnllyy] [--ll,,
       ----lloooopp] [--MM,, ----mmuuttee
       _c_h_a_n_n_e_l_-_l_i_s_t] [--mm,,
       ----mmoonnoo] [----nnooccmmdd]
       [----nnooffiill‐‐ tteerr]
       [--nn,,  ----nneeaarreesstt]
       [----nnooppaann] [----nnoorrcc]
       [--oo,, ----oouuttppuutt--ffiillee
       _f_i_l_e_n_a_m_e] [--PP,, ----ppaann
       _p_a_n] [----pprroobbee--oonnllyy]
       [--RR ----rraannddoomm] [--rr
       ----rreevveerrssee]  [----rreevveerrbb
       _d_e_p_t_h]   [----rreeaallttiimmee]
       [--SS,,  ----ssoolloo
       _c_h_a_n_n_e_l_-_l_i_s_t]
       [--ss,,  ----ssttaarrtt  _p_o_s]
       [----sstteerreeoo] [--TT,,
       ----tteemmppoo _b_p_m] [--tt,,
       ----ttiimmee _t_i_m_e]  [--uu,,
       ----uunnssiiggnneedd]  [--VV,,
       ----vveerrssiioonn] [--vv,,
       ----vveerrbboossee] _m_o_d_u_l_e_s

DDEESSCCRRIIPPTTIIOONN
       xxmmpp  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 xmp --help for a
       complete list of supported formats.

       xxmmpp 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.

OOPPTTIIOONNSS
       --88,, ----88bbiitt
              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).

       --bb,, ----bbiittss _b_i_t_s
              Set the software mixer resolution (8 or 16
              bits).  If  ommited, The audio device will be
              opened at the highest resolution avail‐ able.

       --cc,, ----ssttddoouutt
              Mix the module to stdout.

       ----cchhoorruuss _d_e_p_t_h
              Set chorus depth (if available).

       --DD _d_e_v_i_c_e_-_s_p_e_c_i_f_i_c
       _p_a_r_a_m_e_t_e_r
              Pass a configuration parameter
              to the  device  driver.  See  the
              DDEEVVIICCEE  DDRRIIVVEERR
              PPAARRAAMMEETTEERRSS  section  below
              for  a list of known parameters.

       --dd,, ----ddrriivveerr _d_r_i_v_e_r
              Select the output driver. If not  specified,
              xxmmpp  will  try  to probe each available
              driver.

       ----ffiixx--ssaammppllee--lloooopp
              Force sample loop start in samples instead of
              16-bit words. This option affects only MOD files.

       --ff,, ----ffrreeqquueennccyy _r_a_t_e
              Set the software mixer sampling rate in hertz.

       --hh,, ----hheellpp
              Show a short summary of command-line options.

       --ii,, ----iinntteerrppoollaattee
              Enable software mixer linear interpolation.

       ----llooaadd--oonnllyy
              Exit after loading the module&.

       --ll,, ----lloooopp
              Enable module looping and backward pattern jumps.

       --MM,, ----mmuuttee
       _c_h_a_n_n_e_l_-_l_i_s_t
              Mute the specified
              channels. _c_h_a_n_n_e_l_-_l_i_s_t
              is  a  comma-separated list of decimal channel
              ranges. Example: 0,2-4,8-16.

       --mm,, ----mmoonnoo
              Force mono output (default is stereo in
              stereo-capable devices).

       ----nnooccmmdd
              Disable interactive commands.

       ----nnooffiilltteerr
              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.

       --nn,, ----nneeaarreesstt
              Enable software mixer nearest neighbor
              interpolation.

       ----nnooppaann
              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).

       ----nnoorrcc Don't read the configuration files.

       --oo,, ----oouuttppuutt--ffiillee
       _f_i_l_e_n_a_m_e
              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.

       --PP,, ----ppaann _n_u_m
              Set the percentual panning amplitude.

       --ll,, ----pprroobbee--oonnllyy
              Exit after probing the audio device.

       --RR,, ----rraannddoomm
              Play modules in random order.

       ----rreeaallttiimmee
              Play modules in realtime priority (available
              for FreeBSD).

       --rr,, ----rreevveerrssee
              Reverse the left/right stereo channels.

       ----rreevveerrbb _d_e_p_t_h
              Set reverb depth (if available).

       --SS,, ----ssoolloo
       _c_h_a_n_n_e_l_-_l_i_s_t
              Play  only the specified
              channels. _c_h_a_n_n_e_l_-_l_i_s_t
              is a comma-sepa‐ rated list of decimal channel
              ranges. Example: 0,2-4,8-16.

       --ss,, ----ssttaarrtt _p_o_s
              Start playing the module from the position
              _p_o_s.

       ----sstteerreeoo
              Force stereo output.

       --tt,, ----tteemmppoo _b_p_m
              Set the initial tempo in beats per minute
              (default is 125).

       --tt,, ----ttiimmee _t_i_m_e
              Specifies the maximum playing time to
              _t_i_m_e seconds.

       --uu,, ----uunnssiiggnneedd
              Tell the software mixer to use unsigned samples
              when mixing to a file (default is signed).

       --VV,, ----vveerrssiioonn
              Print version information.

       --vv,, ----vveerrbboossee
              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).

DDEEVVIICCEE DDRRIIVVEERR
PPAARRAAMMEETTEERRSS
       Use  the  option  --DD to send parameters directly
       to the device drivers.  Multiple --DD options can
       be specified in the command line.

       OSS sequencer:

       --DD _a_w_e_c_h_o_r_u_s_=_m_o_d_e
              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).

       --DD _a_w_e_r_e_v_e_r_b_=_m_o_d_e
              Set the reverb mode in AWE cards. Valid modes
              range from 0 to  7 (ROOM1, ROOM2, ROOM3, HALL1,
              HALL2, PLATE, DELAY, PANNINGDELAY).

       --DD _o_p_l_2
              Open  the sequencer in OPL2 FM mode instead of
              sample mode. This parameter is required to play
              modules with FM instruments  (RAD, AMD, S3M).

       --DD _d_e_v_=_d_e_v_i_c_e___n_a_m_e
              Set the sequencer device to open. Default is
              /dev/sequencer.

       OSS software mixing:

       --DD _f_r_a_g_=_n_u_m_,_s_i_z_e
              Set  the maximum number of fragments to _n_u_m
              and the size of each fragment to _s_i_z_e
              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.

       --DD _d_e_v_=_d_e_v_i_c_e___n_a_m_e
              Set the audio device to open. Default is
              /dev/dsp.

       --DD _n_o_s_y_n_c
              Don´t sync the OSS audio device between modules.

       HP-UX and Solaris audio:

       --DDggaaiinn==_g_a_i_n
              Set the audio gain. Valid values go from 0
              to 255.  The  default value is 128.

       --DDppoorrtt==_{_s_|_h_|_l_}
              Set  the  audio  port.  Valid  arguments
              are _s for the internal speaker, _h for
              headphones and _l for line out. The default
              is the internal speaker.

       --DDbbuuffffeerr==_s_i_z_e
              Set  the size in bytes of the audio buffer. The
              default value is 32 Kb.

       File output:

       ----DDbbiigg--eennddiiaann
              Generate big-endian 16-bit samples (default is
              the machine  byte ordering).

       ----DDlliittttllee--eennddiiaann
              Generate  little-endian  16-bit  samples
              (default is the machine byte ordering).

IINNTTEERRAACCTTIIVVEE CCOOMMMMAANNDDSS
       The following single key commands can be used when
       playing modules:

       qq      Stop the currently playing module and quit
       the player.

       ff      Jump to the next pattern.

       bb      Jump to the previous pattern.

       nn      Jump to the next module.

       pp      Jump to the previous module.

       SSPPAACCEE  Pause the module.

       11, 22, 33, 44, 55, 66, 77, 88, 99, 00
              Mute/unmute channels 1 to 10.

       !!      Unmute all channels.

       Interactive mode can be disabled using the
       ----nnooccmmdd command line option.

NNOOTTEESS
       When using the OSS sequencer with an AWE card, xmp will
       wipe  out  any soundfonts already loaded in the card.

EEXXAAMMPPLLEESS
       Play module muting channels 0 to 3 and 6:

              xmp --mute=0-3,6 module.mod.gz

       Play  modules  in  /dev/dsp using the default device
       settings (unsigned 8bit, 8 kHz mono):

              xmp -o/dev/dsp -f8000 -m -b8 -u module.lha

       Play all XM modules in the /mod directory  and
       all  subdirectories  in random order, ignoring any
       configuration set in the xmp.conf file:

              xmp --norc -R `find /mod -name "*.xm*" -print`

FFIILLEESS
       /etc/xmp/xmp.conf,    /etc/xmp/xmp-modules.conf,
       $HOME/.xmp/xmp.conf, $HOME/.xmp/xmp-modules.conf

AAUUTTHHOORR
       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.

Dec 2007                         Version 2.5.1
XMP(1)
