Jamulus Icon. Links to homepage
Open navigation

Command Line Options

Shared commands

  • -h or --help Display help text
  • -i or --inifile Set location of initialization file (overrides default)
  • -n or --nogui Disable GUI (for use in headless mode)
  • -p or --port Sets the local UDP port number. Default is 22124
  • --jsonrpcport Enables JSON-RPC API server to control the app, set TCP port number (EXPERIMENTAL, APIs might change; only accessible from localhost). Please see the JSON-RPC API Documentation file.
  • --jsonrpcsecretfile Required when using --jsonrpcport. Sets a path to a text file containing an authentication string for getting access to the JSON-RPC API.
  • -Q or --qos Sets the quality of service DS Field byte. Default is 128 (DSCP/CS4). QoS is ignored by Windows. To enable it, see this page
  • -t or --notranslation Disable UI language translations
  • -6 or --enableipv6 Enable IPv6 addressing (IPv4 is always enabled)
  • -v or --version Output version information and exit

Client only commands

  • -M or --mutestream Prevent others on a server from hearing what I play
  • --mutemyown Prevent me from hearing what I play in the server mix (headless only)
  • -c or --connect Connect to given server address on startup, format address[:port]
  • -j or --nojackconnect Disable auto JACK connections
  • --ctrlmidich MIDI controller channel to listen on, control number offset and consecutive CC numbers (channels) and Mute Myself CC number. Format: channel[;f*][;p*][;s*][;m*][;o] See Tips & Tricks
  • --clientname Window title and JACK client name

Server only commands

  • -d or --discononquit Disconnect all Clients on quit. Normally, when a Server is stopped or restarted, any Clients that have not used their “Disconnect” buttons will re-establish connection when the Server comes back up again. Using this option forces Clients to manually re-establish their connections to the Server.
  • -e or --directoryserver Register the Server on a Directory (e.g. to set its genre (see also -o)). See Server Types for further information.
  • --directoryfile Remember registered Servers even if the Directory is restarted. Directory Servers only. See this guide for further information.
  • -f or --listfilter Whitelist Servers registering on the Server list, format ip address 1[;ip address 2] Directories only.
  • -F or --fastupdate Reduces latency if Clients connect with “Enable Small Network Buffers” option. Requires faster CPU to avoid dropouts, and more bandwidth to enabled Clients.
  • -l or --log Enable logging, set path and file name
  • -L or --licence Show an agreement window before users can connect
  • -m or --htmlstatus Enable HTML status file, set path and file name
  • -o or --serverinfo Location details in the format: [name];[city];[country as two-letter ISO country code or Qt5 Locale] (see two-letter ISO country codes or Qt5 Locale values) Registered Servers only
  • -P or --delaypan Start with delay panning enabled See notes
  • -R or --recording Set server recording directory; Server will record when a session is active by default. See Options.
  • --norecord Set server not to record by default (when recording is configured e.g via -R)
  • -s or --server Start in Server mode
  • --serverbindip Specify the IP address to bind to
  • -T or --multithreading Use multithreading to make better use of multi-core CPUs to support more Clients
  • -u or --numchannels Maximum number of channels (Clients)
  • -w or --welcomemessage Welcome message on connect. Can be given as a string or filename, and can contain HTML.
  • -z or --startminimized Start minimized
  • --serverpublicip The public IP address of the Server if connecting to a Directory behind the same NAT. See Notes on Directories