mirror of
https://git.deluge-torrent.org/deluge
synced 2025-04-20 03:24:54 +00:00
remove the docs/build folder
revert the removal of the __rpcapi file for auto-generating the rpc api docs
This commit is contained in:
Damien Churchill
parent
46b5e9b406
commit
e5021cdbc8
46 changed files with 46 additions and 4465 deletions
20
deluge/__rpcapi.py
Normal file
20
deluge/__rpcapi.py
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
from new import classobj
|
||||
from deluge.core.core import Core
|
||||
from deluge.core.daemon import Daemon
|
||||
|
||||
class RpcApi:
|
||||
pass
|
||||
|
||||
def scan_for_methods(obj):
|
||||
methods = {
|
||||
'__doc__': 'Methods available in %s' % obj.__name__.lower()
|
||||
}
|
||||
for d in dir(obj):
|
||||
if not hasattr(getattr(obj,d), '_rpcserver_export'):
|
||||
continue
|
||||
methods[d] = getattr(obj, d)
|
||||
cobj = classobj(obj.__name__.lower(), (object,), methods)
|
||||
setattr(RpcApi, obj.__name__.lower(), cobj)
|
||||
|
||||
scan_for_methods(Core)
|
||||
scan_for_methods(Daemon)
|
||||
|
|
@ -23,19 +23,16 @@
|
|||
defaultType: 'textfield',
|
||||
autoHeight: true
|
||||
});
|
||||
|
||||
this.fields['download_location'] = this.fieldsets['folders'].add({
|
||||
name: 'download_location',
|
||||
fieldLabel: _('Download to'),
|
||||
width: 125
|
||||
});
|
||||
|
||||
this.fields['move_completed'] = this.fieldsets['folders'].add({
|
||||
name: 'move_completed',
|
||||
fieldLabel: _('Move completed to'),
|
||||
width: 125
|
||||
});
|
||||
|
||||
this.fields['copy_torrent_files'] = this.fieldsets['folders'].add({
|
||||
name: 'copy_torrent_files',
|
||||
fieldLabel: _('Copy of .torrent files to'),
|
||||
|
|
@ -48,13 +45,34 @@
|
|||
title: _('Allocation'),
|
||||
autoHeight: true,
|
||||
labelWidth: 1,
|
||||
defaultType: 'radio'
|
||||
defaultType: 'radiogroup'
|
||||
});
|
||||
|
||||
this.fields['compact_allocation'] = this.fieldsets['allocation'].add({
|
||||
name: 'compact_allocation',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Compact')
|
||||
items: [
|
||||
{boxLabel: _('Compact'), value: 'true'},
|
||||
{boxLabel: _('Full'), value: 'false'}
|
||||
]
|
||||
});
|
||||
|
||||
this.fieldsets['options'] = this.add({
|
||||
xtype: 'fieldset',
|
||||
border: false,
|
||||
title: _('Options'),
|
||||
autoHeight: true,
|
||||
labelWidth: 1,
|
||||
defaultType: 'checkbox'
|
||||
});
|
||||
this.fields['prioritize_first_last'] = this.fieldsets['options'].add({
|
||||
name: 'prioritize_first_last',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Prioritize first and last pieces of torrent')
|
||||
});
|
||||
this.fields['add_paused'] = this.fieldsets['options'].add({
|
||||
name: 'add_paused',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Add torrents in Paused state')
|
||||
});
|
||||
},
|
||||
|
||||
|
|
@ -63,34 +81,4 @@
|
|||
}
|
||||
});
|
||||
Deluge.Preferences.addPage(new DownloadPanel());
|
||||
})();
|
||||
|
||||
/*Deluge.Preferences.addPage({
|
||||
|
||||
items: [, {
|
||||
|
||||
items: [{
|
||||
|
||||
}, {
|
||||
name: 'compact_allocation',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Full')
|
||||
}]
|
||||
}, {
|
||||
xtype: 'fieldset',
|
||||
border: false,
|
||||
title: _('Options'),
|
||||
autoHeight: true,
|
||||
labelWidth: 1,
|
||||
defaultType: 'checkbox',
|
||||
items: [{
|
||||
name: 'prioritize_first_last',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Prioritize first and last pieces of torrent')
|
||||
}, {
|
||||
name: 'add_paused',
|
||||
labelSeparator: '',
|
||||
boxLabel: _('Add torrents in Paused state')
|
||||
}]
|
||||
}]
|
||||
});*/
|
||||
})();
|
||||
BIN
docs/build/doctrees/core/index.doctree
vendored
BIN
docs/build/doctrees/core/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/core/rpc.doctree
vendored
BIN
docs/build/doctrees/core/rpc.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/interfaces/console.doctree
vendored
BIN
docs/build/doctrees/interfaces/console.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/interfaces/gtk.doctree
vendored
BIN
docs/build/doctrees/interfaces/gtk.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/interfaces/index.doctree
vendored
BIN
docs/build/doctrees/interfaces/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/interfaces/web.doctree
vendored
BIN
docs/build/doctrees/interfaces/web.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules/common.doctree
vendored
BIN
docs/build/doctrees/modules/common.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules/config.doctree
vendored
BIN
docs/build/doctrees/modules/config.doctree
vendored
Binary file not shown.
4
docs/build/html/.buildinfo
vendored
4
docs/build/html/.buildinfo
vendored
|
|
@ -1,4 +0,0 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config:
|
||||
tags:
|
||||
6
docs/build/html/_sources/core/index.txt
vendored
6
docs/build/html/_sources/core/index.txt
vendored
|
|
@ -1,6 +0,0 @@
|
|||
The Deluge Core
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
|
||||
DelugeRPC <rpc>
|
||||
107
docs/build/html/_sources/core/rpc.txt
vendored
107
docs/build/html/_sources/core/rpc.txt
vendored
|
|
@ -1,107 +0,0 @@
|
|||
Deluge RPC
|
||||
==========
|
||||
---------------
|
||||
Message Formats
|
||||
---------------
|
||||
DelugeRPC is a protocol used for daemon/client communication. There are four
|
||||
types of messages involved in the protocol: RPC Request, RPC Response,
|
||||
RPC Error and Event. All messages are zlib compressed rencoded strings and
|
||||
their data formats are detailed below.
|
||||
|
||||
"""""""""""
|
||||
RPC Request
|
||||
"""""""""""
|
||||
This message is created and sent by the client to the server requesting that a
|
||||
remote method be called. Multiple requests can be bundled in a list.
|
||||
|
||||
**[[request_id, method, [args], {kwargs}], ...]**
|
||||
|
||||
**request_id** (int)
|
||||
An integer determined by the client that is used in replies from the server.
|
||||
This is used to ensure the client knows which request the data is in
|
||||
response to. Another alternative would be to respond in the same order the
|
||||
requests come in, but this could cause lag if an earlier request takes
|
||||
longer to process.
|
||||
|
||||
**method** (str)
|
||||
The name of the remote method to call. This name can be in dotted format to
|
||||
call other objects or plugins methods.
|
||||
|
||||
**args** (list)
|
||||
The arguments to call the method with.
|
||||
|
||||
**kwargs** (dict)
|
||||
The keyword arguments to call the method with.
|
||||
|
||||
""""""""""""
|
||||
RPC Response
|
||||
""""""""""""
|
||||
This message is created and sent in response to a RPC Request from a client. It
|
||||
will hold the return value of the requested method call. In the case of an
|
||||
error, a RPC Error message will be sent instead.
|
||||
|
||||
**[message_type, request_id, [return_value]]**
|
||||
|
||||
**message_type** (int)
|
||||
This will be a RPC_RESPONSE type id. This is used on the client side to
|
||||
determine what kind of message is being received from the daemon.
|
||||
|
||||
**request_id** (int)
|
||||
The request_id is the same as the one sent by the client in the initial
|
||||
request. It used on the client side to determine what message this is in
|
||||
response to.
|
||||
|
||||
**return_value** (list)
|
||||
The return value of the method call.
|
||||
|
||||
"""""""""
|
||||
RPC Error
|
||||
"""""""""
|
||||
This message is created in response to an error generated while processing a
|
||||
RPC Request and will serve as a replacement for a RPC Response message.
|
||||
|
||||
**[message_type, request_id, exception_type, exception_msg, traceback]**
|
||||
|
||||
**message_type** (int)
|
||||
This will be a RPC_ERROR type id.
|
||||
|
||||
**request_id** (int)
|
||||
The request_id is the same as the one sent by the client in the initial
|
||||
request.
|
||||
|
||||
**exception_type** (str)
|
||||
The type of exception raised.
|
||||
|
||||
**exception_msg** (str)
|
||||
The message as to why the exception was raised.
|
||||
|
||||
**traceback** (str)
|
||||
The traceback of the generated exception.
|
||||
|
||||
"""""
|
||||
Event
|
||||
"""""
|
||||
This message is created by the daemon and sent to the clients without being in
|
||||
response to a RPC Request. Events are generally sent for changes in the
|
||||
daemon's state that the clients need to be made aware of.
|
||||
|
||||
**[message_type, event_name, data]**
|
||||
|
||||
**message_type** (int)
|
||||
This will be a RPC_EVENT type id.
|
||||
|
||||
**event_name** (str)
|
||||
This is the name of the event being emitted by the daemon.
|
||||
|
||||
**data** (list)
|
||||
Additional data to be sent with the event. This is dependent upon the event
|
||||
being emitted.
|
||||
|
||||
----------
|
||||
Remote API
|
||||
----------
|
||||
|
||||
.. autoclass:: deluge.core.core.Core
|
||||
:members:
|
||||
.. autoclass:: deluge.core.daemon.Daemon
|
||||
:members:
|
||||
30
docs/build/html/_sources/index.txt
vendored
30
docs/build/html/_sources/index.txt
vendored
|
|
@ -1,30 +0,0 @@
|
|||
.. deluge documentation master file, created by sphinx-quickstart on Tue Nov 4 18:24:06 2008.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Deluge's documentation!
|
||||
==================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Core <core/index.rst>
|
||||
Interfaces <interfaces/index.rst>
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
Modules
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
modules/common
|
||||
modules/config
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
Deluge Console UI
|
||||
=================
|
||||
2
docs/build/html/_sources/interfaces/gtk.txt
vendored
2
docs/build/html/_sources/interfaces/gtk.txt
vendored
|
|
@ -1,2 +0,0 @@
|
|||
Deluge GTK UI
|
||||
=============
|
||||
10
docs/build/html/_sources/interfaces/index.txt
vendored
10
docs/build/html/_sources/interfaces/index.txt
vendored
|
|
@ -1,10 +0,0 @@
|
|||
Deluge's Interfaces
|
||||
===================
|
||||
|
||||
Interfaces.
|
||||
|
||||
.. toctree::
|
||||
|
||||
Gtk Interface <gtk>
|
||||
Web Interface <web>
|
||||
Console Interface <console>
|
||||
19
docs/build/html/_sources/interfaces/web.txt
vendored
19
docs/build/html/_sources/interfaces/web.txt
vendored
|
|
@ -1,19 +0,0 @@
|
|||
Deluge Web UI
|
||||
=============
|
||||
|
||||
The Deluge web interface is intended to be a full featured interface built using
|
||||
the ExtJS framework, running on top of a Twisted webserver.
|
||||
|
||||
|
||||
=================
|
||||
SSL Configuration
|
||||
=================
|
||||
By default the web interface will use the same private key and certificate as
|
||||
the Deluge daemon. If you wish to use a different certificate/key (see
|
||||
`How to Create a SSL Certificate <http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/>`_
|
||||
for information on creating one) you are able to specify which you want to use.
|
||||
|
||||
There are 2 ways to enable SSL encryption in the webserver, 1 is to specify it
|
||||
in your configuration (accessible via the Preferences window). The other is to
|
||||
add '--ssl' when running the webserver, which will override the configuration
|
||||
value and enable SSL.
|
||||
5
docs/build/html/_sources/modules/common.txt
vendored
5
docs/build/html/_sources/modules/common.txt
vendored
|
|
@ -1,5 +0,0 @@
|
|||
:mod:`deluge.common`
|
||||
====================
|
||||
|
||||
.. automodule:: deluge.common
|
||||
:members:
|
||||
11
docs/build/html/_sources/modules/config.txt
vendored
11
docs/build/html/_sources/modules/config.txt
vendored
|
|
@ -1,11 +0,0 @@
|
|||
:mod:`deluge.config`
|
||||
====================
|
||||
|
||||
.. automodule:: deluge.config
|
||||
.. autoclass:: Config
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. automethod:: __setitem__
|
||||
.. automethod:: __getitem__
|
||||
414
docs/build/html/_static/basic.css
vendored
414
docs/build/html/_static/basic.css
vendored
|
|
@ -1,414 +0,0 @@
|
|||
/**
|
||||
* Sphinx stylesheet -- basic theme
|
||||
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 230px;
|
||||
}
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable dl, table.indextable dd {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 0;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.refcount {
|
||||
color: #060;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
tt.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
tt.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
tt.xref, a tt {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
201
docs/build/html/_static/default.css
vendored
201
docs/build/html/_static/default.css
vendored
|
|
@ -1,201 +0,0 @@
|
|||
/**
|
||||
* Sphinx stylesheet -- default theme
|
||||
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: sans-serif;
|
||||
font-size: 100%;
|
||||
background-color: #11303d;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
background-color: #1c4e63;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #000000;
|
||||
padding: 0 20px 30px 20px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
color: #ffffff;
|
||||
width: 100%;
|
||||
padding: 9px 0 9px 0;
|
||||
text-align: center;
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #ffffff;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.related {
|
||||
background-color: #133f52;
|
||||
line-height: 30px;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.related a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.4em;
|
||||
font-weight: normal;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
color: #ffffff;
|
||||
font-size: 1.3em;
|
||||
font-weight: normal;
|
||||
margin: 5px 0 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.topless {
|
||||
margin: 5px 10px 10px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px;
|
||||
padding: 0;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #98dbcc;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #355f7c;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
text-align: justify;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Trebuchet MS', sans-serif;
|
||||
background-color: #f2f2f2;
|
||||
font-weight: normal;
|
||||
color: #20435c;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin: 20px -20px 10px -20px;
|
||||
padding: 3px 0 3px 10px;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; font-size: 200%; }
|
||||
div.body h2 { font-size: 160%; }
|
||||
div.body h3 { font-size: 140%; }
|
||||
div.body h4 { font-size: 120%; }
|
||||
div.body h5 { font-size: 110%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #c60f0f;
|
||||
font-size: 0.8em;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
background-color: #c60f0f;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
text-align: justify;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title + p {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #eee;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #ffc;
|
||||
border: 1px solid #ff6;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
background-color: #ffe4e4;
|
||||
border: 1px solid #f66;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 5px;
|
||||
background-color: #eeffcc;
|
||||
color: #333333;
|
||||
line-height: 120%;
|
||||
border: 1px solid #ac9;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
tt {
|
||||
background-color: #ecf0f3;
|
||||
padding: 0 1px 0 1px;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
232
docs/build/html/_static/doctools.js
vendored
232
docs/build/html/_static/doctools.js
vendored
|
|
@ -1,232 +0,0 @@
|
|||
/// XXX: make it cross browser
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
*/
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
|
||||
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {}
|
||||
}
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
}
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s == 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* small function to check if an array contains
|
||||
* a given item.
|
||||
*/
|
||||
jQuery.contains = function(arr, item) {
|
||||
for (var i = 0; i < arr.length; i++) {
|
||||
if (arr[i] == item)
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node) {
|
||||
if (node.nodeType == 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) {
|
||||
var span = document.createElement("span");
|
||||
span.className = className;
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this)
|
||||
});
|
||||
}
|
||||
}
|
||||
return this.each(function() {
|
||||
highlight(this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initModIndex();
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can savely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated == 'undefined')
|
||||
return string;
|
||||
return (typeof translated == 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated == 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlight');
|
||||
});
|
||||
}, 10);
|
||||
$('<li class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>')
|
||||
.appendTo($('.sidebar .this-page-menu'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the modindex toggle buttons
|
||||
*/
|
||||
initModIndex : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
console.log($('tr.cg-' + idnum).toggle());
|
||||
if (src.substr(-9) == 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
|
||||
$('span.highlight').removeClass('highlight');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this == '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
BIN
docs/build/html/_static/file.png
vendored
BIN
docs/build/html/_static/file.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 392 B |
32
docs/build/html/_static/jquery.js
vendored
32
docs/build/html/_static/jquery.js
vendored
File diff suppressed because one or more lines are too long
BIN
docs/build/html/_static/minus.png
vendored
BIN
docs/build/html/_static/minus.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 199 B |
BIN
docs/build/html/_static/plus.png
vendored
BIN
docs/build/html/_static/plus.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 199 B |
61
docs/build/html/_static/pygments.css
vendored
61
docs/build/html/_static/pygments.css
vendored
|
|
@ -1,61 +0,0 @@
|
|||
.hll { background-color: #ffffcc }
|
||||
.c { color: #408090; font-style: italic } /* Comment */
|
||||
.err { border: 1px solid #FF0000 } /* Error */
|
||||
.k { color: #007020; font-weight: bold } /* Keyword */
|
||||
.o { color: #666666 } /* Operator */
|
||||
.cm { color: #408090; font-style: italic } /* Comment.Multiline */
|
||||
.cp { color: #007020 } /* Comment.Preproc */
|
||||
.c1 { color: #408090; font-style: italic } /* Comment.Single */
|
||||
.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
|
||||
.gd { color: #A00000 } /* Generic.Deleted */
|
||||
.ge { font-style: italic } /* Generic.Emph */
|
||||
.gr { color: #FF0000 } /* Generic.Error */
|
||||
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.gi { color: #00A000 } /* Generic.Inserted */
|
||||
.go { color: #303030 } /* Generic.Output */
|
||||
.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
||||
.gs { font-weight: bold } /* Generic.Strong */
|
||||
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.gt { color: #0040D0 } /* Generic.Traceback */
|
||||
.kc { color: #007020; font-weight: bold } /* Keyword.Constant */
|
||||
.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
|
||||
.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
|
||||
.kp { color: #007020 } /* Keyword.Pseudo */
|
||||
.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
||||
.kt { color: #902000 } /* Keyword.Type */
|
||||
.m { color: #208050 } /* Literal.Number */
|
||||
.s { color: #4070a0 } /* Literal.String */
|
||||
.na { color: #4070a0 } /* Name.Attribute */
|
||||
.nb { color: #007020 } /* Name.Builtin */
|
||||
.nc { color: #0e84b5; font-weight: bold } /* Name.Class */
|
||||
.no { color: #60add5 } /* Name.Constant */
|
||||
.nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
||||
.ni { color: #d55537; font-weight: bold } /* Name.Entity */
|
||||
.ne { color: #007020 } /* Name.Exception */
|
||||
.nf { color: #06287e } /* Name.Function */
|
||||
.nl { color: #002070; font-weight: bold } /* Name.Label */
|
||||
.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
|
||||
.nt { color: #062873; font-weight: bold } /* Name.Tag */
|
||||
.nv { color: #bb60d5 } /* Name.Variable */
|
||||
.ow { color: #007020; font-weight: bold } /* Operator.Word */
|
||||
.w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.mf { color: #208050 } /* Literal.Number.Float */
|
||||
.mh { color: #208050 } /* Literal.Number.Hex */
|
||||
.mi { color: #208050 } /* Literal.Number.Integer */
|
||||
.mo { color: #208050 } /* Literal.Number.Oct */
|
||||
.sb { color: #4070a0 } /* Literal.String.Backtick */
|
||||
.sc { color: #4070a0 } /* Literal.String.Char */
|
||||
.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
|
||||
.s2 { color: #4070a0 } /* Literal.String.Double */
|
||||
.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
|
||||
.sh { color: #4070a0 } /* Literal.String.Heredoc */
|
||||
.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
|
||||
.sx { color: #c65d09 } /* Literal.String.Other */
|
||||
.sr { color: #235388 } /* Literal.String.Regex */
|
||||
.s1 { color: #4070a0 } /* Literal.String.Single */
|
||||
.ss { color: #517918 } /* Literal.String.Symbol */
|
||||
.bp { color: #007020 } /* Name.Builtin.Pseudo */
|
||||
.vc { color: #bb60d5 } /* Name.Variable.Class */
|
||||
.vg { color: #bb60d5 } /* Name.Variable.Global */
|
||||
.vi { color: #bb60d5 } /* Name.Variable.Instance */
|
||||
.il { color: #208050 } /* Literal.Number.Integer.Long */
|
||||
467
docs/build/html/_static/searchtools.js
vendored
467
docs/build/html/_static/searchtools.js
vendored
|
|
@ -1,467 +0,0 @@
|
|||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurance, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
|
||||
jQuery.makeSearchSummary = function(text, keywords, hlwords) {
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlight');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var PorterStemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Sets the index
|
||||
*/
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (var i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
};
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
query : function(query) {
|
||||
// stem the searchterms and add them to the
|
||||
// correct list
|
||||
var stemmer = new PorterStemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = query.split(/\s+/);
|
||||
var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
|
||||
for (var i = 0; i < tmp.length; i++) {
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i]).toLowerCase();
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
var toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
var toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
};
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
console.debug('SEARCH: searching for:');
|
||||
console.info('required: ', searchterms);
|
||||
console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
var terms = this._index.terms;
|
||||
var descrefs = this._index.descrefs;
|
||||
var modules = this._index.modules;
|
||||
var desctypes = this._index.desctypes;
|
||||
var fileMap = {};
|
||||
var files = null;
|
||||
var objectResults = [];
|
||||
var regularResults = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
if (object != null) {
|
||||
for (var module in modules) {
|
||||
if (module.indexOf(object) > -1) {
|
||||
fn = modules[module];
|
||||
descr = _('module, in ') + titles[fn];
|
||||
objectResults.push([filenames[fn], module, '#module-'+module, descr]);
|
||||
}
|
||||
}
|
||||
for (var prefix in descrefs) {
|
||||
for (var name in descrefs[prefix]) {
|
||||
if (name.toLowerCase().indexOf(object) > -1) {
|
||||
match = descrefs[prefix][name];
|
||||
fullname = (prefix ? prefix + '.' : '') + name;
|
||||
descr = desctypes[match[1]] + _(', in ') + titles[match[0]];
|
||||
objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// sort results descending
|
||||
objectResults.sort(function(a, b) {
|
||||
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
|
||||
});
|
||||
|
||||
|
||||
// perform the search on the required terms
|
||||
for (var i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
// no match but word was a required one
|
||||
if ((files = terms[word]) == null)
|
||||
break;
|
||||
if (files.length == undefined) {
|
||||
files = [files];
|
||||
}
|
||||
// create the mapping
|
||||
for (var j = 0; j < files.length; j++) {
|
||||
var file = files[j];
|
||||
if (file in fileMap)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (var file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the
|
||||
// search result.
|
||||
for (var i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
$.contains(terms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it
|
||||
// to the result list
|
||||
if (valid)
|
||||
regularResults.push([filenames[file], titles[file], '', null]);
|
||||
}
|
||||
|
||||
// delete unused variables in order to not waste
|
||||
// memory until list is retrieved completely
|
||||
delete filenames, titles, terms;
|
||||
|
||||
// now sort the regular results descending by title
|
||||
regularResults.sort(function(a, b) {
|
||||
var left = a[1].toLowerCase();
|
||||
var right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
});
|
||||
|
||||
// combine both
|
||||
var results = regularResults.concat(objectResults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
listItem.append($('<a/>').attr(
|
||||
'href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.get('_sources/' + item[0] + '.txt', function(data) {
|
||||
listItem.append($.makeSearchSummary(data, searchterms, hlterms));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
}
|
||||
}
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
126
docs/build/html/core/index.html
vendored
126
docs/build/html/core/index.html
vendored
|
|
@ -1,126 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>The Deluge Core — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="next" title="Deluge RPC" href="rpc.html" />
|
||||
<link rel="prev" title="Welcome to Deluge’s documentation!" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="rpc.html" title="Deluge RPC"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../index.html" title="Welcome to Deluge’s documentation!"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="the-deluge-core">
|
||||
<h1>The Deluge Core<a class="headerlink" href="#the-deluge-core" title="Permalink to this headline">¶</a></h1>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="rpc.html">DelugeRPC</a><ul>
|
||||
<li class="toctree-l2"><a class="reference external" href="rpc.html#message-formats">Message Formats</a><ul>
|
||||
<li class="toctree-l3"><a class="reference external" href="rpc.html#rpc-request">RPC Request</a></li>
|
||||
<li class="toctree-l3"><a class="reference external" href="rpc.html#rpc-response">RPC Response</a></li>
|
||||
<li class="toctree-l3"><a class="reference external" href="rpc.html#rpc-error">RPC Error</a></li>
|
||||
<li class="toctree-l3"><a class="reference external" href="rpc.html#event">Event</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference external" href="rpc.html#remote-api">Remote API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../index.html"
|
||||
title="previous chapter">Welcome to Deluge’s documentation!</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="rpc.html"
|
||||
title="next chapter">Deluge RPC</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/core/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="rpc.html" title="Deluge RPC"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../index.html" title="Welcome to Deluge’s documentation!"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
557
docs/build/html/core/rpc.html
vendored
557
docs/build/html/core/rpc.html
vendored
|
|
@ -1,557 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Deluge RPC — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="up" title="The Deluge Core" href="index.html" />
|
||||
<link rel="next" title="Deluge’s Interfaces" href="../interfaces/index.html" />
|
||||
<link rel="prev" title="The Deluge Core" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../interfaces/index.html" title="Deluge’s Interfaces"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="The Deluge Core"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" accesskey="U">The Deluge Core</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="deluge-rpc">
|
||||
<h1>Deluge RPC<a class="headerlink" href="#deluge-rpc" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="message-formats">
|
||||
<h2>Message Formats<a class="headerlink" href="#message-formats" title="Permalink to this headline">¶</a></h2>
|
||||
<p>DelugeRPC is a protocol used for daemon/client communication. There are four
|
||||
types of messages involved in the protocol: RPC Request, RPC Response,
|
||||
RPC Error and Event. All messages are zlib compressed rencoded strings and
|
||||
their data formats are detailed below.</p>
|
||||
<div class="section" id="rpc-request">
|
||||
<h3>RPC Request<a class="headerlink" href="#rpc-request" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This message is created and sent by the client to the server requesting that a
|
||||
remote method be called. Multiple requests can be bundled in a list.</p>
|
||||
<p><strong>[[request_id, method, [args], {kwargs}], ...]</strong></p>
|
||||
<dl class="docutils">
|
||||
<dt><strong>request_id</strong> (int)</dt>
|
||||
<dd>An integer determined by the client that is used in replies from the server.
|
||||
This is used to ensure the client knows which request the data is in
|
||||
response to. Another alternative would be to respond in the same order the
|
||||
requests come in, but this could cause lag if an earlier request takes
|
||||
longer to process.</dd>
|
||||
<dt><strong>method</strong> (str)</dt>
|
||||
<dd>The name of the remote method to call. This name can be in dotted format to
|
||||
call other objects or plugins methods.</dd>
|
||||
<dt><strong>args</strong> (list)</dt>
|
||||
<dd>The arguments to call the method with.</dd>
|
||||
<dt><strong>kwargs</strong> (dict)</dt>
|
||||
<dd>The keyword arguments to call the method with.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="rpc-response">
|
||||
<h3>RPC Response<a class="headerlink" href="#rpc-response" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This message is created and sent in response to a RPC Request from a client. It
|
||||
will hold the return value of the requested method call. In the case of an
|
||||
error, a RPC Error message will be sent instead.</p>
|
||||
<p><strong>[message_type, request_id, [return_value]]</strong></p>
|
||||
<dl class="docutils">
|
||||
<dt><strong>message_type</strong> (int)</dt>
|
||||
<dd>This will be a RPC_RESPONSE type id. This is used on the client side to
|
||||
determine what kind of message is being received from the daemon.</dd>
|
||||
<dt><strong>request_id</strong> (int)</dt>
|
||||
<dd>The request_id is the same as the one sent by the client in the initial
|
||||
request. It used on the client side to determine what message this is in
|
||||
response to.</dd>
|
||||
<dt><strong>return_value</strong> (list)</dt>
|
||||
<dd>The return value of the method call.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="rpc-error">
|
||||
<h3>RPC Error<a class="headerlink" href="#rpc-error" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This message is created in response to an error generated while processing a
|
||||
RPC Request and will serve as a replacement for a RPC Response message.</p>
|
||||
<p><strong>[message_type, request_id, exception_type, exception_msg, traceback]</strong></p>
|
||||
<dl class="docutils">
|
||||
<dt><strong>message_type</strong> (int)</dt>
|
||||
<dd>This will be a RPC_ERROR type id.</dd>
|
||||
<dt><strong>request_id</strong> (int)</dt>
|
||||
<dd>The request_id is the same as the one sent by the client in the initial
|
||||
request.</dd>
|
||||
<dt><strong>exception_type</strong> (str)</dt>
|
||||
<dd>The type of exception raised.</dd>
|
||||
<dt><strong>exception_msg</strong> (str)</dt>
|
||||
<dd>The message as to why the exception was raised.</dd>
|
||||
<dt><strong>traceback</strong> (str)</dt>
|
||||
<dd>The traceback of the generated exception.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event">
|
||||
<h3>Event<a class="headerlink" href="#event" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This message is created by the daemon and sent to the clients without being in
|
||||
response to a RPC Request. Events are generally sent for changes in the
|
||||
daemon’s state that the clients need to be made aware of.</p>
|
||||
<p><strong>[message_type, event_name, data]</strong></p>
|
||||
<dl class="docutils">
|
||||
<dt><strong>message_type</strong> (int)</dt>
|
||||
<dd>This will be a RPC_EVENT type id.</dd>
|
||||
<dt><strong>event_name</strong> (str)</dt>
|
||||
<dd>This is the name of the event being emitted by the daemon.</dd>
|
||||
<dt><strong>data</strong> (list)</dt>
|
||||
<dd>Additional data to be sent with the event. This is dependent upon the event
|
||||
being emitted.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="remote-api">
|
||||
<h2>Remote API<a class="headerlink" href="#remote-api" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="deluge.core.core.Core">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">deluge.core.core.</tt><tt class="descname">Core</tt><big>(</big><em>listen_interface=None</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="deluge.core.core.Core.add_torrent_file">
|
||||
<tt class="descname">add_torrent_file</tt><big>(</big><em>filename</em>, <em>filedump</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.add_torrent_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a torrent file to the session.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>filename</em> – str, the filename of the torrent</li>
|
||||
<li><em>filedump</em> – str, a base64 encoded string of the torrent file contents</li>
|
||||
<li><em>options</em> – dict, the options to apply to the torrent on add</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the torrent_id as a str or None</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.add_torrent_magnet">
|
||||
<tt class="descname">add_torrent_magnet</tt><big>(</big><em>uri</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.add_torrent_magnet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a torrent from a magnet link.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><em>uri</em> – str, the magnet link</li>
|
||||
<li><em>options</em> – dict, the options to apply to the torrent on add</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.add_torrent_url">
|
||||
<tt class="descname">add_torrent_url</tt><big>(</big><em>url</em>, <em>options</em>, <em>headers=None</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.add_torrent_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a torrent from a url. Deluge will attempt to fetch the torrent
|
||||
from url prior to adding it to the session.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>url</em> – str, the url pointing to the torrent file</li>
|
||||
<li><em>options</em> – dict, the options to apply to the torrent on add</li>
|
||||
<li><em>headers</em> – dict, any optional headers to send</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a Deferred which returns the torrent_id as a str or None</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.force_recheck">
|
||||
<tt class="descname">force_recheck</tt><big>(</big><em>torrent_ids</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.force_recheck" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Forces a data recheck on torrent_ids</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_available_plugins">
|
||||
<tt class="descname">get_available_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_available_plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns a list of plugins available in the core</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_cache_status">
|
||||
<tt class="descname">get_cache_status</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_cache_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a dictionary of the session’s cache status.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a dict of the cache status</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_config">
|
||||
<tt class="descname">get_config</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Get all the preferences as a dictionary</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_config_value">
|
||||
<tt class="descname">get_config_value</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_config_value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Get the config value for key</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_config_values">
|
||||
<tt class="descname">get_config_values</tt><big>(</big><em>keys</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_config_values" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Get the config values for the entered keys</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_dht_nodes">
|
||||
<tt class="descname">get_dht_nodes</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_dht_nodes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the number of dht nodes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_download_rate">
|
||||
<tt class="descname">get_download_rate</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_download_rate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the payload download rate</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_enabled_plugins">
|
||||
<tt class="descname">get_enabled_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_enabled_plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns a list of enabled plugins in the core</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_filter_tree">
|
||||
<tt class="descname">get_filter_tree</tt><big>(</big><em>show_zero_hits=True</em>, <em>hide_cat=None</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_filter_tree" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns {field: [(value,count)] }
|
||||
for use in sidebar(s)</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_health">
|
||||
<tt class="descname">get_health</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_health" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns True if we have established incoming connections</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_listen_port">
|
||||
<tt class="descname">get_listen_port</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_listen_port" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the active listen port</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_num_connections">
|
||||
<tt class="descname">get_num_connections</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_num_connections" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the current number of connections</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_path_size">
|
||||
<tt class="descname">get_path_size</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_path_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the size of the file or folder ‘path’ and -1 if the path is
|
||||
unaccessible (non-existent or insufficient privs)</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_session_state">
|
||||
<tt class="descname">get_session_state</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_session_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns a list of torrent_ids in the session.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_session_status">
|
||||
<tt class="descname">get_session_status</tt><big>(</big><em>keys</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_session_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the session status values for ‘keys’</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>keys</em> – list of strings, the keys for which we want values</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a dictionary of {key: value, ...}</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_stats">
|
||||
<tt class="descname">get_stats</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_stats" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>document me!!!</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_status_keys">
|
||||
<tt class="descname">get_status_keys</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_status_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns all possible keys for the keys argument in get_torrent(s)_status.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_torrents_status">
|
||||
<tt class="descname">get_torrents_status</tt><big>(</big><em>filter_dict</em>, <em>keys</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_torrents_status" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns all torrents , optionally filtered by filter_dict.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.get_upload_rate">
|
||||
<tt class="descname">get_upload_rate</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.get_upload_rate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns the payload upload rate</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.pause_all_torrents">
|
||||
<tt class="descname">pause_all_torrents</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.pause_all_torrents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Pause all torrents in the session</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.rename_files">
|
||||
<tt class="descname">rename_files</tt><big>(</big><em>torrent_id</em>, <em>filenames</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.rename_files" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Renames files in ‘torrent_id’. The ‘filenames’ parameter should be a
|
||||
list of (index, filename) pairs.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.rename_folder">
|
||||
<tt class="descname">rename_folder</tt><big>(</big><em>torrent_id</em>, <em>folder</em>, <em>new_folder</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.rename_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Renames the ‘folder’ to ‘new_folder’ in ‘torrent_id’.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.rescan_plugins">
|
||||
<tt class="descname">rescan_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.rescan_plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Rescans the plugin folders for new plugins</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.resume_all_torrents">
|
||||
<tt class="descname">resume_all_torrents</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.resume_all_torrents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Resume all torrents in the session</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.save_dht_state">
|
||||
<tt class="descname">save_dht_state</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.save_dht_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Saves the dht state to a file</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_config">
|
||||
<tt class="descname">set_config</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set the config with values from dictionary</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_auto_managed">
|
||||
<tt class="descname">set_torrent_auto_managed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_auto_managed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the auto managed flag for queueing purposes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_file_priorities">
|
||||
<tt class="descname">set_torrent_file_priorities</tt><big>(</big><em>torrent_id</em>, <em>priorities</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_file_priorities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents file priorities</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_max_connections">
|
||||
<tt class="descname">set_torrent_max_connections</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_max_connections" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents max number of connections</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_max_download_speed">
|
||||
<tt class="descname">set_torrent_max_download_speed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_max_download_speed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents max download speed</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_max_upload_slots">
|
||||
<tt class="descname">set_torrent_max_upload_slots</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_max_upload_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents max number of upload slots</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_max_upload_speed">
|
||||
<tt class="descname">set_torrent_max_upload_speed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_max_upload_speed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents max upload speed</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_move_completed">
|
||||
<tt class="descname">set_torrent_move_completed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_move_completed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the torrent to be moved when completed</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_move_completed_path">
|
||||
<tt class="descname">set_torrent_move_completed_path</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_move_completed_path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the path for the torrent to be moved when completed</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_options">
|
||||
<tt class="descname">set_torrent_options</tt><big>(</big><em>torrent_ids</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the torrent options for torrent_ids</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_prioritize_first_last">
|
||||
<tt class="descname">set_torrent_prioritize_first_last</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_prioritize_first_last" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a higher priority to the first and last pieces</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_remove_at_ratio">
|
||||
<tt class="descname">set_torrent_remove_at_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_remove_at_ratio" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the torrent to be removed at ‘stop_ratio’</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_stop_at_ratio">
|
||||
<tt class="descname">set_torrent_stop_at_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_stop_at_ratio" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the torrent to stop at ‘stop_ratio’</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_stop_ratio">
|
||||
<tt class="descname">set_torrent_stop_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_stop_ratio" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets the ratio when to stop a torrent if ‘stop_at_ratio’ is set</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.set_torrent_trackers">
|
||||
<tt class="descname">set_torrent_trackers</tt><big>(</big><em>torrent_id</em>, <em>trackers</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.set_torrent_trackers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Sets a torrents tracker list. trackers will be [{“url”, “tier”}]</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.start">
|
||||
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Starts the core</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.test_listen_port">
|
||||
<tt class="descname">test_listen_port</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.core.Core.test_listen_port" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Checks if active port is open</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.core.Core.upload_plugin">
|
||||
<tt class="descname">upload_plugin</tt><big>(</big><em>filename</em>, <em>plugin_data</em><big>)</big><a class="headerlink" href="#deluge.core.core.Core.upload_plugin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>This method is used to upload new plugins to the daemon. It is used
|
||||
when connecting to the daemon remotely and installing a new plugin on
|
||||
the client side. ‘plugin_data’ is a xmlrpc.Binary object of the file data,
|
||||
ie, plugin_file.read()</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="deluge.core.daemon.Daemon">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">deluge.core.daemon.</tt><tt class="descname">Daemon</tt><big>(</big><em>options=None</em>, <em>args=None</em>, <em>classic=False</em><big>)</big><a class="headerlink" href="#deluge.core.daemon.Daemon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="deluge.core.daemon.Daemon.get_method_list">
|
||||
<tt class="descname">get_method_list</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.daemon.Daemon.get_method_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Returns a list of the exported methods.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.core.daemon.Daemon.info">
|
||||
<tt class="descname">info</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.core.daemon.Daemon.info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns some info from the daemon.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">str, the version number</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="">Deluge RPC</a><ul>
|
||||
<li><a class="reference external" href="#message-formats">Message Formats</a><ul>
|
||||
<li><a class="reference external" href="#rpc-request">RPC Request</a></li>
|
||||
<li><a class="reference external" href="#rpc-response">RPC Response</a></li>
|
||||
<li><a class="reference external" href="#rpc-error">RPC Error</a></li>
|
||||
<li><a class="reference external" href="#event">Event</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference external" href="#remote-api">Remote API</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">The Deluge Core</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../interfaces/index.html"
|
||||
title="next chapter">Deluge’s Interfaces</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/core/rpc.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../interfaces/index.html" title="Deluge’s Interfaces"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="The Deluge Core"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" >The Deluge Core</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
284
docs/build/html/genindex.html
vendored
284
docs/build/html/genindex.html
vendored
|
|
@ -1,284 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a>
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
<h2 id="_">_</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/config.html#deluge.config.Config.__getitem__">__getitem__() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.__setitem__">__setitem__() (deluge.config.Config method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="A">A</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.add_torrent_file">add_torrent_file() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.add_torrent_magnet">add_torrent_magnet() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.add_torrent_url">add_torrent_url() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.apply_all">apply_all() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.apply_set_functions">apply_set_functions() (deluge.config.Config method)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="C">C</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/config.html#deluge.config.Config">Config (class in deluge.config)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.config">config (deluge.config.Config attribute)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.config_file">config_file (deluge.config.Config attribute)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core">Core (class in deluge.core.core)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.create_magnet_uri">create_magnet_uri() (in module deluge.common)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="D">D</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.daemon.Daemon">Daemon (class in deluge.core.daemon)</a></dt>
|
||||
<dt><a href="modules/common.html#module-deluge.common">deluge.common (module)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="modules/config.html#module-deluge.config">deluge.config (module)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="F">F</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/common.html#deluge.common.fdate">fdate() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.fetch_url">fetch_url() (in module deluge.common)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.force_recheck">force_recheck() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.fpcnt">fpcnt() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.fpeer">fpeer() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="modules/common.html#deluge.common.free_space">free_space() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.fsize">fsize() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.fspeed">fspeed() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.ftime">ftime() (in module deluge.common)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="G">G</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_available_plugins">get_available_plugins() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_cache_status">get_cache_status() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_config">get_config() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_config_value">get_config_value() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_config_values">get_config_values() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.get_default_config_dir">get_default_config_dir() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.get_default_download_dir">get_default_download_dir() (in module deluge.common)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_dht_nodes">get_dht_nodes() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_download_rate">get_download_rate() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_enabled_plugins">get_enabled_plugins() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_filter_tree">get_filter_tree() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_health">get_health() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.get_item">get_item() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_listen_port">get_listen_port() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="core/rpc.html#deluge.core.daemon.Daemon.get_method_list">get_method_list() (deluge.core.daemon.Daemon method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_num_connections">get_num_connections() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_path_size">get_path_size() (deluge.core.core.Core method)</a></dt>
|
||||
<dd><dl>
|
||||
<dt><a href="modules/common.html#deluge.common.get_path_size">(in module deluge.common)</a></dt>
|
||||
</dl></dd>
|
||||
<dt><a href="modules/common.html#deluge.common.get_pixmap">get_pixmap() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.get_revision">get_revision() (in module deluge.common)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_session_state">get_session_state() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_session_status">get_session_status() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_stats">get_stats() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_status_keys">get_status_keys() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_torrents_status">get_torrents_status() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.get_upload_rate">get_upload_rate() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.get_version">get_version() (in module deluge.common)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="I">I</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.daemon.Daemon.info">info() (deluge.core.daemon.Daemon method)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.is_ip">is_ip() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.is_magnet">is_magnet() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="modules/common.html#deluge.common.is_url">is_url() (in module deluge.common)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="L">L</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/config.html#deluge.config.Config.load">load() (deluge.config.Config method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="O">O</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/common.html#deluge.common.open_file">open_file() (in module deluge.common)</a></dt>
|
||||
<dt><a href="modules/common.html#deluge.common.open_url_in_browser">open_url_in_browser() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="modules/common.html#deluge.common.osx_check">osx_check() (in module deluge.common)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="P">P</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.pause_all_torrents">pause_all_torrents() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="R">R</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/config.html#deluge.config.Config.register_change_callback">register_change_callback() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.register_set_function">register_set_function() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.rename_files">rename_files() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.rename_folder">rename_folder() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.rescan_plugins">rescan_plugins() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.resume_all_torrents">resume_all_torrents() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.run_converter">run_converter() (deluge.config.Config method)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="S">S</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/config.html#deluge.config.Config.save">save() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.save_dht_state">save_dht_state() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_config">set_config() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="modules/config.html#deluge.config.Config.set_item">set_item() (deluge.config.Config method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_auto_managed">set_torrent_auto_managed() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_file_priorities">set_torrent_file_priorities() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_max_connections">set_torrent_max_connections() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_max_download_speed">set_torrent_max_download_speed() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_max_upload_slots">set_torrent_max_upload_slots() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_max_upload_speed">set_torrent_max_upload_speed() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_move_completed">set_torrent_move_completed() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_move_completed_path">set_torrent_move_completed_path() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_options">set_torrent_options() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_prioritize_first_last">set_torrent_prioritize_first_last() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_remove_at_ratio">set_torrent_remove_at_ratio() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_stop_at_ratio">set_torrent_stop_at_ratio() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_stop_ratio">set_torrent_stop_ratio() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.set_torrent_trackers">set_torrent_trackers() (deluge.core.core.Core method)</a></dt>
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.start">start() (deluge.core.core.Core method)</a></dt>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="T">T</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.test_listen_port">test_listen_port() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="U">U</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="core/rpc.html#deluge.core.core.Core.upload_plugin">upload_plugin() (deluge.core.core.Core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="V">V</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/common.html#deluge.common.vista_check">vista_check() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
<h2 id="W">W</h2>
|
||||
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
|
||||
<dl>
|
||||
|
||||
<dt><a href="modules/common.html#deluge.common.windows_check">windows_check() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
|
||||
</dl></td></tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
|
||||
|
||||
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
142
docs/build/html/index.html
vendored
142
docs/build/html/index.html
vendored
|
|
@ -1,142 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Welcome to Deluge’s documentation! — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="" />
|
||||
<link rel="next" title="The Deluge Core" href="core/index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="core/index.html" title="The Deluge Core"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li><a href="">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="welcome-to-deluge-s-documentation">
|
||||
<h1>Welcome to Deluge’s documentation!<a class="headerlink" href="#welcome-to-deluge-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contents:</p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="core/index.html">Core</a><ul>
|
||||
<li class="toctree-l2"><a class="reference external" href="core/rpc.html">DelugeRPC</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference external" href="interfaces/index.html">Interfaces</a><ul>
|
||||
<li class="toctree-l2"><a class="reference external" href="interfaces/gtk.html">Gtk Interface</a></li>
|
||||
<li class="toctree-l2"><a class="reference external" href="interfaces/web.html">Web Interface</a></li>
|
||||
<li class="toctree-l2"><a class="reference external" href="interfaces/console.html">Console Interface</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
|
||||
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
|
||||
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="modules">
|
||||
<h1>Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h1>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="modules/common.html"><tt class="docutils literal"><span class="pre">deluge.common</span></tt></a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="modules/config.html"><tt class="docutils literal"><span class="pre">deluge.config</span></tt></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="">Welcome to Deluge’s documentation!</a><ul>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
|
||||
<li><a class="reference external" href="#modules">Modules</a><ul>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="core/index.html"
|
||||
title="next chapter">The Deluge Core</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="core/index.html" title="The Deluge Core"
|
||||
>next</a> |</li>
|
||||
<li><a href="">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
116
docs/build/html/interfaces/console.html
vendored
116
docs/build/html/interfaces/console.html
vendored
|
|
@ -1,116 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Deluge Console UI — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="up" title="Deluge’s Interfaces" href="index.html" />
|
||||
<link rel="next" title="deluge.common" href="../modules/common.html" />
|
||||
<link rel="prev" title="Deluge Web UI" href="web.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../modules/common.html" title="deluge.common"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="web.html" title="Deluge Web UI"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" accesskey="U">Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="deluge-console-ui">
|
||||
<h1>Deluge Console UI<a class="headerlink" href="#deluge-console-ui" title="Permalink to this headline">¶</a></h1>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="web.html"
|
||||
title="previous chapter">Deluge Web UI</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../modules/common.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">deluge.common</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/interfaces/console.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../modules/common.html" title="deluge.common"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="web.html" title="Deluge Web UI"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" >Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
116
docs/build/html/interfaces/gtk.html
vendored
116
docs/build/html/interfaces/gtk.html
vendored
|
|
@ -1,116 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Deluge GTK UI — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="up" title="Deluge’s Interfaces" href="index.html" />
|
||||
<link rel="next" title="Deluge Web UI" href="web.html" />
|
||||
<link rel="prev" title="Deluge’s Interfaces" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="web.html" title="Deluge Web UI"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Deluge’s Interfaces"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" accesskey="U">Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="deluge-gtk-ui">
|
||||
<h1>Deluge GTK UI<a class="headerlink" href="#deluge-gtk-ui" title="Permalink to this headline">¶</a></h1>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">Deluge’s Interfaces</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="web.html"
|
||||
title="next chapter">Deluge Web UI</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/interfaces/gtk.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="web.html" title="Deluge Web UI"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Deluge’s Interfaces"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" >Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
122
docs/build/html/interfaces/index.html
vendored
122
docs/build/html/interfaces/index.html
vendored
|
|
@ -1,122 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Deluge’s Interfaces — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="next" title="Deluge GTK UI" href="gtk.html" />
|
||||
<link rel="prev" title="Deluge RPC" href="../core/rpc.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gtk.html" title="Deluge GTK UI"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../core/rpc.html" title="Deluge RPC"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="deluge-s-interfaces">
|
||||
<h1>Deluge’s Interfaces<a class="headerlink" href="#deluge-s-interfaces" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Interfaces.</p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="gtk.html">Gtk Interface</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="web.html">Web Interface</a><ul>
|
||||
<li class="toctree-l2"><a class="reference external" href="web.html#ssl-configuration">SSL Configuration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference external" href="console.html">Console Interface</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../core/rpc.html"
|
||||
title="previous chapter">Deluge RPC</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="gtk.html"
|
||||
title="next chapter">Deluge GTK UI</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/interfaces/index.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gtk.html" title="Deluge GTK UI"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../core/rpc.html" title="Deluge RPC"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
137
docs/build/html/interfaces/web.html
vendored
137
docs/build/html/interfaces/web.html
vendored
|
|
@ -1,137 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Deluge Web UI — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="up" title="Deluge’s Interfaces" href="index.html" />
|
||||
<link rel="next" title="Deluge Console UI" href="console.html" />
|
||||
<link rel="prev" title="Deluge GTK UI" href="gtk.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="console.html" title="Deluge Console UI"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gtk.html" title="Deluge GTK UI"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" accesskey="U">Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="deluge-web-ui">
|
||||
<h1>Deluge Web UI<a class="headerlink" href="#deluge-web-ui" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The Deluge web interface is intended to be a full featured interface built using
|
||||
the ExtJS framework, running on top of a Twisted webserver.</p>
|
||||
<div class="section" id="ssl-configuration">
|
||||
<h2>SSL Configuration<a class="headerlink" href="#ssl-configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default the web interface will use the same private key and certificate as
|
||||
the Deluge daemon. If you wish to use a different certificate/key (see
|
||||
<a class="reference external" href="http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/">How to Create a SSL Certificate</a>
|
||||
for information on creating one) you are able to specify which you want to use.</p>
|
||||
<p>There are 2 ways to enable SSL encryption in the webserver, 1 is to specify it
|
||||
in your configuration (accessible via the Preferences window). The other is to
|
||||
add ‘–ssl’ when running the webserver, which will override the configuration
|
||||
value and enable SSL.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference external" href="">Deluge Web UI</a><ul>
|
||||
<li><a class="reference external" href="#ssl-configuration">SSL Configuration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="gtk.html"
|
||||
title="previous chapter">Deluge GTK UI</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="console.html"
|
||||
title="next chapter">Deluge Console UI</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/interfaces/web.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="console.html" title="Deluge Console UI"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gtk.html" title="Deluge GTK UI"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
<li><a href="index.html" >Deluge’s Interfaces</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
109
docs/build/html/modindex.html
vendored
109
docs/build/html/modindex.html
vendored
|
|
@ -1,109 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Global Module Index — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
|
||||
<h1 id="global-module-index">Global Module Index</h1>
|
||||
<a href="#cap-D"><strong>D</strong></a>
|
||||
<hr/>
|
||||
|
||||
<table width="100%" class="indextable" cellspacing="0" cellpadding="2"><tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap"><td></td><td><a name="cap-D"><strong>D</strong></a></td><td></td></tr><tr>
|
||||
<td><img src="_static/minus.png" id="toggle-1"
|
||||
class="toggler" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<tt class="xref">deluge</tt></td><td>
|
||||
<em></em></td></tr><tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="modules/common.html#module-deluge.common"><tt class="xref">deluge.common</tt></a></td><td>
|
||||
<em></em></td></tr><tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="modules/config.html#module-deluge.config"><tt class="xref">deluge.config</tt></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
561
docs/build/html/modules/common.html
vendored
561
docs/build/html/modules/common.html
vendored
|
|
@ -1,561 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>deluge.common — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="next" title="deluge.config" href="config.html" />
|
||||
<link rel="prev" title="Deluge Console UI" href="../interfaces/console.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="config.html" title="deluge.config"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../interfaces/console.html" title="Deluge Console UI"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-deluge.common">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">deluge.common</span></tt><a class="headerlink" href="#module-deluge.common" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Common functions for various parts of Deluge to use.</p>
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.create_magnet_uri">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">create_magnet_uri</tt><big>(</big><em>infohash</em>, <em>name=None</em>, <em>trackers=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#deluge.common.create_magnet_uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a magnet uri</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>infohash</em> – string, the info-hash of the torrent</li>
|
||||
<li><em>name</em> – string, the name of the torrent (optional)</li>
|
||||
<li><em>trackers</em> – list of strings, the trackers to announce to (optional)</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a magnet uri string</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fdate">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fdate</tt><big>(</big><em>seconds</em><big>)</big><a class="headerlink" href="#deluge.common.fdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats a date string in the locale’s date representation based on the systems timezone</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>seconds</em> – float, time in seconds since the Epoch</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a string in the locale’s date representation or “” if seconds < 0</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fetch_url">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fetch_url</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#deluge.common.fetch_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Downloads a torrent file from a given URL and checks the file’s validity</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>url</em> – string, the url of the .torrent file to fetch</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the filepath to the downloaded file</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fpcnt">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fpcnt</tt><big>(</big><em>dec</em><big>)</big><a class="headerlink" href="#deluge.common.fpcnt" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats a string to display a percentage with two decimal places</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>dec</em> – float, the ratio in the range [0.0, 1.0]</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a formatted string representing a percentage</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fpcnt</span><span class="p">(</span><span class="mf">0.9311</span><span class="p">)</span>
|
||||
<span class="go">'93.11%'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fpeer">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fpeer</tt><big>(</big><em>num_peers</em>, <em>total_peers</em><big>)</big><a class="headerlink" href="#deluge.common.fpeer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats a string to show ‘num_peers’ (‘total_peers’)</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>num_peers</em> – int, the number of connected peers</li>
|
||||
<li><em>total_peers</em> – int, the total number of peers</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a formatted string: num_peers (total_peers), if total_peers < 0, then it will not be shown</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fpeer</span><span class="p">(</span><span class="mf">10</span><span class="p">,</span> <span class="mf">20</span><span class="p">)</span>
|
||||
<span class="go">'10 (20)'</span>
|
||||
<span class="gp">>>> </span><span class="n">fpeer</span><span class="p">(</span><span class="mf">10</span><span class="p">,</span> <span class="o">-</span><span class="mf">1</span><span class="p">)</span>
|
||||
<span class="go">'10'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.free_space">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">free_space</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#deluge.common.free_space" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the free space available at ‘path’</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>path</em> – string, the path to check</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the free space at path in bytes</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fsize">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fsize</tt><big>(</big><em>fsize_b</em><big>)</big><a class="headerlink" href="#deluge.common.fsize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats the bytes value into a string with KiB, MiB or GiB units</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>fsize_b</em> – int, the filesize in bytes</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">formatted string in KiB, MiB or GiB units</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fsize</span><span class="p">(</span><span class="mf">112245</span><span class="p">)</span>
|
||||
<span class="go">'109.6 KiB'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.fspeed">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">fspeed</tt><big>(</big><em>bps</em><big>)</big><a class="headerlink" href="#deluge.common.fspeed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats a string to display a transfer speed utilizing <a title="deluge.common.fsize" class="reference internal" href="#deluge.common.fsize"><tt class="xref docutils literal"><span class="pre">fsize()</span></tt></a></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>bps</em> – int, bytes per second</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a formatted string representing transfer speed</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">fspeed</span><span class="p">(</span><span class="mf">43134</span><span class="p">)</span>
|
||||
<span class="go">'42.1 KiB/s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.ftime">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">ftime</tt><big>(</big><em>seconds</em><big>)</big><a class="headerlink" href="#deluge.common.ftime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats a string to show time in a human readable form</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>seconds</em> – int, the number of seconds</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a formatted time string, will return ‘’ if seconds == 0</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">ftime</span><span class="p">(</span><span class="mf">23011</span><span class="p">)</span>
|
||||
<span class="go">'6h 23m'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_default_config_dir">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_default_config_dir</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#deluge.common.get_default_config_dir" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>filename</em> – if None, only the config path is returned, if provided, a path including the filename will be returned</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a file path to the config directory and optional filename</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_default_download_dir">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_default_download_dir</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.get_default_download_dir" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the default download directory</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_path_size">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_path_size</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#deluge.common.get_path_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the size in bytes of ‘path’</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>path</em> – string, the path to check for size</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the size in bytes of the path or -1 if the path does not exist</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">int</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_pixmap">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_pixmap</tt><big>(</big><em>fname</em><big>)</big><a class="headerlink" href="#deluge.common.get_pixmap" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Provides easy access to files in the deluge/data/pixmaps folder within the Deluge egg</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>fname</em> – the filename to look for</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a path to a pixmap file included with Deluge</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_revision">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_revision</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.get_revision" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The svn revision of the build if available</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the svn revision, or “”</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.get_version">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">get_version</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.get_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the program version from the egg metadata</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the version of Deluge</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.is_ip">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">is_ip</tt><big>(</big><em>ip</em><big>)</big><a class="headerlink" href="#deluge.common.is_ip" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A simple test to see if ‘ip’ is valid</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>ip</em> – string, the ip to check</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>** Usage **</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">is_ip</span><span class="p">(</span><span class="s">"127.0.0.1"</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.is_magnet">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">is_magnet</tt><big>(</big><em>uri</em><big>)</big><a class="headerlink" href="#deluge.common.is_magnet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A check to determine if a uri is a valid bittorrent magnet uri</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>uri</em> – string, the uri to check</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">is_magnet</span><span class="p">(</span><span class="s">"magnet:?xt=urn:btih:SU5225URMTUEQLDXQWRB2EQWN6KLTYKN"</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.is_url">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">is_url</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#deluge.common.is_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A simple regex test to check if the URL is valid</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>url</em> – string, the url to test</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">is_url</span><span class="p">(</span><span class="s">"http://deluge-torrent.org"</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.open_file">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">open_file</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#deluge.common.open_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Opens a file or folder using the system configured program</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>path</em> – the path to the file or folder to open</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.open_url_in_browser">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">open_url_in_browser</tt><big>(</big><em>url</em><big>)</big><a class="headerlink" href="#deluge.common.open_url_in_browser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Opens a url in the desktop’s default browser</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>url</em> – the url to open</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.osx_check">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">osx_check</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.osx_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks if the current platform is Mac OS X</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.vista_check">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">vista_check</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.vista_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks if the current platform is Windows Vista</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="deluge.common.windows_check">
|
||||
<tt class="descclassname">deluge.common.</tt><tt class="descname">windows_check</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.common.windows_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks if the current platform is Windows</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True or False</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../interfaces/console.html"
|
||||
title="previous chapter">Deluge Console UI</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="config.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">deluge.config</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/common.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="config.html" title="deluge.config"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../interfaces/console.html" title="Deluge Console UI"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
360
docs/build/html/modules/config.html
vendored
360
docs/build/html/modules/config.html
vendored
|
|
@ -1,360 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>deluge.config — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="../index.html" />
|
||||
<link rel="prev" title="deluge.common" href="common.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="common.html" title="deluge.common"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-deluge.config">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">deluge.config</span></tt><a class="headerlink" href="#module-deluge.config" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Deluge Config Module</p>
|
||||
<p>This module is used for loading and saving of configuration files.. or anything
|
||||
really.</p>
|
||||
<p>The format of the config file is as follows:</p>
|
||||
<p><format version as int>
|
||||
<config file version as int>
|
||||
<content></p>
|
||||
<p>The format version is controlled by the Config class. It should only be changed
|
||||
when anything below it is changed directly by the Config class. An example of
|
||||
this would be if we changed the serializer for the content to something different.</p>
|
||||
<p>The config file version is changed by the ‘owner’ of the config file. This is
|
||||
to signify that there is a change in the naming of some config keys or something
|
||||
similar along those lines.</p>
|
||||
<p>The content is simply the dict to be saved and will be serialized before being
|
||||
written.</p>
|
||||
<p>Converting</p>
|
||||
<p>Since the format of the config could change, there needs to be a way to have
|
||||
the Config object convert to newer formats. To do this, you will need to
|
||||
register conversion functions for various versions of the config file. Note that
|
||||
this can only be done for the ‘config file version’ and not for the ‘format’
|
||||
version as this will be done internally.</p>
|
||||
<dl class="class">
|
||||
<dt id="deluge.config.Config">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">deluge.config.</tt><tt class="descname">Config</tt><big>(</big><em>filename</em>, <em>defaults=None</em>, <em>config_dir=None</em><big>)</big><a class="headerlink" href="#deluge.config.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <tt class="xref docutils literal"><span class="pre">object</span></tt></p>
|
||||
<p>This class is used to access/create/modify config files</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><em>filename</em> – the name of the config file</li>
|
||||
<li><em>defaults</em> – dictionary of default values</li>
|
||||
<li><em>config_dir</em> – the path to the config directory</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.__setitem__">
|
||||
<tt class="descname">__setitem__</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.config.Config.__setitem__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>See
|
||||
<a title="deluge.config.Config.set_item" class="reference internal" href="#deluge.config.Config.set_item"><tt class="xref docutils literal"><span class="pre">set_item()</span></tt></a></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.__getitem__">
|
||||
<tt class="descname">__getitem__</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#deluge.config.Config.__getitem__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>See
|
||||
<a title="deluge.config.Config.get_item" class="reference internal" href="#deluge.config.Config.get_item"><tt class="xref docutils literal"><span class="pre">get_item()</span></tt></a></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.apply_all">
|
||||
<tt class="descname">apply_all</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge.config.Config.apply_all" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calls all set functions</p>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="s">"test.conf"</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="p">{</span><span class="s">"test"</span><span class="p">:</span> <span class="mf">5</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||
<span class="gp">... </span> <span class="k">print</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">register_set_function</span><span class="p">(</span><span class="s">"test"</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">apply_now</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">apply_all</span><span class="p">()</span>
|
||||
<span class="go">test 5</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.apply_set_functions">
|
||||
<tt class="descname">apply_set_functions</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#deluge.config.Config.apply_set_functions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calls set functions for <cite>:param:key</cite>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>key</em> – str, the config key</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="deluge.config.Config.config">
|
||||
<tt class="descname">config</tt><a class="headerlink" href="#deluge.config.Config.config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>The config dictionary</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="deluge.config.Config.config_file">
|
||||
<tt class="descname">config_file</tt><a class="headerlink" href="#deluge.config.Config.config_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.get_item">
|
||||
<tt class="descname">get_item</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#deluge.config.Config.get_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the value of item ‘key’</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>key</em> – the item for which you want it’s value</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of item ‘key’</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name" colspan="2">Raises KeyError:</th></tr>
|
||||
<tr><td> </td><td class="field-body">if ‘key’ is not in the config dictionary</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="s">"test.conf"</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="p">{</span><span class="s">"test"</span><span class="p">:</span> <span class="mf">5</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="p">[</span><span class="s">"test"</span><span class="p">]</span>
|
||||
<span class="go">5</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.load">
|
||||
<tt class="descname">load</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#deluge.config.Config.load" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load a config file</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>filename</em> – if None, uses filename set in object initialization</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.register_change_callback">
|
||||
<tt class="descname">register_change_callback</tt><big>(</big><em>callback</em><big>)</big><a class="headerlink" href="#deluge.config.Config.register_change_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Registers a callback function that will be called when a value is changed in the config dictionary</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>callback</em> – the function, callback(key, value)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="s">"test.conf"</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="p">{</span><span class="s">"test"</span><span class="p">:</span> <span class="mf">5</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||
<span class="gp">... </span> <span class="k">print</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">register_change_callback</span><span class="p">(</span><span class="n">cb</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.register_set_function">
|
||||
<tt class="descname">register_set_function</tt><big>(</big><em>key</em>, <em>function</em>, <em>apply_now=True</em><big>)</big><a class="headerlink" href="#deluge.config.Config.register_set_function" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Register a function to be called when a config value changes</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><em>key</em> – the item to monitor for change</li>
|
||||
<li><em>function</em> – the function to call when the value changes, f(key, value)</li>
|
||||
<li><em>apply_now</em> – if True, the function will be called after it’s registered</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="s">"test.conf"</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="p">{</span><span class="s">"test"</span><span class="p">:</span> <span class="mf">5</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">cb</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||
<span class="gp">... </span> <span class="k">print</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">register_set_function</span><span class="p">(</span><span class="s">"test"</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="n">apply_now</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="go">test 5</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.run_converter">
|
||||
<tt class="descname">run_converter</tt><big>(</big><em>input_range</em>, <em>output_version</em>, <em>func</em><big>)</big><a class="headerlink" href="#deluge.config.Config.run_converter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Runs a function that will convert file versions in the <cite>:param:input_range</cite>
|
||||
to the <cite>:param:output_version</cite>.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>input_range</em> – tuple, (int, int) the range of input versions this
|
||||
function will accept</li>
|
||||
<li><em>output_version</em> – int, the version this function will return</li>
|
||||
<li><em>func</em> – func, the function that will do the conversion, it will take
|
||||
the config dict as an argument and return the augmented dict</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
|
||||
<tr><td> </td><td class="field-body"><p class="first last">if the output_version is less than the input_range</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.save">
|
||||
<tt class="descname">save</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#deluge.config.Config.save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Save configuration to disk</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>filename</em> – if None, uses filename set in object initiliazation</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Rtype bool:</th><td class="field-body"></td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">whether or not the save succeeded.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="deluge.config.Config.set_item">
|
||||
<tt class="descname">set_item</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge.config.Config.set_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets item ‘key’ to ‘value’ in the config dictionary, but does not allow
|
||||
changing the item’s type unless it is None</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><em>key</em> – string, item to change to change</li>
|
||||
<li><em>value</em> – the value to change item to, must be same type as what is currently in the config</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
|
||||
<tr><td> </td><td class="field-body"><p class="first last">raised when the type of value is not the same as what is currently in the config</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Usage</strong></p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="s">"test.conf"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="p">[</span><span class="s">"test"</span><span class="p">]</span> <span class="o">=</span> <span class="mf">5</span>
|
||||
<span class="gp">>>> </span><span class="n">config</span><span class="p">[</span><span class="s">"test"</span><span class="p">]</span>
|
||||
<span class="go">5</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="common.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">deluge.common</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/config.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="common.html" title="deluge.common"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
93
docs/build/html/objects.inv
vendored
93
docs/build/html/objects.inv
vendored
|
|
@ -1,93 +0,0 @@
|
|||
# Sphinx inventory version 1
|
||||
# Project: Deluge
|
||||
# Version: 1.2.0-dev
|
||||
deluge.config mod modules/config.html
|
||||
deluge.common mod modules/common.html
|
||||
deluge.config.Config.apply_all method modules/config.html
|
||||
deluge.config.Config.__getitem__ method modules/config.html
|
||||
deluge.config.Config.__setitem__ method modules/config.html
|
||||
deluge.core.core.Core.set_torrent_move_completed_path method core/rpc.html
|
||||
deluge.core.core.Core.get_config_values method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_trackers method core/rpc.html
|
||||
deluge.core.core.Core.upload_plugin method core/rpc.html
|
||||
deluge.config.Config.get_item method modules/config.html
|
||||
deluge.config.Config.register_set_function method modules/config.html
|
||||
deluge.common.free_space function modules/common.html
|
||||
deluge.core.core.Core.add_torrent_file method core/rpc.html
|
||||
deluge.core.core.Core.add_torrent_magnet method core/rpc.html
|
||||
deluge.core.daemon.Daemon.get_method_list method core/rpc.html
|
||||
deluge.core.core.Core.rescan_plugins method core/rpc.html
|
||||
deluge.common.open_file function modules/common.html
|
||||
deluge.core.core.Core.get_health method core/rpc.html
|
||||
deluge.core.core.Core.get_torrents_status method core/rpc.html
|
||||
deluge.core.core.Core.save_dht_state method core/rpc.html
|
||||
deluge.common.is_url function modules/common.html
|
||||
deluge.core.core.Core.get_num_connections method core/rpc.html
|
||||
deluge.core.daemon.Daemon class core/rpc.html
|
||||
deluge.core.core.Core.get_path_size method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_options method core/rpc.html
|
||||
deluge.config.Config.register_change_callback method modules/config.html
|
||||
deluge.core.core.Core.test_listen_port method core/rpc.html
|
||||
deluge.config.Config.config attribute modules/config.html
|
||||
deluge.core.core.Core.set_torrent_max_upload_speed method core/rpc.html
|
||||
deluge.config.Config.save method modules/config.html
|
||||
deluge.config.Config.apply_set_functions method modules/config.html
|
||||
deluge.core.core.Core.set_torrent_move_completed method core/rpc.html
|
||||
deluge.common.is_magnet function modules/common.html
|
||||
deluge.common.fpeer function modules/common.html
|
||||
deluge.core.core.Core.get_upload_rate method core/rpc.html
|
||||
deluge.config.Config.load method modules/config.html
|
||||
deluge.common.create_magnet_uri function modules/common.html
|
||||
deluge.core.core.Core.get_config_value method core/rpc.html
|
||||
deluge.common.get_path_size function modules/common.html
|
||||
deluge.common.vista_check function modules/common.html
|
||||
deluge.core.core.Core.set_torrent_auto_managed method core/rpc.html
|
||||
deluge.core.core.Core.get_dht_nodes method core/rpc.html
|
||||
deluge.core.core.Core.get_status_keys method core/rpc.html
|
||||
deluge.common.fsize function modules/common.html
|
||||
deluge.core.core.Core.get_download_rate method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_stop_at_ratio method core/rpc.html
|
||||
deluge.core.core.Core.get_cache_status method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_remove_at_ratio method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_max_upload_slots method core/rpc.html
|
||||
deluge.core.core.Core.get_config method core/rpc.html
|
||||
deluge.common.is_ip function modules/common.html
|
||||
deluge.core.core.Core.set_torrent_prioritize_first_last method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_max_download_speed method core/rpc.html
|
||||
deluge.core.core.Core.get_available_plugins method core/rpc.html
|
||||
deluge.core.core.Core.get_listen_port method core/rpc.html
|
||||
deluge.core.core.Core.resume_all_torrents method core/rpc.html
|
||||
deluge.common.ftime function modules/common.html
|
||||
deluge.core.core.Core.set_config method core/rpc.html
|
||||
deluge.config.Config.config_file attribute modules/config.html
|
||||
deluge.core.core.Core.get_filter_tree method core/rpc.html
|
||||
deluge.common.get_default_config_dir function modules/common.html
|
||||
deluge.common.open_url_in_browser function modules/common.html
|
||||
deluge.core.core.Core.pause_all_torrents method core/rpc.html
|
||||
deluge.core.core.Core class core/rpc.html
|
||||
deluge.common.fpcnt function modules/common.html
|
||||
deluge.core.core.Core.force_recheck method core/rpc.html
|
||||
deluge.core.core.Core.add_torrent_url method core/rpc.html
|
||||
deluge.core.core.Core.get_session_state method core/rpc.html
|
||||
deluge.common.fspeed function modules/common.html
|
||||
deluge.core.core.Core.get_enabled_plugins method core/rpc.html
|
||||
deluge.config.Config.run_converter method modules/config.html
|
||||
deluge.core.core.Core.rename_files method core/rpc.html
|
||||
deluge.common.get_version function modules/common.html
|
||||
deluge.core.core.Core.get_stats method core/rpc.html
|
||||
deluge.core.core.Core.rename_folder method core/rpc.html
|
||||
deluge.common.get_revision function modules/common.html
|
||||
deluge.common.fdate function modules/common.html
|
||||
deluge.core.core.Core.set_torrent_max_connections method core/rpc.html
|
||||
deluge.common.get_pixmap function modules/common.html
|
||||
deluge.common.fetch_url function modules/common.html
|
||||
deluge.core.core.Core.set_torrent_file_priorities method core/rpc.html
|
||||
deluge.common.get_default_download_dir function modules/common.html
|
||||
deluge.common.osx_check function modules/common.html
|
||||
deluge.config.Config class modules/config.html
|
||||
deluge.config.Config.set_item method modules/config.html
|
||||
deluge.common.windows_check function modules/common.html
|
||||
deluge.core.daemon.Daemon.info method core/rpc.html
|
||||
deluge.core.core.Core.set_torrent_stop_ratio method core/rpc.html
|
||||
deluge.core.core.Core.start method core/rpc.html
|
||||
deluge.core.core.Core.get_session_status method core/rpc.html
|
||||
98
docs/build/html/search.html
vendored
98
docs/build/html/search.html
vendored
|
|
@ -1,98 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — Deluge v1.2.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '1.2.0-dev',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="Deluge v1.2.0-dev documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<h1 id="search-documentation">Search</h1>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<script type="text/javascript">$('#fallback').hide();</script>
|
||||
<p>
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
</p>
|
||||
</div>
|
||||
<p>
|
||||
From here you can search these documents. Enter your search
|
||||
words into the box below and click "search". Note that the search
|
||||
function will automatically search for all of the words. Pages
|
||||
containing fewer words won't appear in the result list.
|
||||
</p>
|
||||
<form action="" method="get">
|
||||
<input type="text" name="q" value="" />
|
||||
<input type="submit" value="search" />
|
||||
<span id="search-progress" style="padding-left: 10px"></span>
|
||||
</form>
|
||||
|
||||
<div id="search-results">
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li><a href="index.html">Deluge v1.2.0-dev documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2008, Andrew Resch.
|
||||
Last updated on Jul 22, 2009.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
<script type="text/javascript" src="searchindex.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1
docs/build/html/searchindex.js
vendored
1
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
|
|
@ -101,7 +101,5 @@ daemon's state that the clients need to be made aware of.
|
|||
Remote API
|
||||
----------
|
||||
|
||||
.. autoclass:: deluge.core.core.Core
|
||||
:members:
|
||||
.. autoclass:: deluge.core.daemon.Daemon
|
||||
.. autoclass:: deluge.__rpcapi.RpcApi
|
||||
:members:
|
||||
Loading…
Add table
Reference in a new issue