summaryrefslogtreecommitdiffstats
path: root/doc/en/commands.docbook
blob: 4afc0fd53e1602369cb744531e5d9a01ee38dfc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
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>