.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH OPENMPT123 "1" "March 2024" "openmpt123 v0.7.6" "User Commands"
.SH NAME
openmpt123 - command line module music player based on libopenmpt
.SH SYNOPSIS
.B openmpt123
[\fI\,options\/\fR] [\fI\,--\/\fR] \fI\,file1 \/\fR[\fI\,file2\/\fR] ...
.SH DESCRIPTION
openmpt123 v0.7.6, libopenmpt 0.7.6+r20445 (OpenMPT 1.31.06.00 https://source.openmpt.org/svn/openmpt/tags/libopenmpt\-0.7.6@20445 (2024\-03\-24T12:17:57.924136Z) clean)
Copyright \(co 2013\-2024 OpenMPT Project Developers and Contributors <https://lib.openmpt.org/>
.PP
openmpt123 plays module music files.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help
.TP
\fB\-\-help\-keyboard\fR
Show keyboard hotkeys in ui mode
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress non\-error screen output
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show more screen output
.TP
\fB\-\-version\fR
Show version information and exit
.TP
\fB\-\-short\-version\fR
Show version number and nothing else
.TP
\fB\-\-long\-version\fR
Show long version information and exit
.TP
\fB\-\-credits\fR
Show elaborate contributors list
.TP
\fB\-\-license\fR
Show license
.TP
\fB\-\-probe\fR
Probe each file whether it is a supported file format
.TP
\fB\-\-info\fR
Display information about each file
.TP
\fB\-\-ui\fR
Interactively play each file
.TP
\fB\-\-batch\fR
Play each file
.TP
\fB\-\-render\fR
Render each file to individual PCM data files
.TP
\fB\-\-banner\fR n
openmpt123 banner style [0=hide,1=show,2=verbose] [default: 1]
.TP
\fB\-\-assume\-terminal\fR
Skip checking whether stdin/stderr are a terminal, and always allow UI [default: 0]
.TP
\fB\-\-terminal\-width\fR n
Assume terminal is n characters wide [default: 72]
.TP
\fB\-\-terminal\-height\fR n
Assume terminal is n characters high [default: 23]
.TP
\fB\-\-[no\-]progress\fR
Show playback progress [default: 1]
.TP
\fB\-\-[no\-]meters\fR
Show peak meters [default: 1]
.TP
\fB\-\-[no\-]channel\-meters\fR
Show channel peak meters (EXPERIMENTAL) [default: 0]
.TP
\fB\-\-[no\-]pattern\fR
Show pattern (EXPERIMENTAL) [default: 0]
.TP
\fB\-\-[no\-]details\fR
Show song details [default: 1]
.TP
\fB\-\-[no\-]message\fR
Show song message [default: 0]
.TP
\fB\-\-update\fR n
Set output update interval to n ms [default: \fB\-1]\fR
.TP
\fB\-\-samplerate\fR n
Set samplerate to n Hz [default: 48000]
.TP
\fB\-\-channels\fR n
use n [1,2,4] output channels [default: 2]
.TP
\fB\-\-[no\-]float\fR
Output 32bit floating point instead of 16bit integer [default: 1]
.TP
\fB\-\-gain\fR n
Set output gain to n dB [default: 0]
.TP
\fB\-\-stereo\fR n
Set stereo separation to n % [default: 100]
.TP
\fB\-\-filter\fR n
Set interpolation filter taps to n [1,2,4,8] [default: 8]
.TP
\fB\-\-ramping\fR n
Set volume ramping strength n [0..5] [default: \fB\-1]\fR
.TP
\fB\-\-tempo\fR f
Set tempo factor f [default: 1]
.TP
\fB\-\-pitch\fR f
Set pitch factor f [default: 1]
.TP
\fB\-\-dither\fR n
Dither type to use (if applicable for selected output format): [0=off,1=auto,2=0.5bit,3=1bit] [default: 1]
.TP
\fB\-\-playlist\fR file
Load playlist from file
.TP
\fB\-\-[no\-]randomize\fR
Randomize playlist [default: 0]
.TP
\fB\-\-[no\-]shuffle\fR
Shuffle through playlist [default: 0]
.TP
\fB\-\-[no\-]restart\fR
Restart playlist when finished [default: 0]
.TP
\fB\-\-subsong\fR n
Select subsong n (\fB\-1\fR means play all subsongs consecutively) [default: \fB\-1]\fR
.TP
\fB\-\-repeat\fR n
Repeat song n times (\fB\-1\fR means forever) [default: 0]
.TP
\fB\-\-seek\fR n
Seek to n seconds on start [default: 0]
.TP
\fB\-\-end\-time\fR n
Play until position is n seconds (0 means until the end) [default: 0]
.TP
\fB\-\-ctl\fR c=v
Set libopenmpt ctl c to value v
.TP
\fB\-\-driver\fR n
Set output driver [default: default],
.TP
\fB\-\-device\fR n
Set output device [default: default],
use \fB\-\-device\fR help to show available devices
.TP
\fB\-\-buffer\fR n
Set output buffer size to n ms [default: \fB\-1]\fR
.TP
\fB\-\-period\fR n
Set output period size to n ms [default: \fB\-1]\fR
.TP
\fB\-\-stdout\fR
Write raw audio data to stdout [default: 0]
.TP
\fB\-\-output\-type\fR t
Use output format t when writing to a individual PCM files (only applies to \fB\-\-render\fR mode) [default: auto]
.TP
\fB\-o\fR, \fB\-\-output\fR f
Write PCM output to file f instead of streaming to audio device (only applies to \fB\-\-ui\fR and \fB\-\-batch\fR modes) [default: ]
.TP
\fB\-\-force\fR
Force overwriting of output file [default: 0]
.TP
\fB\-\-\fR
Interpret further arguments as filenames
.PP
Keyboard hotkeys (use 'openmpt123 \fB\-\-ui\fR'):
.TP
[q]
quit
.TP
[ ]
pause / unpause
.TP
[N]
skip 10 files backward
.TP
[n]
prev file
.TP
[m]
next file
.TP
[M]
skip 10 files forward
.TP
[h]
seek 10 seconds backward
.TP
[j]
seek 1 seconds backward
.TP
[k]
seek 1 seconds forward
.TP
[l]
seek 10 seconds forward
.TP
[u]|[i]
+/\- tempo
.TP
[o]|[p]
+/\- pitch
.TP
[3]|[4]
+/\- gain
.TP
[5]|[6]
+/\- stereo separation
.TP
[7]|[8]
+/\- filter taps
.TP
[9]|[0]
+/\- volume ramping
.SH COPYRIGHT
Copyright \(co 2013\-2024 OpenMPT Project Developers and Contributors <https://lib.openmpt.org/>