SABnzbd

Wiki

Incorrect or missing information? Command Line Parameters

You can start SABnzbd with options. You normally do this from a command prompt (Windows) or a shell (Unix).
An option is a combination of the option name and one parameter. For parameters that contain spaces, you must surround the parameter with double quotes (e.g. --config-file "/my very long path/SABnzbd.ini").

Short Long command Description
-f --config-file <path-to-ini> The name of the configuration file.
If you specify an INI file, all relative folders in Config->Folders will be relative to the location of the INI file. If you do not specify an INI file, SABnzbd will first check the Default Locations.
-p --pause Start in paused mode
-t --templates <template> Select another set of user interface templates. Use a name of a set in the interfaces folder.
The name of a standard interface ("Glitter", "Plush" or "smpl")
-2 --template2 <template> Select the secondary user interface templates. Use a name of a set in the interfaces folder.
-c --clean Clear the cache and log directories. All queued downloads will be removed. The download_dir is not cleared.
-s --server <host:port>

Specify IP address and port that SABnzbd should listen on. Value will be stored in the INI file.

See General - Host and Port section for supported notations

--force Will wait forever to bind to the specified host:port in the INI or from command line.
-h --help Show short explanation of the commandline options and exit program (won't work with Win32 binary)
--repair Add orphaned jobs from the incomplete folder to the queue. Can also be performed from the GUI.
--repair-all Try to reconstruct the queue from the incomplete folder with full data reconstruction. Can also be performed from the GUI.
--permissions <level> Specify file permissions (Unix only). See Unix Permissions.
-b --browser <0|1> 0 = Do not show the browser (recommended for servers).
1 = SABnzbd will start the system's default browser, showing the GUI of SABnznd (default).
-l --logging <0..2> 0 = Only show errors and warnings
1 = Also show info messages
2 = Also show debug messages (use only when analyzing problems)
-w --weblogging <0..2>

Logging of the webserver framework:

0 = Logging off
1 = Logging on (use only when analyzing problems)
2 = Logging on, only to log file (use only when analyzing problems)

-v --version Show SABnzbd's version and exit program (won't work with Win32 binary)
-d --daemon Start in daemon mode. Run without a terminal window and do not start the browser. Do NOT assume that the user profile can be used. You must use the -f <path-to-ini> option.
--https <port> Set the HTTPS port number and enable HTTPS for the user interface
--new Normally SABnzbd checks if an instance of SABnzbd is already running. If so and the versions match, the second instance will just activate the web interface of the first instance or send an NZB to the first instance. If you really want to run multiple instances, you will need to use the --new parameter.
--ipv6_hosting <0|1> Use 0 when your system cannot handle ::1 (the IPv6 value of localhost). The setting will be stored in the sabnzbd.ini file.
--pid <path-file> Create a file with the PID (process number) of the SABnznbd process. The file will exists as long as the instance of SABnzbd lives (unless it crashes). A full directory path is required. The file name will be sabnzbd_port.pid where port is the port number used for the web server. [Only Unix/macOS]
--pidfile <path-file> Use this to set a file (full path required) where SABnzbd can store its PID. The content of the file will be the process number (PID). [Only Unix/macOS]
--console Force console logging for macOS app.