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").

-f --config-file 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 if the file sabnzbd.ini is in the program directory and after that on the following "standard" location:
Unix ~/.sabnzbd/sabnzbd.ini
Windows XP/S2003 %userprofile%\Local Settings\Application Data\sabnzbd\sabnzbd.ini
Vista/S2008/Win7 %userprofile%\AppData\Local\sabnzbd\sabnzbd.ini
-p --pause Start in paused mode
-t --templates Select another set of user interface templates. Use a name of a set in the interfaces folder.
The name of a standard interface ("Classic", "Plush", "smpl" or "Mobile")
-2 Select the secondary user interface templates. Use a name of a set in the interfaces folder.
The name of a standard interface ("Classic", "Plush", "smpl" or "Mobile")
-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.
host The name or IP of this computer
port The port number that the web interface uses. Value between 80 and 65000. Pick a free one. Typical values: 80, 8080, 8088, 9000 etc. You'll get an error message when the port is not free.
Supported notations
:port Use the host address of this system. Web interface will be available to other computers on the LAN
localhost:port Use the special internal address of this computer. Web interface is only available on this computer
0.0.0.0:port Use the host address and the internal address on this computer. Only needed in special cases.
address:port You can also set a specific host name or numerical IP. Useful when a system has multiple network connections.
-h --help Show short explanation of the commandline options and exit program (won't work with Win32 binary)
--permissions Specify file permissions (Unix only). See explanation
-b --browser 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 = Only show errors and warnings
1 = Also show info messages
2 = Also show debug messages (use only when analyzing problems)
-w --weblogging Logging of the webserver framework
0 = Logging off
1 = Logging on (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 Startup and run in without a terminal window and do not start the browser. Do NOT assume that the user profile can be used. You must either use the -f <file> option or have the INI file in the program directory.
--https port Set the HTTPS port number and enable HTTPS for the user interface
--pid path 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/OSX and 0.6.1+
--pidfile file-path 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/OSX and 0.7.17+
--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. (0.6.3+)
--no_ipv6 Use this when your system cannot handle ::1 (the IPv6 value of "localhost"). The setting will be stored in the sabnzbd.ini file (0.7.1+)
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License