Skip to content

Command line arguments

Jump to bottom Edit New page
Samuel edited this page Jun 14, 2017 · 9 revisions

UMS can be launched with command line arguments. These arguments can either be used from the command line directly, be used from scripts or be used from shortcuts. The Universal Media Server (Select Profile) shortcut made by the Universal Media Server Windows installer is an example of this (launched with the profiles argument). UMS will be used as an abbreviation for Universal Media Server in the rest of this document.

Arguments

  • headless - This starts UMS without a GUI. It can be useful for running UMS in the background without any user interface, but be aware that under Windows there is no other way than using the task manager to stop UMS again. This option in most useful under Linux, where you can stop UMS again simply by pressing Ctrl + c. If no graphical environment is available, UMS will automatically start in this mode.
  • console - This is identical to headless.
  • noconsole - This will refuse UMS to start in headless/console mode if it cannot initialize the GUI.
  • nativelook - This only works under Linux and attempts to use the graphical environment's native look.
  • scrollbars - This creates horizontal and vertical scroll bars in UMS' main windows, allowing the window to be smaller than UMS is designed for. It can be useful on low resolution desktops.
  • profiles - This will launch the Profile Chooser during UMS startup, allowing you to choose a profile file or folder for UMS to use.
  • profile=<path> or profile:<path> - This will start UMS with the profile from the file or folder specified in . This is mostly useful for starting a specific profile from a script or shortcut.
  • trace - This will start UMS in "forced trace" mode, where the log level is forced to level regardless of the log level specified in the profile. It's not possible to change log level in this mode.

Windows

To be able to use the command line arguments on Windows, follow this syntax:

UMS.exe <argument 1> <argument 2> <...argument X>

Mac OS X

To be able to use the command line arguments on OS X, from the Terminal, follow this syntax:

open -a "Universal Media Server" --args <argument1> <argument2> <...>

Linux

To be able to use the command line arguments on Linux, follow this syntax:

./UMS.sh <argument 1> <argument 2> <...argument X>
Add a custom footer
Add a custom sidebar
Clone this wiki locally