1MIKMOD(1)                   General Commands Manual                  MIKMOD(1)
2
3
4

NAME

6       mikmod - play soundtracker etc. modules on a Unix machine.
7
8
9

SYNOPSIS

11       mikmod [-options]... [module|playlist]...
12
13
14

DESCRIPTION

16       MikMod  is  a  very  portable module player based on libmikmod, written
17       originally by Jean-Paul Mikkers (MikMak). It will play the IT, XM, MOD,
18       MTM,  S3M, STM, ULT, FAR, MED, DSM, AMF, IMF and 669 module formats. It
19       works under AIX, FreeBSD, HP-UX, IRIX, Linux, NetBSD,  OpenBSD,  OSF/1,
20       SunOS, Solaris, OS/2, DOS, and Windows. It is controllable via an easy-
21       to-use curses interface and will extract and play modules from a  vari‐
22       ety of different archive formats.
23
24
25

OPTIONS

27       Options  can  be  given  in  any order, and are case-sensitive. For the
28       options which have both a short and a long form, the long form  can  be
29       prefixed  by  one  or  two  dashes.  Note  that  the  settings  in your
30       $HOME/.mikmodrc will override the defaults shown in this man page.
31
32
33

OUTPUT OPTIONS

35       -d n
36
37       --driver n
38              Use the specified device driver for output, 0 is autodetect. The
39              default  is  0.   If  your  installed libmikmod engine is recent
40              enough (>=3.1.7), you can also specify the driver with an alias,
41              as  well  as  driver  options  separated by commas. The list and
42              driver aliases and recognized options can be  found  in  libmik‐
43              mod's documentation.
44
45       -o[utput] 8m|8s|16m|16s
46              Output  settings,  8 or 16 bit in stereo or mono. The default is
47              "16s".
48
49       -f freq
50
51       --frequency freq
52              Set mixing frequency in hertz. The default is 44100.
53
54       -i
55
56       --interpolate
57              Use interpolated mixing. This will generally improve audio qual‐
58              ity,  at  the  expense  of  a bit more CPU usage. Note that this
59              option alters the behaviour of software drivers only ;  hardware
60              drivers are not affected (default).
61
62       --nointerpolate
63              Do not use interpolated mixing.
64
65       -hq
66
67       --hqmixer
68              Use  high  quality  software mixer. This improves audio quality,
69              but requires a lot more CPU power. Note that this option  alters
70              the  behaviour  of  software drivers only ; hardware drivers are
71              not affected.
72
73       --nohqmixer
74              Do not use high quality software mixer (default).
75
76       -s
77
78       --surround
79              Use surround mixing.
80
81       --nosurround
82              Do not use surround mixing (default).
83
84       -r n
85
86       --reverb n
87              Sets reverb amount from 0 (no reverb) to 15  (max  reverb).  The
88              default is 0 (no reverb).
89
90
91

PLAYBACK OPTIONS

93       -v volume
94
95       --volume volume
96              Set volume from 0% (silence) to 100%. The default is 100%.
97
98       -F
99
100       --fadeout
101              Fade out the volume during the last pattern of each module.
102
103       --nofadeout
104              Do  not fade out the volume during the last pattern of each mod‐
105              ule (default).
106
107       -l
108
109       --loops
110              Enable in-module backwards loops.
111
112       --noloops
113              Disable in-module backwards loops (default).
114
115       -a
116
117       --panning
118              Process panning  effects  (default).  This  should  be  disabled
119              (using --nopanning) for very old demo modules which use the pan‐
120              ning effects for synchronization purposes.
121
122       --nopanning
123              Do not process panning effects.
124
125       -x
126
127       --protracker
128              Enable protracker extended speed effect (default).  This  should
129              be  disabled  (using  --noprotracker)  for very old demo modules
130              which use the extended speed  effect  for  synchronization  pur‐
131              poses.
132
133       --noprotracker
134              Disable protracker extended speed effect.
135
136
137

LOADING OPTIONS

139       -y dir
140
141       --directory dir
142              Scan directory recursively for modules.
143
144       -c
145
146       --curious
147              Look for hidden patterns in module. Most modules don't have hid‐
148              den patterns,  but  you  can  find  "bonus"  patterns  (or  just
149              silence) in some modules.
150
151       --nocurious
152              Do not look for hidden patterns in module (default).
153
154       -p n
155
156       --playmode n
157              Playlist  mode.  The allowed values here are 1, to loop the cur‐
158              rent module; 2, to play the whole  playlist  repeatedly;  4,  to
159              shuffle  the  list before playing, and 8, to play the whole list
160              randomly. The default is 2.
161
162       -t
163
164       --tolerant
165              Don't halt MikMod if a module cannot be read or  is  an  unknown
166              format (default).
167
168       --notolerant
169              Halt MikMod if a module cannot be read or is an unknown format.
170
171
172

