Skip to content

Command Line Options

Jonathan edited this page Sep 30, 2020 · 111 revisions

( en | es )

Home > Configuring Jamulus

While the most common functions in Jamulus can be set using the GUI, Jamulus can also be controlled using these options on the command line. Exactly how you do this will depend on your operating system.

For example, on Windows to enable recording with the -R option: right-click on the Jamulus shortcut and choose "Properties" > Target. Add the necessary arguments to Jamulus.exe:

"C:\Program Files (x86)\Jamulus\Jamulus.exe" -s -R "C:\path\to\your\Jam Recordings"

For Macintosh, start a Terminal window and run Jamulus with the desired options like this:

/Applications/Jamulus.app/Contents/MacOS/Jamulus -s -R "/path/to/your/jam recordings"


You can see all possible options your version supports by starting Jamulus with the -h option.

Short Long name [...] means optional parameter
-a --servername Server name, required for HTML status (do not confuse with "[name]" in -o) (server only)
-c --connect Connect to given server address on startup, format address[:port] (client only)
-d --discononquit Disconnect all clients on quit (server only)
-e --centralserver Makes the server public. (server only) See note.
-f --listfilter Whitelist given IPs to register on serverlist of this server. (central server only) See note.
-F --fastupdate Use 64 samples frame size mode. Requires fast CPU to avoid dropouts, and more bandwidth if clients also connect with "Enable Small Network Buffers" option. (server only)
-g --pingservers Ping servers in list to keep NAT port open (central server only) (And see this note for why)
-h,-? --help This help text (client and server)
-i --inifile Initialization file name (client (always) and server (with GUI))
-j --nojackconnect Disable auto Jack connections (client only)
-l --log Enable logging, set file name (server only)
-L --licence Show a CC license to be accepted on a new connection (server only)
-m --htmlstatus Enable HTML status file, set file name (server only)
-M --mutestream Starts Jamulus in muted state (client only)
-n --nogui Disable GUI (client and server)
-o --serverinfo Server location details in the format (see also QLocale):
[name];[city];[[country as QLocale ID]]; ...
[server1 address];[server1 name];[server1 city];[server1 country as QLocale ID]; ...
[server2 address]; ...
(first for any server; additional for central server only - see note.)
-p --port Local UDP port number. Default is 22124 (server only)
-R --recording Include a writable path where the files should be stored (in quotes if appropriate). (server only) See description in Server Setup.
--norecord Start recorder with recording disabled (3.5.11+) (server only)
-s --server Start in server mode (server only) See note
-t --notranslation Disable translations (client and server)
-T --multithreading Enable multithreading (server only)
-u --numchannels Maximum number of channels. Default is 10, maximum is 50 (server only)
-w --welcomemessage Welcome message on connect. Supports HTML and (inline) CSS formatting. It also accepts an external text file for more complex messages: eg: ./Jamulus -s -n -w /path/to/jamulusWelcome.txt (server only)
-z --startminimized Start minimized (server only)
--ctrlmidich MIDI controller channel to listen on (client only) see Tips & Tricks
--clientname Window title and jack client name (client only)