GMOD(1)

NAME
gmod - play music modules

SYNOPSIS
gmod [-bcehlpqrRsxz] [-m mixer] [-v volume] [module...]

DESCRIPTION
This manual page documents gmod, a music module file player for Linux and the Gravis Ultrasound card. Gmod is capable of playing 669, MOD, Multitracker (MTM), Scream Tracker III (S3M), and Ultratracker (ULT) files.

Modules compressed with compress or gzip can be played by gmod, if /usr/bin/gunzip is installed. Compressed modules must end in .z, .Z, or .gz.

The modules will be played in the order specified on the command line. The following keys can be used while the module is playing, unless the -z option was specified:

n   Next module.

p   Previous module.

q   Quit.

+   Increase sequencer volume.

-   Decrease sequencer volume.

0..9
    Set sequencer volume to the key times 10. Key 0 means 100.

In addition, gmod understands the following signals:

SIGTERM
    Quit.

SIGUSR1
    Previous module.

SIGUSR2
    Next module.

OPTIONS

-b  (MOD only) Disable BPM tempos. Specifying this option will cause gmod to treat all speed commands as changes to the number of ticks per note.

-c  Disable compression of modules in memory. Normally, modules are compressed in memory in order to use less space. Specifying this option will save some CPU time.

-e  Show empty samples. Use this option to display information about all samples in a module, even if some are empty.

-h  Display help.

-l  Break infinite pattern loops in modules.

-m mixer
    Use mixer number mixer. Gmod will attempt to use /dev/mixer if this option is not specified. Specifying this option will cause gmod to use /dev/mixern, where n is the specified mixer. Valid values are 0 to 15.

-p  (MOD only) Use PAL sample timing. This option should be used with modules composed on PAL (European) machines.

-q  Quiet mode. No text output will be produced.

-r  Infinitely repeat the current module.

-R  Randomize the play order of the modules.

-s  (MOD only) Ignore "speed 0" commands. Ordinarily, "speed 0" commands cause playing to stop.

-v volume
    Set the volume to volume. Valid values are 0 to 255.

-x  (MOD only) Extend octaves. Normally, the range of notes in modules is limited to what is specified by the standard. This option removes that restriction.

-z  Background mode. This option does not put gmod in the background; rather, it allows gmod to run in the background. The keys that can be normally used while a module is playing no longer work, and the display of the current position and pattern is disabled.

NOTES
Setting the sequencer volume to anything greater than approximately 60 when gmod's volume (-v) is set to 255 will cause volume clipping. Lower gmod volumes will allow higher sequencer volumes before clipping occurs.

DIAGNOSTICS
The exit codes are:

0   Normal termination.

50  Bad arguments.

51  An error occurred while attempting to access the sequencer.

52  An error occurred while attempting to load a module

53  No GUS card was found.

AUTHORS
Original source by Hannu Savolainen.

MultiTracker/Ultratracker loading by Robert Sanders.

Many other modifications have been performed by Andrew J. Robinson <robinson@cnj.digex.net>. Andrew is currently the maintainer of gmod. Please direct any comments, questions, bug reports, etc. to him.