| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH OPENMPT123 "1" "May 2026" "openmpt123 v0.8.7" "User Commands" |
| 3 |
.SH NAME |
| 4 |
openmpt123 - command line module music player based on libopenmpt |
| 5 |
.SH SYNOPSIS |
| 6 |
.B openmpt123 |
| 7 |
[\fI\,options\/\fR] [\fI\,--\/\fR] \fI\,file1 \/\fR[\fI\,file2\/\fR] ... |
| 8 |
.SH DESCRIPTION |
| 9 |
openmpt123 v0.8.7, libopenmpt 0.8.7+r25325 (OpenMPT 1.32.10.00 https://source.openmpt.org/svn/openmpt/tags/libopenmpt\-0.8.7@25325 (2026\-05\-17T11:08:12.701337Z) clean) |
| 10 |
Copyright \(co 2013\-2026 OpenMPT Project Developers and Contributors <https://lib.openmpt.org/> |
| 11 |
.PP |
| 12 |
openmpt123 plays module music files. |
| 13 |
.SH OPTIONS |
| 14 |
.TP |
| 15 |
\fB\-h\fR, \fB\-\-help\fR |
| 16 |
Show help |
| 17 |
.TP |
| 18 |
\fB\-\-help\-keyboard\fR |
| 19 |
Show keyboard hotkeys in ui mode |
| 20 |
.TP |
| 21 |
\fB\-q\fR, \fB\-\-quiet\fR |
| 22 |
Suppress non\-error screen output |
| 23 |
.TP |
| 24 |
\fB\-v\fR, \fB\-\-verbose\fR |
| 25 |
Show more screen output |
| 26 |
.TP |
| 27 |
\fB\-\-version\fR |
| 28 |
Show version information and exit |
| 29 |
.TP |
| 30 |
\fB\-\-short\-version\fR |
| 31 |
Show version number and nothing else |
| 32 |
.TP |
| 33 |
\fB\-\-long\-version\fR |
| 34 |
Show long version information and exit |
| 35 |
.TP |
| 36 |
\fB\-\-credits\fR |
| 37 |
Show elaborate contributors list |
| 38 |
.TP |
| 39 |
\fB\-\-license\fR |
| 40 |
Show license |
| 41 |
.TP |
| 42 |
\fB\-\-probe\fR |
| 43 |
Probe each file whether it is a supported file format |
| 44 |
.TP |
| 45 |
\fB\-\-info\fR |
| 46 |
Display information about each file |
| 47 |
.TP |
| 48 |
\fB\-\-ui\fR |
| 49 |
Interactively play each file |
| 50 |
.TP |
| 51 |
\fB\-\-batch\fR |
| 52 |
Play each file |
| 53 |
.TP |
| 54 |
\fB\-\-render\fR |
| 55 |
Render each file to individual PCM data files |
| 56 |
.TP |
| 57 |
\fB\-\-banner\fR n |
| 58 |
openmpt123 banner style [0=hide,1=show,2=verbose] [default: 1] |
| 59 |
.TP |
| 60 |
\fB\-\-assume\-terminal\fR |
| 61 |
Skip checking whether stdin/stderr are a terminal, and always allow UI [default: 0] |
| 62 |
.TP |
| 63 |
\fB\-\-terminal\-width\fR n |
| 64 |
Assume terminal is n characters wide [default: \fB\-1]\fR |
| 65 |
.TP |
| 66 |
\fB\-\-terminal\-height\fR n |
| 67 |
Assume terminal is n characters high [default: \fB\-1]\fR |
| 68 |
.TP |
| 69 |
\fB\-\-[no\-]progress\fR |
| 70 |
Show playback progress [default: 1] |
| 71 |
.TP |
| 72 |
\fB\-\-[no\-]meters\fR |
| 73 |
Show peak meters [default: 1] |
| 74 |
.TP |
| 75 |
\fB\-\-[no\-]channel\-meters\fR |
| 76 |
Show channel peak meters (EXPERIMENTAL) [default: 0] |
| 77 |
.TP |
| 78 |
\fB\-\-[no\-]pattern\fR |
| 79 |
Show pattern (EXPERIMENTAL) [default: 0] |
| 80 |
.TP |
| 81 |
\fB\-\-[no\-]details\fR |
| 82 |
Show song details [default: 1] |
| 83 |
.TP |
| 84 |
\fB\-\-[no\-]message\fR |
| 85 |
Show song message [default: 0] |
| 86 |
.TP |
| 87 |
\fB\-\-update\fR n |
| 88 |
Set output update interval to n ms [default: \fB\-1]\fR |
| 89 |
.TP |
| 90 |
\fB\-\-samplerate\fR n |
| 91 |
Set samplerate to n Hz [default: 48000] |
| 92 |
.TP |
| 93 |
\fB\-\-channels\fR n |
| 94 |
use n [1,2,4] output channels [default: 2] |
| 95 |
.TP |
| 96 |
\fB\-\-[no\-]float\fR |
| 97 |
Output 32bit floating point instead of 16bit integer [default: 1] |
| 98 |
.TP |
| 99 |
\fB\-\-gain\fR n |
| 100 |
Set output gain to n dB [default: 0] |
| 101 |
.TP |
| 102 |
\fB\-\-stereo\fR n |
| 103 |
Set stereo separation to n % [default: 100] |
| 104 |
.TP |
| 105 |
\fB\-\-filter\fR n |
| 106 |
Set interpolation filter taps to n [1,2,4,8] [default: 8] |
| 107 |
.TP |
| 108 |
\fB\-\-ramping\fR n |
| 109 |
Set volume ramping strength n [0..5] [default: \fB\-1]\fR |
| 110 |
.TP |
| 111 |
\fB\-\-tempo\fR f |
| 112 |
Set tempo factor f [default: 1] |
| 113 |
.TP |
| 114 |
\fB\-\-pitch\fR f |
| 115 |
Set pitch factor f [default: 1] |
| 116 |
.TP |
| 117 |
\fB\-\-dither\fR n |
| 118 |
Dither type to use (if applicable for selected output format): [0=off,1=auto,2=0.5bit,3=1bit] [default: 1] |
| 119 |
.TP |
| 120 |
\fB\-\-playlist\fR file |
| 121 |
Load playlist from file |
| 122 |
.TP |
| 123 |
\fB\-\-[no\-]randomize\fR |
| 124 |
Randomize playlist [default: 0] |
| 125 |
.TP |
| 126 |
\fB\-\-[no\-]shuffle\fR |
| 127 |
Shuffle through playlist [default: 0] |
| 128 |
.TP |
| 129 |
\fB\-\-[no\-]restart\fR |
| 130 |
Restart playlist when finished [default: 0] |
| 131 |
.TP |
| 132 |
\fB\-\-subsong\fR n |
| 133 |
Select subsong n (\fB\-1\fR means play all subsongs consecutively) [default: \fB\-1]\fR |
| 134 |
.TP |
| 135 |
\fB\-\-repeat\fR n |
| 136 |
Repeat song n times (\fB\-1\fR means forever) [default: 0] |
| 137 |
.TP |
| 138 |
\fB\-\-seek\fR n |
| 139 |
Seek to n seconds on start [default: 0] |
| 140 |
.TP |
| 141 |
\fB\-\-end\-time\fR n |
| 142 |
Play until position is n seconds (0 means until the end) [default: 0] |
| 143 |
.TP |
| 144 |
\fB\-\-ctl\fR c=v |
| 145 |
Set libopenmpt ctl c to value v |
| 146 |
.TP |
| 147 |
\fB\-\-driver\fR n |
| 148 |
Set output driver [default: default], |
| 149 |
.TP |
| 150 |
\fB\-\-device\fR n |
| 151 |
Set output device [default: default], |
| 152 |
use \fB\-\-device\fR help to show available devices |
| 153 |
.TP |
| 154 |
\fB\-\-buffer\fR n |
| 155 |
Set output buffer size to n ms [default: \fB\-1]\fR |
| 156 |
.TP |
| 157 |
\fB\-\-period\fR n |
| 158 |
Set output period size to n ms [default: \fB\-1]\fR |
| 159 |
.TP |
| 160 |
\fB\-\-stdout\fR |
| 161 |
Write raw audio data to stdout [default: 0] |
| 162 |
.TP |
| 163 |
\fB\-\-output\-type\fR t |
| 164 |
Use output format t when writing to a individual PCM files (only applies to \fB\-\-render\fR mode) [default: auto] |
| 165 |
.TP |
| 166 |
\fB\-o\fR, \fB\-\-output\fR f |
| 167 |
Write PCM output to file f instead of streaming to audio device (only applies to \fB\-\-ui\fR and \fB\-\-batch\fR modes) [default: ] |
| 168 |
.TP |
| 169 |
\fB\-\-force\fR |
| 170 |
Force overwriting of output file [default: 0] |
| 171 |
.TP |
| 172 |
\fB\-\-\fR |
| 173 |
Interpret further arguments as filenames |
| 174 |
.PP |
| 175 |
Keyboard hotkeys (use 'openmpt123 \fB\-\-ui\fR'): |
| 176 |
.TP |
| 177 |
[q] |
| 178 |
quit |
| 179 |
.TP |
| 180 |
[ ] |
| 181 |
pause / unpause |
| 182 |
.TP |
| 183 |
[N] |
| 184 |
skip 10 files backward |
| 185 |
.TP |
| 186 |
[n] |
| 187 |
prev file |
| 188 |
.TP |
| 189 |
[m] |
| 190 |
next file |
| 191 |
.TP |
| 192 |
[M] |
| 193 |
skip 10 files forward |
| 194 |
.TP |
| 195 |
[h] |
| 196 |
seek 10 seconds backward |
| 197 |
.TP |
| 198 |
[j] |
| 199 |
seek 1 seconds backward |
| 200 |
.TP |
| 201 |
[k] |
| 202 |
seek 1 seconds forward |
| 203 |
.TP |
| 204 |
[l] |
| 205 |
seek 10 seconds forward |
| 206 |
.TP |
| 207 |
[u]|[i] |
| 208 |
+/\- tempo |
| 209 |
.TP |
| 210 |
[o]|[p] |
| 211 |
+/\- pitch |
| 212 |
.TP |
| 213 |
[3]|[4] |
| 214 |
+/\- gain |
| 215 |
.TP |
| 216 |
[5]|[6] |
| 217 |
+/\- stereo separation |
| 218 |
.TP |
| 219 |
[7]|[8] |
| 220 |
+/\- filter taps |
| 221 |
.TP |
| 222 |
[9]|[0] |
| 223 |
+/\- volume ramping |
| 224 |
.SH COPYRIGHT |
| 225 |
Copyright \(co 2013\-2026 OpenMPT Project Developers and Contributors <https://lib.openmpt.org/> |