gmod - play music modules

gmod [-bcehlMnqrRsxz] [-m mixer] [-P pan-factor] [-v volume] [module...]

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

Modules compressed with compress, gzip, lharc, or zip can be played by gmod, if gunzip, lharc, and/or zip are installed.

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 (special keys -- arrows, etc -- only work if gmod was compiled with ncurses support):

b, left arrow

Move backwards <numeric argument> positions.

f, right arrow

Move forward <numeric argument> positions.

n, next page

Next module.

p, previous page

Previous module.

q

Quit.

+

Increase sequencer volume by <numeric argument>.

-

Decrease sequencer volume by <numeric argument>.

up arrow

Scroll sample list up.

down arrow

Scroll sample list down.

0..9

Set numeric argument. For example, keying 1 0 will set the numeric argument to 10. The argument will remain in effect until a command which uses the argument is executed and a new argument is entered. For example, 10ff will advance 20 positions, and 10f5f will advance 15 positions.

In addition, gmod understands the following signals:

SIGTERM

Quit.

SIGUSR1

Previous module.

SIGUSR2

Next module.

-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. (Not supported for S3M modules). This option only works if gmod was compiled without ncurses support.

-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.

-M

(MOD only) Check magic number. Do not play modules which do not have a magic number. Old 15 channel modules do not have magic numbers.

-n

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

-P pan-factor

Set the panning factor. Valid values are -100 to 100. Higher absolute values produce more panning. Negative values cause the left/right channels to be swapped. The default value is 100.

-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. Use this option if a module seems to suddenly stop in the middle.

-v volume

Set the volume to volume. Valid values are 0 to 255. The default value is 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.

-5

(MOD only) Use 50 Hz clock frequency. Specifying this option will cause speed changes to be calculated using a 50 Hz frequency base. The default value is 60 Hz.

The gmodrc file is used to determine settings to be used for particular modules. GMOD will first look for a file named .gmodrc in the user's home directory, and if it is not found, it will look for /usr/etc/gmodrc. The gmodrc settings are combined with the options given on the command line. The format of the file is:

filename(without path) option ...

For example, if mymodule.mod uses NTSC sample timing and speed 0 commands should be ignored, the following line could be entered in the gmodrc file:

mymodule.mod ntsc nospeed0

Spacing is not important, but case is significant. The module name must start at the leftmost position of the line. The length of the line is limited to 160 characters.

Valid options are (corresponding command-line options are in parenthesis): nobpm (-b), ntsc (-n), nospeed0 (-s), extend (-x), and 50hz (-5)

This applies only if gmod is compiled without linear volume support: 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.

MOD files use various timing methods. Different methods and the corresponding options are listed below:

NTSC (60 Hz) CIA: -n

PAL (50 Hz) CIA: no options (default)

NTSC (60 Hz) Vblank: -bn

PAL (50 Hz) Vblank: -b5

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.

Original source by Hannu Savolainen.

MultiTracker/Ultratracker loading by Robert Sanders.

Many other modifications have been performed by Andrew J. Robinson <arobinso@nyx.net>. Andrew is currently the maintainer of gmod. Please direct any comments, questions, bug reports, etc. to him. There is current a gmod WWW page available through http://www.nyx.net/~arobinso.

gmod is Copyright (C) 1996 by Andrew J. Robinson.