mirror of
https://github.com/rakshasa/rtorrent.git
synced 2026-08-06 18:22:32 +00:00
rakshasa
082cbb6cc5
* Delayed the hash done signal. * Allow quick hash checks that only handles invalid chunks. * Show failed counter for peers. * Updated the man page. git-svn-id: svn://rakshasa.no/libtorrent/trunk/rtorrent@737 e378c898-3ddf-0310-93e7-cc216c733640
934 lines
23 KiB
XML
934 lines
23 KiB
XML
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
|
|
|
|
<refentry id="rtorrent">
|
|
|
|
|
|
<refmeta>
|
|
<refentrytitle>rtorrent</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="date">June 25th, 2005</refmiscinfo>
|
|
<refmiscinfo class="source"></refmiscinfo>
|
|
<refmiscinfo class="title">BitTorrent client for ncurses</refmiscinfo>
|
|
</refmeta>
|
|
|
|
|
|
<refnamediv>
|
|
<refname>rtorrent</refname>
|
|
<refpurpose>a BitTorrent client for ncurses</refpurpose>
|
|
</refnamediv>
|
|
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>rtorrent</command>
|
|
<arg choice="opt">-h</arg>
|
|
<arg choice="opt">-n</arg>
|
|
<arg choice="opt">-o key1=opt1,...</arg>
|
|
<arg choice="opt">-O key=opt</arg>
|
|
<arg choice="opt" rep="repeat">URL | FILE</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
|
|
<para>
|
|
<command>rtorrent</command> is a BitTorrent client for ncurses,
|
|
using the <emphasis>libtorrent</emphasis> library. The client
|
|
and library is written in C++ with emphasis on speed and
|
|
efficiency, while delivering equivalent features to those found
|
|
in GUI based clients in an ncurses client.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>KEYBOARD CONTROL</title>
|
|
<para>
|
|
</para>
|
|
|
|
<refsect2>
|
|
<title>Global Keys</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>^q</term>
|
|
<listitem><para>
|
|
Initiate shutdown, press again to force the shutdown and
|
|
skip sending the stop signal to trackers.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>up | down</term>
|
|
<listitem><para>
|
|
Select item.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><-</term>
|
|
<listitem><para>
|
|
Go back to the previous screen.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>a | s | d</term>
|
|
<listitem><para>
|
|
Increase the upload throttle by 1/5/50 KB.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>A | S | D</term>
|
|
<listitem><para>
|
|
Increase the download throttle by 1/5/50 KB.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>z | x | c</term>
|
|
<listitem><para>
|
|
Decrease the upload throttle by 1/5/50 KB.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>Z | X | C</term>
|
|
<listitem><para>
|
|
Decrease the download throttle by 1/5/50 KB.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect2>
|
|
|
|
<refsect2>
|
|
<title>Main View Keys</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>-></term>
|
|
<listitem><para>
|
|
View download.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>1 - 7</term>
|
|
<listitem><para>
|
|
|
|
Change view.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^S</term>
|
|
<listitem><para>
|
|
Start download.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^D</term>
|
|
<listitem><para>
|
|
|
|
Stop an active download, or remove a stopped download.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^K</term>
|
|
<listitem><para>
|
|
|
|
Close a torrent and its files.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^R</term>
|
|
<listitem><para>
|
|
Initiate hash check of torrent.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^O</term>
|
|
<listitem><para>
|
|
Change the destination directory of the download. The
|
|
torrent must be closed.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>+ | -</term>
|
|
<listitem><para>
|
|
Change the priority of the download.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>backspace</term>
|
|
<listitem><para>
|
|
Add torrent using an URL or file path. Use
|
|
<emphasis>tab</emphasis> to view directory content and do
|
|
auto-complete.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>l</term>
|
|
<listitem><para>
|
|
View log. Exit by pressing the space-bar.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>^P</term>
|
|
<listitem><para>
|
|
Call commands or change settings.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>U</term>
|
|
<listitem><para>
|
|
|
|
Delete the file the torrent is tied to, and clear the association.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>I</term>
|
|
<listitem><para>
|
|
|
|
Toggle whether torrent ignores ratio settings.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect2>
|
|
|
|
<refsect2>
|
|
<title>Download View Keys</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>-></term>
|
|
<listitem><para>
|
|
View torrent file list. Use the space-bar to change the
|
|
file priority and <emphasis>*</emphasis> to change the
|
|
priority of all files.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>1 | 2</term>
|
|
<listitem><para>
|
|
Adjust max uploads.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
|
|
<varlistentry>
|
|
<term>3 | 4</term>
|
|
<listitem><para>
|
|
Adjust min peers.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>5 | 6</term>
|
|
<listitem><para>
|
|
Adjust max peers.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>u</term>
|
|
<listitem><para>
|
|
|
|
Display transfering blocks.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>i</term>
|
|
<listitem><para>
|
|
|
|
Display chunk rarity.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>o</term>
|
|
<listitem><para>
|
|
|
|
Display the tracker list. Cycle the trackers in a group
|
|
|
|
with the space-bar.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>p</term>
|
|
<listitem><para>
|
|
|
|
View peer and torrent information.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>t | T</term>
|
|
<listitem><para>
|
|
|
|
Initiate tracker request. Use capital T to force the request, ignoring
|
|
the "min interval" set by the tracker.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>k</term>
|
|
<listitem><para>
|
|
|
|
Disconnect peer.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>*</term>
|
|
<listitem><para>
|
|
|
|
Choke/Snub peer.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>OPTIONS</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>-b <replaceable>a.b.c.d</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Bind listening socket and outgoing connections to this network
|
|
interface address.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-d <replaceable>directory</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the default download directory. Defaults to "./".
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-h</term>
|
|
<listitem><para>
|
|
|
|
Display help and exit.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-i <replaceable>a.b.c.d</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the address reported to the tracker.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-n</term>
|
|
<listitem><para>
|
|
|
|
Don't load ~/.rtorrent.rc on startup.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-o key1=opt1,...</term>
|
|
<term>-O key=opt</term>
|
|
<listitem><para>
|
|
|
|
Set any number of options, see the SETTINGS section. The options given
|
|
here override the resource files. Use capital <emphasis>-O</emphasis>
|
|
to allow comma in the option.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-p <replaceable>a-b</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Try to open a listening port in the range <emphasis>a</emphasis> up to
|
|
and including <emphasis>b</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>-s <replaceable>directory</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Session management will be enabled and the torrent files for all open
|
|
downloads will be stored in this directory. Only one instance of
|
|
rtorrent should be used with each session directory, though at the
|
|
moment no locking is done. An empty string will disable the session
|
|
directory.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>GENERAL SETTINGS</title>
|
|
<para>
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>max_peers = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the maximum number of peers to allow in each download.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>min_peers = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the minimum number of peers to try to connect to in each download.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>max_uploads = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the maximum number of simultaneous uploads per download.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>download_rate = <replaceable>KB</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the maximum global download rate.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>upload_rate = <replaceable>KB</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the maximum global upload rate.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>bind = <replaceable>a.b.c.d</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Bind listening socket and outgoing connections to this network
|
|
interface address.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>ip = <replaceable>a.b.c.d</replaceable></term>
|
|
<term>ip = <replaceable>hostname</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the address reported to the tracker.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>port_range = <replaceable>a-b</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Try to open a listening port in the range <emphasis>a</emphasis> up to
|
|
and including <emphasis>b</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>port_random = <replaceable>yes | no</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Open the listening port at a random position in the port range.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>check_hash = <replaceable>yes | no</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Perform hash check on torrents that have finished downloading.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>directory = <replaceable>directory</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the default download directory. Defaults to "./".
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>session = <replaceable>directory</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Session management will be enabled and the torrent files for all open
|
|
downloads will be stored in this directory. Only one instance of
|
|
rtorrent should be used with each session directory, though at the
|
|
moment no locking is done. An empty string will disable the session
|
|
directory.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>http_proxy = <replaceable>url</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Use a http proxy. Use an empty string to disable.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>encoding_list = <replaceable>encoding</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Add a preferred filename encoding to the list. The encodings are
|
|
attempted in the order they are inserted, if none match the torrent
|
|
default is used.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>schedule = <replaceable>id</replaceable>,<replaceable>start</replaceable>,<replaceable>interval</replaceable>,<replaceable>command</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Call <emphasis>command</emphasis> every <emphasis>interval</emphasis>
|
|
seconds, starting from <emphasis>start</emphasis>. An
|
|
<emphasis>interval</emphasis> of zero calls the task once, while a
|
|
<emphasis>start</emphasis> of zero calls it immediately. Currently
|
|
<emphasis>command</emphasis> is forwarded to the option handler.
|
|
|
|
<emphasis>start</emphasis> and <emphasis>interval</emphasis> may
|
|
optionally use a time format, <emphasis>dd:hh:mm:ss</emphasis>. F.ex to
|
|
start a task every day at <emphasis>18:00</emphasis>, use
|
|
<emphasis>18:00:00,24:00:00</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>schedule_remove = <replaceable>id</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Delete <emphasis>id</emphasis> from the scheduler.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>start_tied =</term>
|
|
<listitem><para>
|
|
|
|
Start torrents that are tied to filenames that have been re-added.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>stop_untied =</term>
|
|
<term>close_untied =</term>
|
|
<term>remove_untied =</term>
|
|
<listitem><para>
|
|
|
|
Stop, close or remove the torrents that are tied to filenames that
|
|
have been deleted. Clear the association with the 'U' key.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>close_low_diskspace = <replaceable>space</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Close any active torrents on filesystems with less than
|
|
<emphasis>space</emphasis> diskspace left. Use with
|
|
<emphasis>schedule</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>stop_on_ratio = <replaceable>min_ratio</replaceable></term>
|
|
<term>stop_on_ratio = <replaceable>min_ratio</replaceable>,<replaceable>min_upload</replaceable></term>
|
|
<term>stop_on_ratio = <replaceable>min_ratio</replaceable>,<replaceable>min_upload</replaceable>,<replaceable>max_ratio</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Stop torrents when they reach the given upload ratio
|
|
<emphasis>min_ratio</emphasis> in percent. If the optional
|
|
<emphasis>min_upload</emphasis> is given, require a total
|
|
upload amount of this many bytes as well. If the optional
|
|
<emphasis>max_ratio></emphasis> is given, stop the torrent
|
|
when reaching this ratio regardless of the total upload
|
|
amount. Exclude certain torrent by pressing
|
|
<emphasis>Shift+I</emphasis> in the downlist list.
|
|
Use with <emphasis>schedule</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>load = <replaceable>file</replaceable></term>
|
|
<term>load_verbose = <replaceable>file</replaceable></term>
|
|
<term>load_start = <replaceable>file</replaceable></term>
|
|
<term>load_start_verbose = <replaceable>file</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Load and possibly start a file, or possibly multiple files by using the
|
|
wild-card "*". This is meant for use with
|
|
<emphasis>schedule</emphasis>, though ensure that the
|
|
<emphasis>start</emphasis> is non-zero. The loaded file will be tied
|
|
to the filename provided.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>import = <replaceable>file</replaceable></term>
|
|
<term>try_import = <replaceable>file</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Load a resource file. <emphasis>try_import</emphasis> does not throw
|
|
torrent::input_error exception on bad input.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>USER-INTERFACE SETTINGS</title>
|
|
<para>
|
|
Display related settings.
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>view_add = <replaceable>name</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Create a new view.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>view_sort = <replaceable>name</replaceable></term>
|
|
<term>view_sort = <replaceable>name</replaceable>,<replaceable>seconds</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Sort a view according the the criteria set by
|
|
<emphasis>view_sort_current</emphasis>. If the optional argument is
|
|
supplied, the view is not sorted if a change happened during the last
|
|
<emphasis>seconds</emphasis>. This command is meant to be used with
|
|
<emphasis>schedule</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>view_sort_new = <replaceable>name</replaceable>,<replaceable>...</replaceable></term>
|
|
<term>view_sort_current = <replaceable>name</replaceable>,<replaceable>...</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the sorting criteria for when new elements inserted or
|
|
<emphasis>view_sort</emphasis> is called. The list can contain any
|
|
number of criteria, including zero, from the following:
|
|
|
|
</para><para>
|
|
|
|
<emphasis>name</emphasis>, <emphasis>name_reverse</emphasis>,
|
|
<emphasis>stopped</emphasis>, <emphasis>started</emphasis>,
|
|
<emphasis>complete</emphasis>, <emphasis>incomplete</emphasis>,
|
|
<emphasis>state_changed</emphasis>,
|
|
<emphasis>state_changed_reverse</emphasis>
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>view_filter = <replaceable>name</replaceable>,<replaceable>...</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set a list of filter to apply when new new downloads are added and
|
|
when <emphasis>view_sort</emphasis> is called. All filters must
|
|
match for the download to be included.
|
|
|
|
</para><para>
|
|
|
|
<emphasis>stopped</emphasis>, <emphasis>started</emphasis>,
|
|
<emphasis>complete</emphasis>, <emphasis>incomplete</emphasis>,
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>key_layout = <replaceable>querty|azerty</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Change the key-bindings.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>ADVANCED SETTINGS</title>
|
|
<para>
|
|
This list contains settings users shouldn't need to touch.
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term>hash_read_ahead = <replaceable>MB</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Configure how far ahead we ask the kernel to read when doing hash
|
|
checking. The hash checker uses madvise(..., MADV_WILLNEED) for the
|
|
requests.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>hash_interval = <replaceable>ms</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Interval between attempts to check the hash when the chunk is not in
|
|
memory, in milliseconds.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>hash_max_tries = <replaceable>tries</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Number of attempts to check the hash while using the mincore status,
|
|
before forcing. Overworked systems might need lower values to get a
|
|
decent hash checking rate.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>max_open_files = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Number of files to simultaneously keep open. Libtorrent dynamically
|
|
opens and closes files when mapping files to memory. Defaults to 128.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>max_open_sockets = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Number of sockets to simultaneously keep open. This value is set to be
|
|
<emphasis>sysconf(_SC_OPEN_MAX) - 256</emphasis> at startup. This
|
|
gives the client 128 sockets to use as it wishes.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>send_buffer_size = <replaceable>value</replaceable></term>
|
|
<term>receive_buffer_size = <replaceable>value</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Adjust the send and receive buffer size for socket.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>umask = <replaceable>0644</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set the umask for this process, which is applied to all files created
|
|
by the program.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>working_directory = <replaceable>directory</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Changes the working directory of the process using
|
|
<emphasis>chdir</emphasis>.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>session_on_completion = <replaceable>yes</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Controls if the session torrent is saved when a torrent finishes. By
|
|
default on.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>session_lock = <replaceable>yes</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Controls if a lock file is created in the session directory on startup.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>session_save = </term>
|
|
<listitem><para>
|
|
|
|
Save the session files for all downloads.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>use_udp_trackers = <replaceable>yes</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Use UDP trackers. Disable if you are behind a firewall etc that does
|
|
not allow connections to UDP trackers.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>enable_trackers = <replaceable>yes</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Set to <emphasis>no</emphasis> to disable tracker requests.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>tracker_dump = <replaceable>filename</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Dump tracker requests to <emphasis>filename</emphasis>, disable by
|
|
supplying an empty string. Only torrents loaded while
|
|
<emphasis>tracker_dump</emphasis> contains a non-empty string will be
|
|
logged at the moment, although disabling it will work as expected.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>tos = <replaceable>default|lowdelay|throughput|reliability|mincost</replaceable></term>
|
|
<listitem><para>
|
|
|
|
Change the TOS of peer connections, by default set to
|
|
<emphasis>throughput</emphasis>. If the option is set to
|
|
<emphasis>default</emphasis> then the system default TOS is used.
|
|
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>AUTHORS</title>
|
|
<para>
|
|
<simplelist type="vert">
|
|
<member>Jari "Rakshasa" Sundell <email>jaris@ifi.uio.no</email></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
</refentry>
|