User Manual
FAQ
Contact
Introduction
Installation
Configuration
Scripts
Advanced Topics
Extensions for SABnzbd
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. | ||
-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 |
-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") |
-l |
--logging <-1..2>
|
-1 = Disable all logging0 = Only show errors and warnings1 = Also show info messages2 = Also show debug messages (use only when analyzing problems)
|
-w |
--weblogging
|
Logging of the webserver framework on (use only when analyzing problems) |
-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).
|
-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.
|
--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] | |
-h |
--help
|
Show short explanation of the commandline options and exit program (won't work with Win32 binary) |
-v |
--version
|
Show SABnzbd's version and exit program (won't work with Win32 binary) |
-c |
--clean
|
Clear the cache and log directories. All queued downloads will be removed. The download_dir is not
cleared.
|
-p |
--pause
|
Start in paused mode |
--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. | |
--https <port>
|
Set the HTTPS port number and enable HTTPS for the user interface | |
--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.
|
|
--inet_exposure <0..5>
|
Set the External internet access. See General - External internet access section for supported levels, starting at 0 for No access (the default).
|
|
--no-login
|
Start SABnzbd and reset username and password. | |
--log-all
|
Log all article handling and enable other excessive logging (for developers). | |
--disable-file-log
|
Logging is only written to console, useful if stdout is redirected to another logging system.
|
|
--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.
|
|
--console
|
Force console logging. |