SCHEDULING OPTIONS

174       The  following  options need root privileges (or a setuid root binary),
175       and don't work under all systems.
176
177       -s
178
179       --renice
180              Renice to -20 if possible to gain more CPU priority. This option
181              is  only  available  under  FreeBSD,  Linux, NetBSD, OpenBSD and
182              OS/2.
183
184       --norenice
185              Do not renice to -20 (default).
186
187       -S
188
189       --realtime
190              Reschedule mikmod to gain real-time priority (and thus more  CPU
191              time).   DANGEROUS! USE WITH CAUTION! This option is only avail‐
192              able under FreeBSD, Linux and OS/2.
193
194       --norealtime
195              Do not reschedule MikMod to gain real-time priority (default).
196
197
198

DISPLAY OPTIONS

200       -q
201
202       --quiet
203              Quiet mode. Disables  interactive  commands  and  displays  only
204              errors.
205
206
207

INFORMATION OPTIONS

209       -n
210
211       --information
212              Display the list of the known drivers and module loaders.
213
214       -N n
215
216       --drvinfo n
217              Display information about a specific driver.
218
219       -V
220
221       --version
222              Display MikMod version.
223
224       -h
225
226       --help Display a summary of the options.
227
228
229

CONFIGURATION OPTION

231       --norc Do  not  parse the $HOME/.mikmodrc configuration file. This file
232              contains your default settings, so that you don't have to  spec‐
233              ify them each time you run MikMod. The file is read when you run
234              MikMod and updated on exit. Using this  option  prevents  MikMod
235              from accessing this file.
236
237
238

RUNTIME COMMANDS

240       At play time, the following keystrokes offer control over MikMod:
241
242       H, function key F1
243              Display help panel.
244
245       S, function key F2
246              Display samples panel.
247
248       I, function key F3
249              Display instruments panel (if present in the module).
250
251       M, function key F4
252              Display song message panel (if present in the module).
253
254       L, function key F5
255              Display the playlist panel.
256
257       C, function key F6
258              Display the configuration panel.
259
260       V, function key F7
261              Display the volume panel.
262
263       digits Set volume from 10% (digit 1) to 100% (digit 0).
264
265       <      Decrease volume.
266
267       >      Increase volume.
268
269       -, Left
270              Restart current pattern / skip to previous pattern.
271
272       +, Right
273              Skip to next pattern in current module.
274
275       Up, Down
276              Scroll panel.
277
278       PgUp, PgDown
279              Scroll panel (faster).
280
281       Home   Go on top of the panel.
282
283       End    Go to the end of the panel.
284
285       (      Decrease speed variable (module plays faster).
286
287       )      Increase speed variable (module plays slower).
288
289       {      Decrease tempo variable (module plays slower).
290
291       }      Increase tempo variable (module plays faster).
292
293       : or ; Toggle interpolation mixing.
294
295       U      Toggle surround mixing.
296
297       Q      Exit MikMod.
298
299       P      Switch to previous module in playlist.
300
301       N      Switch to next module in playlist.
302
303       R      Restart current module.
304
305       F      Toggle fake/real volume bars in volume panel.
306
307       space  Toggle pause.
308
309       Control-L
310              Refresh the screen.
311
312
313
315       Some  functions  of MikMod are available through menus, in the playlist
316       and configuration panels.
317
318       You can select commands in the menus either  by  moving  the  selection
319       with  the  arrow  keys  and pressing enter, or entering the highlighted
320       letter corresponding ot the command you want to select.
321
322       Menu entries ending with a > character open a submenu, whereas  entries
323       ending  in  ...  open a dialog box. You can dismiss a submenu either by
324       choosing a command in this menu, or using the  left  arrow  key  to  go
325       back, or switching panels.
326
327       In  dialog  boxes, you can move the focus from the input line to the Ok
328       and Cancel buttons either with the "tab" key, or the up and down  arrow
329       keys.
330
331       Also,  if  the statusbar is active (which is the default behaviour), it
332       will contain a short help text describing  the  menu  option  currently
333       highlighted.
334
335
336

PLAYLIST MENU

338       When  the  playlist  panel  is  displayed, pressing the return key will
339       popup a menu. The menu commands are:
340
341
342       Play   Continue list playback from the currently highlighted module.
343
344       Remove Remove module from the playlist.
345
346       Delete...
347              Remove module from the playlist, and delete module file on disk,
348              or  whole  archive  if  the module is stored in an archive file.
349              This function asks you to confirm your choice.
350
351       File > This entry opens a submenu with four commands, "Load", "Insert",
352              "Save" and "Save as". The Load and Insert commands ask you for a
353              filename, and replace the playlist with it (load)  or  merge  it
354              with  the  playlist (insert). No wildcards are allowed. The Save
355              and Save as commands save the current playlist  in  a  file,  by
356              default  ``playlist.mpl'',  in  the current directory. Note that
357              playlist filenames should end in .mpl, or they won't  be  recog‐
358              nized immediately as a playlist by MikMod.
359
360       Shuffle
361              Randomize the playlist.
362
363       Sort > This  entry opens a submenu with sort commands. You can select a
364              normal or reverse order, and then sort the playlist with one  of
365              the four criteria: by name, by extension, by path or by time.
366
367       Back   Discards the menu.
368
369
370

