# Getting started with Torrent Search

## Installation

The way to install &app; on your system depends on your operating system :

On Debian/Ubuntu

- Download the debian package (.deb) and double-click on the downloaded file : the package manager will be launched and installation will start once you click on Install this package.

  You can also use the command line : `gdebi `/path/to/file``.

Other Linux distributions

- Download the source tarball (.tar.gz) and extract it. Then, from the command line, run the following commands :

  `cd `/path/to/extracted/files``

  `python `setup.py` install`

## Launching the application

### Quick start

You can start &app; in the following ways:

Applications menu

- Choose Internet Torrent Search

Command line

- Type `torrent-search`, then press Return.

### Command line arguments

Here is a description of the arguments that can be used when launching &app; from the command line.

#### Basic options

-h, --help

- Show help message and exit

-v, --version

- Show version number and exit

-s, --search

- Run a search on startup

--no-plugins-check

- Do not check for plugins updates

#### Advanced options

These options should be used by developers only.

--share-dir

- Set path to the `share` folder

--add-plugin

- Load a plugin from a specific path

## The main window

### Torrent Search window

### Main menu

#### File menu

Quit

- Quit the application

#### Edit menu

Preferences

- Show the preferences dialog

#### Help menu

Help

- Show this documentation, focusing of the section correponding to the active widget, if possible

About

- Show the "About" dialog

### Searchbar

To start searching for torrents, simply enter your search query in the searchbar entry, then press Return or click on Find. Your search results will appear in the results list in the Search results box.

### Search options

To modify search options, click on the Search options expander under the searchbar. You will see the following box appear:

#### Search options box

You can set some filters to view only the results you are interested in. You don't have to rerun the search when you modify options, as the filters are applied immediatly.

Some plugins might not handle the Filter duplicates filter.

### Results list

When you run a search, the torrents matching your criterias will appear in the results list. The number of results indicated in the Search results box title is the total number of results : if you selected some filters in the Search options, the number of results displayed will not be the same as the one in the title.

To download a torrent file, double-click on the line of the corresponding result or right-click on the line and select Download from the menu. The download progress will appear in the Downloads sidebar.

### Downloads sidebar

The Downloads sidebar will show the progress for the different downloads you requested. Once a download is completed, the line is removed from the list.

Active downloads appear with a green background, failed ones with a red background.

While a download is in Waiting state, you can cancel it by selecting Cancel in the menu accessible by a right-click. Once it has started, a download can no longer be canceled.

When a file fails to download, you can choose to retry or cancel the download by right-clicking on the line.