Commandline options

From VuzeWiki
Jump to: navigation, search

Azureus Command Line Options[edit]

The general syntax is:

Windows: Azureus.exe [-J<VM argument>] [-J<VM argument>] [azureus argument] [azureus argument]
*nix: ./azureus [azureus argument] [azureus argument]

To provide VM arguments under *nix see #Options passed to the Virtual Machine

Options directly passed to Azureus[edit]

The most important command line option is the option to provide a torrent location which could be a Magnet link, an URL that points to a .torrent file or a path/filename. Those parameters can be attached to the launcher scripts/applications (depending on your OS)

Example (Windows): Azureus.exe "http://example.com/test.torrent"
Example (*nix): ./azureus "/path/to/the.torrent"
Example (*nix): ./azureus "magnet:?xt=urn:btih:IJBDPDSBT4QZLBIJ6NX7LITSZHZQ7F5I"


You can also shutdown a running Azureus instance via the command line parameter --closedown or restart via --restart:
Example (Windows): Azureus.exe --closedown

On Unix, if you're using Java 1.5, you can send a SIGHUP to your Azureus instance to shut it down. It will only work on some java implementations. If you're running Azureus as a non-root user (as you should), and you are not running any other Java applications, you can use this command to shut down Azureus: killall -SIGHUP java

Options passed to the Virtual Machine[edit]

Besides the direct arguments above, Azureus provides additional configuration options via the standard -D<xxx> java mechanism.

Since azureus 2306 windows users can pass these arguments to Azureus.exe like regular arguments by prefixing them with -J
Example (Windows, for Azureus 2306 and later): Azureus.exe -J-Dazureus.skipSWTcheck=1


Users of earlier versions or on linux/unix must invoke Azureus manually or modify the startup script, see windows how-to and linux how-to

Example (windows): java -cp swt.jar;Azureus2.jar -Dazureus.skipSWTcheck=1 org.gudy.azureus2.ui.swt.Main
Example (*nix): java -cp swt.jar:Azureus2.jar -Djava.library.path=./ -Dazureus.skipSWTcheck=1 org.gudy.azureus2.ui.swt.Main
Example (macintosh): Open /Applications/Vuse.app/Contents/Info.plist and change the Java/VMOptions Value (I.e.: -Xmx256m)

VM Options file (windows only)[edit]

-J options specified on the command line won't be preserved over an Azureus restart. To ensure they are place them into a file called Azureus.exe.vmoptions in the same directory as the Azureus.exe. In this case simply place each command on a separate line in the file, without the -J. For example

Azureus.exe.vmoptions

   -Dazureus.lazy.bitfield=1
   -Xmx192m

Startup Options[edit]

  • -Dazureus.instance.port=<port number> This sets the port (default is 6880) that Vuze uses to communicate with other instances of itself (e.g. when adding a torrent by clicking on a url/magnet in a web browser)

Network Options[edit]

  • -Dazureus.lazy.bitfield=1 Always send a faked incomplete bitfield, and instead send remaining completed piece info via Have messages. Certain ISP (ie Cablevision's Optimum Online) networks seem to block peer seeding via "complete" bitfield message filtering. You should only use this option if you need to.

Path Options[edit]

  • -Dazureus.config.path= Sets the Configuration directory Azureus uses for config files and plugins. Default config path is OS-dependant: Under unix, this usually is ~/.azureus/; under Windows, this usually is %appdata%\Azureus\; Under Mac OS X, this usually is "/Users/<username>/Library/Application Support/Azureus/".
    • combine with -DMULTI_INSTANCE=true to open multiple instances of Azureus.
    Note: opening multiple instances of Azureus is generally a very bad idea, except in very special circumstances.
    The multi-instance flag can be used to disable the instance-checking if some other application is listening on port 6880 and prevents Azureus from starting.
  • -Dazureus.install.path= sets the install path for Azureus, this is useful if you want to override where Azureus places its shared plugins.
    Note: this settings should be used with care as it can break the auto update feature

GUI Options[edit]

  • -Dazureus.skipSWTcheck=1 Skip the SWT version check at startup. This is useful for an OS that do not have the latest SWT binaries available.

Log Options[edit]

  • -Dazureus.overridelog=1 Override logging setting, and enable logging, file logging, and all options. Log directory will be the current directory.
  • -Dazureus.overridelogdir=<dirpath> New as of version 3.1.1.1 - if above option is enabled, this parameter will specify where to store the log files (instead of the current directory).
  • -Dazureus.log.stdout=1 Send all log output to standard out / console / terminal.
  • -Dlog.unknown.peerids=1 Log all unknown Peer IDs to a file called identification.log in the config path. As of version 3.1.1.1, this will now be stored in the log directory, stored in files named clientid_x.log and is enabled by default (you can set the value to 0 to disable it).
  • -Dazureus.log.dos=1 Log DOS info from Azureus' Tracker to dos.log in the user directory.
  • -Ddiag.logsize=2M Change the maximum size of the debugging log files from the default 256 kB, e.g. to 2 MB.
  • -Ddebug.swtexec=1 Creates also swt_x.log debug files enabling a better debugging of UI events.

Memory Limits[edit]

  • -Xmx<nnn>m Sets the maximum heap size to <nnn> MiB (might be necessary when OutOfMemory errors occur)
  • -XX:MaxDirectMemorySize=<nnn>m Sets the maximum direct memory size to <nnn> MiB (Azureus will notify you when this should become necessary)
  • see Reduce memory usage for further details

"Safe Mode" Options[edit]

  • -Dazureus.safemode=1 Loads Azureus in safe mode - this disables the loading of external plugins, loading of downloads, and disables other features - this should only be used to change your configuration or to generate a debug log when you can't load Azureus normally. Available from version 3.1.1.1 onwards.
  • -Dazureus.disabledownloads=1 Avoid loading the downloads in Azureus - any newly added downloads will not be remembered when the program is closed. Available from version 3.1.1.1 onwards.
  • -Dazureus.loadplugins=0 Skips loading of all plugins - you can go to the Options -> Plugins page, and click the Scan for plugins button to then list all the plugins that are available. Available from version 3.1.1.1 onwards.

Console UI Options[edit]

  • -Dazureus.console.noisy=on New in 3.1.1.1. In older versions for Azureus, any debug statements and errors from Azureus or any plugins were displayed in the console. In 3.1.1.1 and above, this is now prevented, and is only displayed if this option is used.

Manually starting directly with Java[edit]

Windows[edit]

Here's an example command line to start Vuze on a Windows 7 system running Java 1.6 (or 6 as it is also known)

Open a Command Prompt (DOS Box as it used to be known) - Open the start menu and type 'cmd' into the search box

cd "c:\Program Files (x86)\Vuze"

"c:\Program Files (x86)\Java\jre6\bin\java" -classpath Azureus2.jar;swt.jar org.gudy.azureus2.ui.swt.Main