CONFIGURATION PANEL

372       The  configuration  panel  lets you customize your MikMod settings, and
373       save them.  You can also try some particular  settings  without  losing
374       your previous configuration.
375
376
377       Output options
378              This  section  lets  you choose various vital playback settings,
379              such as the output driver, the stereo/mono and 16/8  bit  output
380              settings,  the  playback  frequency, and the software mixer set‐
381              tings.
382
383       Playback options
384              This section lets you choose various module  playback  settings,
385              such as the output volume, the processing of panning effects and
386              bacwards loops, etc.
387
388       Other options
389              This section lets you choose the remaining settings, such as the
390              playlist mode, and various program settings.
391
392
393       Use config
394              This  command  activates the current configuration settings, but
395              does not save them.
396
397       Save config
398              This command saves and activates the current configuration  set‐
399              tings.
400
401       Revert config
402              This command reverts to the on-disk configuration file settings.
403
404
405

MODULE FORMATS

407       MikMod  will currently play the following common and not so common for‐
408       mats:
409
410       669    Composer 669 and Extended 669 modules.
411
412       AMF    DSMI internal module format (Advanced Module  Format,  converted
413              with M2AMF).
414
415       AMF    ASYLUM Music format (From crusader games)
416
417       DSM    DSIK's internal module format.
418
419       FAR    Farandole composer modules.
420
421       GDM    General  Digital  Munsic  internal module format (converted with
422              2GDM).
423
424       IMF    Imago Orpheus modules.
425
426       IT     Impulse Tracker modules.
427
428       MED    Amiga MED modules, but synthsounds are not supported.
429
430       MOD    Protracker, Startracker, Fasttracker, Oktalyzer, and Taketracker
431              modules.
432
433       MTM    Multitracker module editor modules.
434
435       S3M    Screamtracker version 3 modules.
436
437       STM    Screamtracker version 2 modules.
438
439       STX    STMIK converted modules.
440
441       ULT    Ultratracker modules.
442
443       UNI, APUN
444              Old MikMod (UNI) and APlayer (APUN) internal module format.
445
446       XM     Fasttracker 2 modules.
447
448
449

ARCHIVE FORMATS

451       MikMod  should  recognize and extract the following common archive for‐
452       mats.  However, to use each of these you will need to find  the  appro‐
453       priate program(s) for MikMod to use to extract them. These are commonly
454       available and you will most likely find them with this distribution  of
455       MikMod.  Other archive formats can be configured by editing the config‐
456       uration file (see FILES below).
457
458
459       zip    Info-zip or PkZip archives, commonly used on  DOS/Windows  plat‐
460              forms.
461
462       lha, lzh
463              Lharc archives, commonly used on the Amiga.
464
465       zoo    Zoo archives, quite rare those days...
466
467       rar    Rar archives.
468
469       gz     Gzip compressed files.
470
471       bz2    Bzip2 compressed files.
472
473       tar, tar.gz and tar.bz2
474              Tar archives, even compressed with gzip or bzip2.
475
476
477

FILES

479       $HOME/.mikmodrc (or mikmod.cfg under OS/2 / Windows)
480              User configuration settings.
481
482       $HOME/.mikmod_playlist  (mikmodpl.cfg/mikmod_playlist.mpl  under OS/2 /
483       Windows)
484              The default playlist, loaded if no other files are specified  on
485              the command line.
486
487       playlist.mpl
488              Default playlist filename.
489
490
491

AUTHORS

493       MikMod  is  the result of the work of many people, including: Jean-Paul
494       Mikkers, Jake Stine, Miodrag Vallat, Frank Loemker,  Andrew  Zabolotny,
495       Raphael  Assenat,  Steve  McIntyre, Peter Amstutz, "MenTaLguY", Dimitri
496       Boldyrev, Shlomi Fish, Stefan Tibus, Tinic Urou.  A full list of people
497       having worked on libmikmod and MikMod is displayed when MikMod starts.
498
499
500

LOCATING NEWER VERSIONS

502       The official MikMod and libmikmod home page is at
503         http://mikmod.sourceforge.net/
504
505
506
507
508                         Version 3.2.8, 07 April 2017                MIKMOD(1)
Impressum