diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | apps/ktorrent/ktorrent.desktop | 8 | ||||
| -rw-r--r-- | apps/ktorrent/pref.cpp | 2 | ||||
| -rw-r--r-- | configure.in | 2 | ||||
| -rw-r--r-- | doc/Makefile.am | 3 | ||||
| -rw-r--r-- | doc/en/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/en/advanced-config.png | bin | 0 -> 72396 bytes | |||
| -rw-r--r-- | doc/en/bittorrent-config.png | bin | 0 -> 78633 bytes | |||
| -rw-r--r-- | doc/en/commands.docbook | 255 | ||||
| -rw-r--r-- | doc/en/configure.docbook | 805 | ||||
| -rw-r--r-- | doc/en/credits.docbook | 266 | ||||
| -rw-r--r-- | doc/en/downloads-config.png | bin | 0 -> 79872 bytes | |||
| -rw-r--r-- | doc/en/faq.docbook | 38 | ||||
| -rw-r--r-- | doc/en/general-config.png | bin | 0 -> 78345 bytes | |||
| -rw-r--r-- | doc/en/index.docbook | 75 | ||||
| -rw-r--r-- | doc/en/introduction.docbook | 50 | ||||
| -rw-r--r-- | doc/en/introduction.png | bin | 0 -> 38723 bytes | |||
| -rw-r--r-- | doc/en/plugins-config.png | bin | 0 -> 85080 bytes | |||
| -rw-r--r-- | doc/en/systemtray-popup.png | bin | 0 -> 7564 bytes | |||
| -rw-r--r-- | doc/en/using.docbook | 182 | ||||
| -rw-r--r-- | inst-apps | 5 | ||||
| -rw-r--r-- | subdirs | 1 |
22 files changed, 1682 insertions, 14 deletions
diff --git a/Makefile.am b/Makefile.am index a4871db..7844aa3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = libktorrent plugins apps scripts translations +SUBDIRS = doc libktorrent plugins apps scripts translations # $(UTESTS_DIR) diff --git a/apps/ktorrent/ktorrent.desktop b/apps/ktorrent/ktorrent.desktop index 4a09c56..a5ae848 100644 --- a/apps/ktorrent/ktorrent.desktop +++ b/apps/ktorrent/ktorrent.desktop @@ -42,13 +42,7 @@ GenericName[zh_TW]=BitTorrent 客戶端程式 Exec=ktorrent %i %m -caption "%c" %u Icon=ktorrent Type=Application -# Restore the following key and remove this comment when a help handbook -# is written. Disabling this key prevents populating the main handbook -# table of contents with a non-existent document, which results in a -# main handbook error message of -# 'There is no documentation available for /xyz/index.html.' -# Also disable this key when there exists only a useless template handbook. -# DocPath=ktorrent/index.html +DocPath=ktorrent/index.html MimeType=application/x-bittorrent;application/x-torrent; X-DCOP-ServiceType=Unique Comment=A BitTorrent program for TDE diff --git a/apps/ktorrent/pref.cpp b/apps/ktorrent/pref.cpp index 73f6a4f..b8155e9 100644 --- a/apps/ktorrent/pref.cpp +++ b/apps/ktorrent/pref.cpp @@ -55,7 +55,7 @@ using namespace KNetwork; KTorrentPreferences::KTorrentPreferences(KTorrent & ktor) - : KDialogBase(IconList, i18n("Preferences"), Ok | Apply | Cancel, Ok), ktor(ktor) + : KDialogBase(IconList, i18n("Preferences"), Help | Ok | Apply | Cancel, Ok), ktor(ktor) { validation_err = false; enableButtonSeparator(true); diff --git a/configure.in b/configure.in index fc4482e..f734a01 100644 --- a/configure.in +++ b/configure.in @@ -293,6 +293,8 @@ AC_CONFIG_FILES([ apps/ktorrent/groups/Makefile ]) AC_CONFIG_FILES([ apps/ktorrent/newui/Makefile ]) AC_CONFIG_FILES([ apps/kttorinfo/Makefile ]) AC_CONFIG_FILES([ apps/ktupnptest/Makefile ]) +AC_CONFIG_FILES([ doc/Makefile ]) +AC_CONFIG_FILES([ doc/en/Makefile ]) AC_CONFIG_FILES([ libktorrent/Makefile ]) AC_CONFIG_FILES([ libktorrent/datachecker/Makefile ]) AC_CONFIG_FILES([ libktorrent/interfaces/Makefile ]) diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..5c0b20e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..67788de --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = ktorrent diff --git a/doc/en/advanced-config.png b/doc/en/advanced-config.png Binary files differnew file mode 100644 index 0000000..bd41f6b --- /dev/null +++ b/doc/en/advanced-config.png diff --git a/doc/en/bittorrent-config.png b/doc/en/bittorrent-config.png Binary files differnew file mode 100644 index 0000000..1140ce4 --- /dev/null +++ b/doc/en/bittorrent-config.png diff --git a/doc/en/commands.docbook b/doc/en/commands.docbook new file mode 100644 index 0000000..4afc0fd --- /dev/null +++ b/doc/en/commands.docbook @@ -0,0 +1,255 @@ +<chapter id="commands"> +<title>Command Reference</title> + +<para> +Each menu item is discussed below. When there is a keyboard shortcut that performs a menu item function, the default shortcut is listed with the menu item. +</para> + +<sect1 id="mainmenu"> +<title>Menus and Shortcut Keys</title> + +<sect2 id="mainmenu-file"> +<title>The <guimenu>File</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog where you can <action>create a new torrent</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open...</guimenuitem> +</menuchoice></term> +<listitem><para>Shows a dialog in which you can <action>open a torrent</action>.</para></listitem> +</varlistentry> + +<!--<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Open Silently</guimenuitem> +</menuchoice></term> +<listitem><para>Shows a dialog in which you can <action>open a torrent, but skip the following dialog</action> that asks you to select what files to download, where to save them &etc; All files will be saved to <link linkend="default-save-location">default location</link></para></listitem> +</varlistentry>--> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Open URL</guimenuitem> +</menuchoice></term> +<listitem><para>Allows you to <action>open a torrent by its local path (&ie; /home/user/file.torrent)</action>, or directly from Internet by its web address (&ie; http://site.com/file/torrent).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Import Torrent</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog where you can <action>import partially downloaded torrent</action>. This will work with any BitTorrent clients data.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Import &tde;3 Torrents</guimenuitem> +</menuchoice></term> +<listitem><para>This will start a process that will <action>import all torrents from &tde;3 folders</action> and show progress in opened window.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>IP Filter</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog where you can <action>ban peers by there IP address</action>. This applies to current season only.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para><action>Exits the application</action>.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="mainmenu-edit"> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para>While in the browser, copy link address of a torrent and then use this menu to <action>paste address</action> in &ktorrent; to open it.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="mainmenu-downloads"> +<title>The <guimenu>Downloads</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Start</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts downloading and/or seeding selected torrent(s)</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Stop</guimenuitem> +</menuchoice></term> +<listitem><para><action>Stops downloading and/or seeding selected torrent(s)</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Remove</guimenuitem> +</menuchoice></term> +<listitem><para><action>Removes selected torrent(s)</action>. For torrents that are not finished, dialog will open asking to delete incomplete data too.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Start All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts downloading and/or seeding all torrents</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Stop All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Stops downloading and/or seeding all torrents</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Check Data</guimenuitem> +</menuchoice></term> +<listitem><para>This will <action>scan downloaded data checking for errors</action> and missing chunks.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Enqueue/Dequeue</guimenuitem> +</menuchoice></term> +<listitem><para>This will <action>enqueue or dequeue selected torrent</action>(s) depending on current state of queue.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Downloads</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para>This will <action>pause all torrents</action> and change this menu item to <guimenuitem>Resume</guimenuitem>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut> +<guimenu>Downloads</guimenu> +<guimenuitem>Speed Limits</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a dialog where you can <action>set speed limit for every torrent</action>, and <guilabel>Global limits</guilabel> for all torrents.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="mainmenu-settings"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the menu bar</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the status bar</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens keyboard shortcuts configuration dialog</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens toolbars configuration dialog</action>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens notifications configuration dialog</action>.</para></listitem> +</varlistentry> + +<!--<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &ktorrent;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens <link linkend="configure">&ktorrent; configuration</link> dialog</action> .</para></listitem> +</varlistentry>--> + +</variablelist> + +</sect2> + +<sect2 id="mainmenu-help"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> + +</chapter> diff --git a/doc/en/configure.docbook b/doc/en/configure.docbook new file mode 100644 index 0000000..f8df3e4 --- /dev/null +++ b/doc/en/configure.docbook @@ -0,0 +1,805 @@ +<chapter id="configure"> +<title>Configure &ktorrent;</title> + +<para> +&ktorrent;'s configuration dialog can be found in the menu under <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &ktorrent;...</guimenuitem></menuchoice>. +</para> + +<sect1 id="downloads-config"> +<title>Downloads</title> + +<screenshot> +<screeninfo>Downloads configuration dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="downloads-config.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Downloads configuration dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Queue Manager</guilabel></term> +<listitem> +<variablelist> + +<!--<varlistentry> +<term><guilabel>Maximum downloads:</guilabel></term> +<listitem> +<para> +Set here the number of torrents <link linkend="queuemanager">Queue Manager</link> will download simultaneously. When a queued torrent finished downloading, another queued torrent will be started. +</para> +</listitem> +</varlistentry>--> + +<varlistentry> +<term><guilabel>Maximum seeds:</guilabel></term> +<listitem> +<para> +Here you can set the number of torrents Queue Manager will seed simultaneously. When a download of a queued torrent is finished and started seeding, last in the queue of the seeding torrents will be stopped. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>When disk space is running low:</guilabel></term> +<listitem> +<para> +Here you can select should queued torrent be started when you are running out of disk space. You can choose one of the following options. +</para> +<simplelist> +<member><guilabel>Don't start torrents</guilabel></member> +<member><guilabel>Ask if torrents can be started</guilabel></member> +<member><guilabel>Start torrents</guilabel></member> +</simplelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Stop torrents when free disk space is lower then:</guilabel></term> +<listitem> +<para> +Select this option to stop all torrents when there is low disk space limit is reached. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Decrease priority of torrents which are stalled for too long</guilabel></term> +<listitem> +<para> +If the queued torrent has been stalled for a specified amount of time, its priority will decrease. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Stalled timer:</guilabel></term> +<listitem> +<para> +Here you can set the amount of time to wait before decreasing torrents priority. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Seeding</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Keep seeding after download is finished</guilabel></term> +<listitem> +<para> +If this option is selected, when download of the torrent is finished &ktorrent; will continue to seed data. You should not disable this, since BitTorrent is a sharing protocol, unless you have an upload limit on your Internet connection. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Number of upload slots</guilabel></term> +<listitem> +<para> +This setting determines the number of peers you will connect to upload them data. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum share ratio</guilabel></term> +<listitem> +<para> +This setting allows you to specify limit on how much data will you share. Ration of 1.00 means 100% will be shared, 1.25 means 125% &etc; This setting do not apply while downloading, only while seeding. When the ratio is reached, seeding of the torrent will stop. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum seed time</guilabel></term> +<listitem> +<para> +This setting allows you to specify limit on how long will you share. Time is set in hours, that means 1.00 is 1 hour, 1.25 is 1 hour 15 minutes &etc; This setting apply only in seeding mode, and when the time is reached, seeding of the torrent will stop. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +</variablelist> + +<variablelist> + +<varlistentry> +<term id="downloads-preferences"><guilabel>Preferences</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Port:</guilabel></term> +<listitem> +<para> +Port configured here, is the port &ktorrent; will use to connect to other peers in the swarm. Normally, you do not need to change this setting, but some Internet Service Providers restrict traffic on known P2P ports (see <link linkend="bittorrent-encryption">Encryption</link>). Use one in range 49152 to 65535 (unregistered, dynamic and/or private ports). +</para> +<note><para> +If you are behind a router, you need to forward this port to accept incoming connections. UPnP plugin can do this for you. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>UDP tracker port:</guilabel></term> +<listitem> +<para> +Port to use for connections with UDP trackers. These trackers are rarely used because they are supported in only few BitTorrent clients. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum connections per torrent:</guilabel></term> +<listitem> +<para> +Here you can set maximum number of peers to connect to per single torrent. Setting 45 to 65 maximum connections per torrent is generally enough, though people with more bandwidth can configure this higher, together with a higher number of upload slots and a higher upload speed. +</para> +<note><para> +Setting this high will not automatically improve your speeds. Speed is more dependent on the health of the torrent swarm and your own upload behavior. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Global connection limit:</guilabel></term> +<listitem> +<para> +Use this setting to limit the total number of peers (all torrents combined) that &ktorrent; will connect to. +Keep in mind that this setting should ideally be high enough for the amount of torrents you want to run, while avoiding low responsiveness of your Internet connection or even worse — capping your own bandwidth. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum download speed:</guilabel></term> +<listitem> +<para> +Here you can set a limit on download speed. For best BitTorrent performance, set this to 95% of your total bandwidth download speed, or lower if you want to share your bandwidth with other application. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum upload speed:</guilabel></term> +<listitem> +<para> +Here you can set a limit on upload speed. Set this to 85–90% of your bandwidth upload speed. Setting this too high might compromise your download speed. If in doubt use <link linkend="recommended-options">recommended setting</link>. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Advanced</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>DSCP value for IP pockets:</guilabel></term> +<listitem> +<para> +With this setting you can prioritize your &ktorrent; Internet traffic. This is useful when you want your other applications (&ie; web browser) to have priority over &ktorrent; or vise verse. Use one of the following numbers to describe priority. +</para> +<informaltable> +<tgroup cols="2"> +<tbody> +<row> +<entry>0</entry> +<entry>Default</entry> +</row> +<row> +<entry>1</entry> +<entry>Low</entry> +</row> +<row> +<entry>2</entry> +<entry>Medium</entry> +</row> +<row> +<entry>3</entry> +<entry>High</entry> +</row> +<row> +<entry>4</entry> +<entry>Critical</entry> +</row> +<row> +<entry>5</entry> +<entry>Real-Time</entry> +</row> +<row> +<entry>6</entry> +<entry>Premium</entry> +</row> +<row> +<entry>7</entry> +<entry>Urgent</entry> +</row> +<row> +<entry>any other number</entry> +<entry>Can be used with routers and IP tables to map traffic in network environment</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum number of connection setups:</guilabel></term> +<listitem> +<para> +This option allows you to set the number of outgoing connections that will be attempted simultaneously. If you are having a problem with &ktorrent; blocking your other Internet traffic, try setting this number a bit lower. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Network Interface</guilabel></term> +<listitem> +<para> +Here you can set which interface to use for Internet traffic. If you have more then one connection to Internet (&ie; Wireless, Satellite and/or Cable), you can use a specific one or all of them. +</para> +<note><para> +This option requires a restart to take effect. +</para></note> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="recommended-options"><guibutton>Recommended Options</guibutton></term> +<listitem> +<variablelist> + +<para> +The <guibutton>Recommended Options</guibutton> button will open a window where you can calculate best <link linkend="downloads-config">Downloads</link> and Queue Manager settings, based on your bandwidth. Use <guibutton>Apply</guibutton> button to automatically set the recommended options or <guibutton>Cancel</guibutton> to close the window without changing any settings. +</para> + +<varlistentry> +<term><guilabel>Available upload bandwidth:</guilabel></term> +<listitem> +<para> +Here you should enter your Internet upload speed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Available download bandwidth:</guilabel></term> +<listitem> +<para> +Here you should enter your Internet download speed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Average speed per slot:</guilabel></term> +<listitem> +<para> +... +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Number of torrents you usually download simultaneously:</guilabel></term> +<listitem> +<para> +If you want recommended options to be calculated based on the number of torrents that you usually download, enter that number here. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Slots per torrent:</guilabel></term> +<listitem> +<para> +... +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="general-config"> +<title>General</title> + +<screenshot> +<screeninfo>General configuration dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="general-config.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>General configuration dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Folders</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Folder to store torrent information:</guilabel></term> +<listitem> +<para> +This folder is used to store information for all currently opened torrents. If you run two operating system, you can share this folder between two &ktorrent;'s, to allow continues download when in either of them. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="default-save-location"><guilabel>Default save location:</guilabel></term> +<listitem> +<para> +If enabled and set, this location will be default location for saving torrents data in all dialogs. Data of <quote>silently opened torrents</quote> will be saved to this location. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Move completed downloads to:</guilabel></term> +<listitem> +<para> +When completed downloading, torrents data can be moved to different folder. Use this setting to separate your finished from unfinished downloads. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Copy torrent files to:</guilabel></term> +<listitem> +<para> +When opened, torrent files can be saved in specified folder for backup, record or other purposes. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>System Tray Icon</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Show system tray icon</guilabel></term> +<listitem> +<para> +This option, when selected, shows a &ktorrent; icon in system tray. It also changes the behavior of <guibutton>Close</guibutton> button from exiting the program to hiding it. If you do not want this kind of behavior, disable this option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show system tray popup messages</guilabel></term> +<listitem> +<para> +Select this setting, if you want to see a small popup containing current speed and transferred data information, when your mouse is over the &ktorrent; icon in system tray. +</para> + +<screenshot> +<screeninfo>System tray popup message</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="systemtray-popup.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>System tray popup message</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> +This setting also determines whether you will be notified of torrent events (&ie; download completed, share ratio reached, torrent stopped by an error &etc;). +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Miscellaneous</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Use a list of files when displaying files of a torrent</guilabel></term> +<listitem> +<para> +When selected, this setting will show all files in a flat list, while hiding all the folders. This affects all dialogs and plugins where torrent file listing is used. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Open multiple torrents silently</guilabel></term> +<listitem> +<para> +Use this setting to skip all dialogs when opening more than one torrent. Opening one torrent, will still show the dialog. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Suppress sleep when torrents are running</guilabel></term> +<listitem> +<para> +Enable this option to prevent your computer from going into Hibernation or Stand by mode, when there are running torrents. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +</variablelist> + +<variablelist> + +<varlistentry> +<term><guilabel>DHT</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Use DHT to get addition peers</guilabel></term> +<listitem> +<para> +DHT is a way of gathering additional peers from other peers in the swarm. There are some torrents that do not use trackers to get the list of peers, but rely only on DHT. These are know as Trackerless Torrents. You will be unable to download these torrents, If this option is disabled. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>UDP port for DHT communication:</guilabel></term> +<listitem> +<para> +Here you can set the port on which to search for additional peers. This port can be same as the port configured in the <link linkend="downloads-preferences">Downloads tab</link>. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="bittorrent-encryption"><guilabel>Encryption</guilabel></term> +<listitem> +<variablelist> + +<varlistentry> +<term><guilabel>Use protocol encryption</guilabel></term> +<listitem> +<para> +Some Internet Service Providers throttle (slowdown) their customers BitTorrent traffic. Encryption is designed to hide BitTorrent traffic so that detection and therefore throttling would fail. It is not designed to make data secure, but only to get around bandwidth throttling. +</para> +<note><para> +If you select only this option, you will be unable to connect to peers that do not use protocol encryption. +</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow unencrypted connections</guilabel></term> +<listitem> +<para> +Even if your Internet Service Provider is not throttling your connection, you may still find that enabling encryption allows some peers to send you data (peers that use encryption and do not allow unencrypted connections). Selecting this options will enable you to connect both ways. +</para> +</listitem> +</varlistentry> + +</variablelist> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="advanced-config"> +<title>Advanced</title> + +<screenshot> +<screeninfo>Advanced configuration dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="advanced-config.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Advanced configuration dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Data Checking</guilabel></term> +<listitem> + +<variablelist> + +<varlistentry> +<term><guilabel>Recheck chunks during uploading</guilabel></term> +<listitem> +<para> +This will verify a chunk when it is loaded into memory, preventing upload of bad data. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Don't recheck when chunks are bigger then:</guilabel></term> +<listitem> +<para> +Here you can set maximum size of the chunk that are to be rechecked during uploading. Bigger chunks that specified will not be checked. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Do a full data check after</guilabel> <guilabel>corrupted chunks</guilabel></term> +<listitem> +<para> +Full data check will be started, if the specified number of corrupted chunks has been detected. If you regularly experience errors during downloads, enable this option. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Check data when download is finished</guilabel></term> +<listitem> +<para> +When torrent has finished downloading, data will be fully checked. Chunks that failed to download correctly, will be downloaded again. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Data Checking</guilabel></term> +<listitem> + +<variablelist> + +<varlistentry> +<term><guilabel>GUI update interval:</guilabel></term> +<listitem> +<para> +Set here the interval of the GUI updates. If &ktorrent; is using much of your CPU, try decreasing this setting. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Downloads sleep interval:</guilabel></term> +<listitem> +<para> +Here you can set the time network threads will sleep when they are speed limited. Setting this to high can lead to lower speeds in high bandwidth situations, such as Local Area Networks. Setting this to low will increase your CPU usage. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Disk Space</guilabel></term> +<listitem> + +<variablelist> + +<varlistentry> +<term><guilabel>Reserve disk space before starting a download</guilabel></term> +<listitem> +<para> +This will reserve disk space when starting a torrent. It is faster then full allocation but will fragment data on your disk. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Fully reserve disk space (avoids fragmentation)</guilabel></term> +<listitem> +<para> +Will this setting you can fully allocate data on the disk. This is slower, but will prevent data fragmentation on the disk. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Disk space reservation method:</guilabel></term> +<listitem> +<para> +Here you can select the method of allocation. <guilabel>Basic</guilabel> method will work with all file systems, but it is slow. <guilabel>Filesystem Specific</guilabel> method is faster, but will only work with some specific file systems. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Miscellaneous</guilabel></term> +<listitem> + +<variablelist> + +<varlistentry> +<term><guilabel>Time estimation algorithm:</guilabel></term> +<listitem> +<para> +The algorithm selected here will be used to guess how much time is left for download to finish. Choose one of the following. +</para> + +<variablelist> + +<varlistentry> +<term><guilabel>KTorrent</guilabel></term> +<listitem> +<para> +Automatically choose appropriate algorithm based on current situation. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Current speed</guilabel></term> +<listitem> +<para> +Bytes left to download divided by torrent current speed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Average speed</guilabel></term> +<listitem> +<para> +Bytes left to download divided by torrent average speed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Moving of X</guilabel></term> +<listitem> +<para> +Bytes left to download divided by average speed of the last 20 samples. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Moving average</guilabel></term> +<listitem> +<para> +Bytes left to download divided by moving average speed of the last 20 samples. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Preview size for audio files:</guilabel></term> +<listitem> +<para> +Selected amount of data, at the beginning and end of the file, that will be downloaded first. This will enable you to preview audio files. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Preview size for video files:</guilabel></term> +<listitem> +<para> +Selected amount of data, at the beginning and end of the file, that will be downloaded first. This will enable you to preview quality and content of video files. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="plugins-config"> +<title>Plugins</title> + +<screenshot> +<screeninfo>Plugins configuration dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="plugins-config.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Plugins configuration dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> +In this tab you can enable or disable plugins. Plugins that are configurable, when enabled, will add their tab in the configuration dialog. +</para> + +</sect1> + +</chapter> diff --git a/doc/en/credits.docbook b/doc/en/credits.docbook new file mode 100644 index 0000000..ae3daf4 --- /dev/null +++ b/doc/en/credits.docbook @@ -0,0 +1,266 @@ +<chapter id="credits"> +<title>Credits and License</title> + +<para> +KTorrent © 2005–2008 Joris Guisson and Ivan Vasić +</para> + +<variablelist> + +<varlistentry> +<term>&ktorrent; Developers:</term> + +<listitem> + +<variablelist> + +<varlistentry> +<term>Joris Guisson</term> +<listitem><para>Original author</para></listitem> +</varlistentry> + +<varlistentry> +<term>Ivan Vasić</term> +<listitem><para>Original author</para></listitem> +</varlistentry> + +<varlistentry> +<term>Alan Jones</term> +<listitem><para>BitFinder Plugin</para></listitem> +</varlistentry> + +<varlistentry> +<term>Diego R. Brogna</term> +<listitem><para>Web Interface Plugin</para></listitem> +</varlistentry> + +<varlistentry> +<term>Krzysztof Kundzicz</term> +<listitem><para>Statistics Plugin</para></listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&ktorrent; Contributors:</term> +<listitem> + +<variablelist> + +<varlistentry> +<term>Mladen Babic</term> +<listitem><para>Application icon and a couple of others</para></listitem> +</varlistentry> + +<varlistentry> +<term>Adam Treat</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Danny Allen</term> +<listitem><para>1.0 application icon</para></listitem> +</varlistentry> + +<varlistentry> +<term>Vincent Wagelaar</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Knut Morten Johansson</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Felix Berger</term> +<listitem><para>ChunkBar's tooltip and IWFileTreeItem sorting</para></listitem> +</varlistentry> + +<varlistentry> +<term>Andreas Kling</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Felipe Sateler</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Maxmind (http://www.maxmind.com/)</term> +<listitem><para>Country locator for InfoWidget plugin. Flags are taken from http://flags.blogpotato.de/ so thanks to them too.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Adam Forsyth</term> +<listitem><para>File prioritization</para></listitem> +</varlistentry> + +<varlistentry> +<term>Thomas Bernard (http://miniupnp.free.fr/)</term> +<listitem><para>Miniupnp was used as an example for our own UPnP implementation</para></listitem> +</varlistentry> + +<varlistentry> +<term>Diego Rosario Brogna</term> +<listitem><para>Global max share ratio patch</para></listitem> +</varlistentry> + +<varlistentry> +<term>Lesly Weyts</term> +<listitem><para>Zeroconf enhancements</para></listitem> +</varlistentry> + +<varlistentry> +<term>Kevin Andre (http://users.edpnet.be/hyperquantum/)</term> +<listitem><para>Zeroconf enhancements</para></listitem> +</varlistentry> + +<varlistentry> +<term>Dagur Valberg Johannsson</term> +<listitem><para>Coldmilk webgui</para></listitem> +</varlistentry> + +<varlistentry> +<term>Alexander Dymo</term> +<listitem><para>IDEAl code from KDevelop</para></listitem> +</varlistentry> + +<varlistentry> +<term>Scott Wolchok</term> +<listitem><para>Conversion speed improvement in ipfilter plugin</para></listitem> +</varlistentry> + +<varlistentry> +<term>Bryan Burns of Juniper Networks</term> +<listitem><para>Discovered 2 security vulnerabilities (both are fixed)</para></listitem> +</varlistentry> + +<varlistentry> +<term>Goten Xiao</term> +<listitem><para>Patch to load silently with a save location</para></listitem> +</varlistentry> + +<varlistentry> +<term>Rapsys</term> +<listitem><para>Fixes in PHP code of webinterface</para></listitem> +</varlistentry> + +<varlistentry> +<term>Athantor</term> +<listitem><para>XFS specific disk preallocation</para></listitem> +</varlistentry> + +<varlistentry> +<term>twisted_fall</term> +<listitem><para>Patch to not show very low speeds</para></listitem> +</varlistentry> + +<varlistentry> +<term>Lucke</term> +<listitem><para>Patch to show potentially firewalled status</para></listitem> +</varlistentry> + +<varlistentry> +<term>Modestas Vainius</term> +<listitem><para>Several patches</para></listitem> +</varlistentry> + +<varlistentry> +<term>Stefan Monov</term> +<listitem><para>Patch to hide menu bar</para></listitem> +</varlistentry> + +<varlistentry> +<term>The_Kernel</term> +<listitem><para>Patch to change file priorities in the webgui</para></listitem> +</varlistentry> + +<varlistentry> +<term>Rafał Miłecki</term> +<listitem><para>Several webgui patches</para></listitem> +</varlistentry> + +<varlistentry> +<term>Ozzi</term> +<listitem><para>Fixes for several warnings</para></listitem> +</varlistentry> + +<varlistentry> +<term>Markus Brueffer</term> +<listitem><para>Patch to fix free diskspace calculation on FreeBSD</para></listitem> +</varlistentry> + +<varlistentry> +<term>Lukas Appelhans</term> +<listitem><para>Patch to fix a crash in ChunkDownloadView</para></listitem> +</varlistentry> + +<varlistentry> +<term>Rickard Närström</term> +<listitem><para>A couple of bugfixes</para></listitem> +</varlistentry> + +<varlistentry> +<term>caruccio</term> +<listitem><para>Patch to load torrents silently from the command line</para></listitem> +</varlistentry> + +<varlistentry> +<term>Lee Olson</term> +<listitem><para>New set of icons</para></listitem> +</varlistentry> + +</variablelist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&ktorrent; Documentation:</term> +<listitem> + +<variablelist> + +<varlistentry> +<term>Joris Guisson</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Stoeptegel</term> +<listitem><para></para></listitem> +</varlistentry> + +<varlistentry> +<term>Predrag Kašić</term> +<listitem><para></para></listitem> +</varlistentry> + +<!-- CREDITS FOR TRANSLATORS +<varlistentry> +<term>Trans Lator</term> +<listitem><para>Translation for Language</para></listitem> +</varlistentry> +--> + +</variablelist> + +</listitem> +</varlistentry> + +</variablelist> + +<para> +&underGPL; +</para> + +<para> <!-- All documentation are licensed under the FDL --> +&underFDL; <!-- regardless of applications licence --> +</para> <!-- do not remove this --> + +</chapter> diff --git a/doc/en/downloads-config.png b/doc/en/downloads-config.png Binary files differnew file mode 100644 index 0000000..ebd34b8 --- /dev/null +++ b/doc/en/downloads-config.png diff --git a/doc/en/faq.docbook b/doc/en/faq.docbook new file mode 100644 index 0000000..9a9c762 --- /dev/null +++ b/doc/en/faq.docbook @@ -0,0 +1,38 @@ +<chapter id="faq"> +<title>Questions and Answers</title> + +<para> +Here are some of the frequently asked questions and their corresponding answers. Chances are that you are probably looking for one of them. +</para> + +<qandaset id="faqlist"> + +<qandaentry> +<question> +<para> +What is <quote>port forwarding</quote>? +</para> +</question> +<answer> +<para> +Computers that are behind a router cannot accept incoming connections, which can hurt their download speed. Port forwarding is a solution to this problem. If you have UPnP enabled router, use UPnP plugin to forward needed ports in few mouse clicks. Otherwise visit <ulink url="http://portforward.com">http://portforward.com</ulink> to learn how to do this on your router. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +What is the most common mistake of BitTorrent users? +</para> +</question> +<answer> +<para> +Not seeding after they have finished downloading. It is important that peers with 100% of data keep torrent running for others to download. Share ratio of 1.0 is a minimum you should seed for every torrent you download. +</para> +</answer> +</qandaentry> + +</qandaset> + +</chapter> diff --git a/doc/en/general-config.png b/doc/en/general-config.png Binary files differnew file mode 100644 index 0000000..7bd4523 --- /dev/null +++ b/doc/en/general-config.png diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..346e46b --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,75 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY ktorrent "<application>KTorrent</application>"> + <!ENTITY kappname "&ktorrent;"> + <!ENTITY % English "INCLUDE"><!-- for translation change language here only --> + <!-- DocBook Entities --> + <!ENTITY introduction SYSTEM "introduction.docbook"> + <!ENTITY using SYSTEM "using.docbook"> + <!ENTITY configure SYSTEM "configure.docbook"> + <!ENTITY commands SYSTEM "commands.docbook"> + <!ENTITY faq SYSTEM "faq.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &ktorrent; Handbook</title> + +<authorgroup> +<!-- <author>Joris Guisson</author> --> +<!-- <author>Stoeptegel</author> --> +<!-- <author>Predrag Kašić</author> --> +<author>&tde-authors;</author> +</authorgroup> + +<copyright> +<year>2006</year> +<holder>Joris Guisson</holder> +</copyright> +<copyright> +<year>2007</year> +<holder>Stoeptegel</holder> +</copyright> +<copyright> +<year>2008</year> +<holder>Predrag Kašić</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<date>Reviewed: &tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para> +&ktorrent; is a BitTorrent client for &tde;. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>Network</keyword> +<keyword>File Sharing</keyword> +<keyword>BitTorrent</keyword> +<keyword>KTorrent</keyword> +<keyword>Torrent</keyword> +</keywordset> + +</bookinfo> + +&introduction; +&using; +&configure; +&commands; +&faq; +&credits; + +<!-- &underFDL; --> + +</book> diff --git a/doc/en/introduction.docbook b/doc/en/introduction.docbook new file mode 100644 index 0000000..02b7f70 --- /dev/null +++ b/doc/en/introduction.docbook @@ -0,0 +1,50 @@ +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="introduction-whatis"> +<title>What is &ktorrent;?</title> + +<para> +&ktorrent; is a &tde; application for sharing files, using BitTorrent protocol. &ktorrent; allows you to create torrents, search for them and download their content. +</para> + +<para> +&ktorrent; is an advanced BitTorrent client, with extendable interface via plugin system. Useful features include file prioritization, speed capping and scheduling, torrent queue and statistics. These features, with support for DHT, PeerExchange, UDP Trackers and Encryption, make &ktorrent; a full-featured BitTorrent client. +</para> + +<screenshot> +<screeninfo>Introduction</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="introduction.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Introduction</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> +Please report any problems or feature requests using <guimenuitem>Report Bug...</guimenuitem> from the Help menu. +</para> + +</sect1> + +<sect1 id="torrents"> +<title>Torrent Files</title> + +<para><indexterm><primary>torrent</primary></indexterm> +Torrent is a small file that contains information about the data, but not actual data. You can not download without a torrent file! Originally they are known as BitTorrent files, but because of there extension (<literal role="extension">*.torrent</literal>), more people refer to them as torrents. +</para> + +<para><indexterm><primary>search</primary></indexterm> +Many websites provide search for torrents by searching trough information they contain. This is similar to a web search, with an exception that links in the results do not send you to other sites, but rather to torrent files. +</para> + +<tip><para> +With the Search plugin, you can search and open torrents directly from &ktorrent;. +</para></tip> + +</sect1> + +</chapter> diff --git a/doc/en/introduction.png b/doc/en/introduction.png Binary files differnew file mode 100644 index 0000000..bc1d688 --- /dev/null +++ b/doc/en/introduction.png diff --git a/doc/en/plugins-config.png b/doc/en/plugins-config.png Binary files differnew file mode 100644 index 0000000..5d4fc08 --- /dev/null +++ b/doc/en/plugins-config.png diff --git a/doc/en/systemtray-popup.png b/doc/en/systemtray-popup.png Binary files differnew file mode 100644 index 0000000..5005754 --- /dev/null +++ b/doc/en/systemtray-popup.png diff --git a/doc/en/using.docbook b/doc/en/using.docbook new file mode 100644 index 0000000..631afc7 --- /dev/null +++ b/doc/en/using.docbook @@ -0,0 +1,182 @@ +<chapter id="using"> +<title>Using &ktorrent;</title> + +<sect1 id="add-torrent"> +<title>Adding a Torrent</title> + +<sect2 id="open-torrent"> +<title>Opening a Torrent</title> + +<!--<para> +To open a torrent located on your computer, use <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut></menuchoice>. This will launch a dialog in which you will locate the torrent you wish to open. +</para>--> + +<!--<screenshot> +<screeninfo>Open Torrent Location</screeninfo> +<inlinemediaobject> +<imageobject> +<imagedata fileref="opentorrent-location.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Open Torrent Location</phrase> +</textobject> +</inlinemediaobject> +</screenshot>--> + +<para> +To open a torrent directly from a web site, use <menuchoice><guimenu>File</guimenu><guimenuitem>Open URL</guimenuitem></menuchoice>. This will launch a dialog in which you can paste location of the torrent you wish to open. +</para> + +<!--<screenshot> +<screeninfo>Open Torrent Location</screeninfo> +<inlinemediaobject> +<imageobject> +<imagedata fileref="opentorrent-url.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Open Torrent Location</phrase> +</textobject> +</inlinemediaobject> +</screenshot>--> + +</sect2> + +<sect2 id="torrent-options"> +<title>Torrent and Data Options</title> + +<para> +After you have opened a torrent, following dialog will appear, where you can modify default options. When you are <guilabel>OK</guilabel> to add torrent. +</para> + +<!--<screenshot> +<screeninfo>Open Torrent Files</screeninfo> +<inlinemediaobject> +<imageobject> +<imagedata fileref="opentorrent-files.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Open Torrent Files</phrase> +</textobject> +</inlinemediaobject> +</screenshot>--> + +<variablelist> + +<!--<varlistentry> +<term><guilabel>Download to:</guilabel></term> +<listitem> +<para> +Where to store torrents data (<link linkend="default-save-location">Default save location</link>). +</para> +</listitem> +</varlistentry>--> + +<varlistentry> +<term><guilabel>Group:</guilabel></term> +<listitem> +<para> +With this option you can add opened torrent to a <link linkend="groups">custom group</link>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>User controlled</guilabel></term> +<listitem> +<para> +Use this option to manually start and stop this torrent. Selecting this option will not set torrent as quelled in the Queue Manager. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Start torrent</guilabel></term> +<listitem> +<para> +Whether or not to start downloading a torrent. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Toplevel directory:</guilabel></term> +<listitem> +<para> +Name of the directory in which to save files of a multifile torrent. Setting the same directory name, you can download two different torrents with exactly same files. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Skip data check if existing files are found</guilabel></term> +<listitem> +<para> +When selected, data will not be checked for errors if files exists. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="import-torrent"> +<title>Partialy Downloaded Torrent</title> + +<para> +Partialy Downloaded Torrent +</para> + +</sect2> + +</sect1> + +<sect1 id="groups"> +<title>Grouping Torrents</title> + +<para> +&ktorrent; is able to display your torrents in diffrent groups. There are several default groups which will display torrents by their state (downloading or uploading) or activity (running or not). You can also choose their sub-category groups. To display all torrents use <guilabel>All Torrents</guilabel> group. +</para> + +<para> +To create a custom group and add a torrent to that group, do following: +</para> + +<!--<procedure> +<step> +Click with &RMB; anywhere in <guilabel>Groups</guilabel> tab, select <guilabel>New Group</guilabel> from the menu and then enter name for that group +</step> +<step> +Click on a torrent you want to add with &RMB; and from the <guilabel>Add to Group</guilabel> submenu select the group +</step> +</procedure>--> + + +<para> +Torrents that are not in any custom group will appear under <guilabel>Ungrouped Torrents</guilabel>. +</para> + +</sect1> + +<sect1 id="queuemanager"> +<title>Queue Manager</title> + +<para> +The Queue Manager enables you to fully automatize starting and stopping of torrents. This is useful when you want to dedicate your bandwidth to few torrents and automatically start next torrent when one is finished. When a torrent is opened in &ktorrent;, it will be quelled and set as last in the list of quelled torrents. +</para> + +<!--<para> +To set the number of torrents you want to download and seed simultaneously, open configuration dialog and in the <link linkend="queuemanager-config">Queue Manager panel</link> set <guilabel>Maximum downloads</guilabel> and <guilabel>Maximum seeds</guilabel> to your preference. You can also use <link linkend="recommended-options">recommended options</link> to set this settings. If you do not want to queue your torrents set both options to <option>0</option> (unlimited). +</para>--> + +<para> +You can queue and dequeue torrents in the <guilabel>Queue Manager</guilabel> tab, located in the bottom left corner of &ktorrent; window. There you can also reorder your quelled torrents. +</para> + +<note><para> +If you manually start or stop a quelled torrent, that torrent will be dequelled. +</para></note> + +</sect1> + +</chapter> diff --git a/inst-apps b/inst-apps deleted file mode 100644 index 98c0567..0000000 --- a/inst-apps +++ /dev/null @@ -1,5 +0,0 @@ -apps -libktorrent -plugins -scripts -translations @@ -1,4 +1,5 @@ apps +doc libktorrent plugins scripts |
