User Guide

From VuzeWiki
Jump to: navigation, search
User Guide

Edit UG toc
view this alone

Welcome to the Vuze User Guide! It provides documentation and explanations about Vuze's functionality to help users find their way through the jungle. The guide is based on Azureus Vuze v3.0.3.4, but is updated to some extent to correspond to changes done in later Azureus/Vuze versions. Current version: Vuze 5.5.0.0

If you discover wrong and/or incomplete information you are very welcome to contribute.


Getting started

Vuze, originally known as Azureus, is a BitTorrent client written in Java, which makes it rather platform independent. The Eclipse SWT toolkit is used for providing the user interface functionality.

The BitTorrent protocol is a way of exchanging or distributing data over the internet. Users do not download from a central server, instead they download from other users. Downloading also means uploading, and the amounts of each are linked, to ensure fairness and rapidity in the spread of the file at hand.

For information on how to set up Vuze, see the Initial_Setup_Guide

To be able to download a file, you first need to get the associated .torrent file. This file, usually a dozen KB in size, is the "signature" of the much bigger file to be downloaded, and it needs special client software to be read properly. Vuze is one of those types of software.

If you want to host files yourself, you need a tracker, which is basically a central server coordinating the connections between peers. Vuze can provide a tracker too. (In general, most users never use their own tracker, as most torrents are tracked by a few major trackers.)

You will find, as you discover its functionality, that it is easy to customize your copy of Vuze to exactly fit your needs. This guide is targeting the Windows and Macintosh versions, although Vuze also supports other platforms.

Views

Since version 3.0.3.4 the Vuze GUI has replaced the traditional Azureus application interface.

The Vuze interface in the 4.7 version:

Vuze47VuzeMainScreen640.png

The sidebar acts as the main menu showing the active pages. The active torrents are displayed through Library (and its subsets New and Downloading). Vuze HD Network offers a browseable limited directory of available torrents, and you can also search the open internet for new torrents. There are also separate sections for Devices, Subscriptions and for each active plugin.

The upper panel shows the downloading torrents, and the bottom panel the completed seeding torrents. New users are initially shown the "Simple view", which shows only a limited amount of information per torrent. You can change that to "Advanced view", which enables you to see more information. Contents of the most table views can be modified through Column setup dialog.

There is also a filter bar, which can be used to filter the shown torrent by typing the wished part of the torrent name(s).

The MyTorrents view can be seen as the main view of the traditional "classic" Azureus interface, to which you can change through Vuze's options. MyTorrents in the 4.5 version:

Vuze45classicMyTorrents640.png

Menu

The following menus are available to you to control the activity of the Vuze client application.

  • Azureus Menu (on Mac only) gives you direct access to control and setup options for Vuze.
  • File Menu gives you access to options to add or share torrents as well as import and export XML torrents.
  • Transfers Menu allows you to start, stop and pause all transfers.
  • Torrent Menu gives you options for currently downloading or seeding torrents. (Available only in the classic user interface.)
  • View Menu adds extra view tabs into the main display and switch back to Vuze views.
  • Tools Menu gives you access to the options and some useful tools.
  • Plugins Menu lists and manages all Vuze plugins.
  • Help Menu gives info that may help run or use Vuze including find plugins.

Advanced Information

There are a lot of very informative displays in Vuze so that you can tell what is going on with a particular torrent. These sub-displays become available if you double click on the torrent name itself in "Library" or "My Torrents" on the main display. This will add a new view to the main display named the same as the torrent you double clicked and if you select that page you will see the following sub-tabs:

  • General gives you information on the availability of torrent pieces and whether or not you have already got them as well as other high level performance information.
  • Sources tab gives you information about the sources of active peers in that torrent.
  • Peers lists the other client apps to whom you are linking and indicates some of the characteristics of those peers.
  • Swarm shows a very pretty graphical display of the peers with whom you are exchanging information.
  • Pieces shows the pieces you are downloading and who and how fast that is happening.
  • Files shows the status of the files inside the selected torrent.
  • Info shows the information from the my torrents tab.
  • Options shows the per-torrent options.
  • Console shows the per-torrent logging information.

Statistics

The statistics view can be opened via the Tools Menu. It allows an in depth look for activities of the client as a whole. The information is displayed in five sub-tabs within the Statistics tab. These are:

  • Activity tab shows recent info about the internet connection workload graphically
  • Transfers tab shows summary info on the internet connection workload
  • Cache tab shows information about the local cache usage
  • Distributed Database tab shows information on the DDB activity.
  • Vivaldi tab shows information on the 'distance' of peers from your client

Options

Given the information displayed in the many displays you may then decide you want to affect client performance and activity using the controls on the options view. This is the same tab as is opened by the Preferences selection under the Azureus menu item.

  • Mode sets the complexity of your interface to Vuze. In initial 'Beginner' mode you only see part of available options and commands
  • Startup & shutdown controls the tasks performed at Vuze startup and shutdown
  • Connection controls the internet connection from technical perspective
  • Transfer controls the use of the internet connection from practical bittorrent perspective
  • Files controls the downloaded file details
  • Interface controls the main display setup
  • IP Filters controls which internet addresses are allowed to talk to your Vuze client
  • Plugins gives access to the controls of the plugins
  • Statistics enables logging of statistics
  • Tracker controls the built-in tracker capability
  • Security controls security on plugin .jar files
  • Classic-Sharing controls the behaviour of the classic-sharing functionality
  • Logging enables and controls logging of diagnostic information
  • Queue controls the rules of the queues for data exchange
  • Devices controls the device and transcoding related options
  • Subscriptions controls the settings for torrent subscriptions

Embedded Tracker

Azureus includes a tracker, and the "My Tracker" View, accessible through the View Menu will show both the torrents you publish and those you host.

  • Publish allows you to publish a torrent.
  • Host allows you to host a tracker of torrents.

Plugins

(needs to be updated, currently for v2.4.0.2)

Plugins add functionality to Vuze. This section covers the functionalities of some of the well known plugins and especially those that come as standard as part of the installation. These plugins are covered in this section:

  • Distributed DB is an implementation of decentralized information about torrents
  • Distributed Tracker is a distributed tracker implemented using the Distributed DB
  • UPnP controls port forwarding at your firewall
  • Other Plugins list all other documented plugins