Deluge
diff options
| author | Damien Churchill <damoc@gmail.com> | 2009-07-20 09:36:16 +0000 |
|---|---|---|
| committer | Damien Churchill <damoc@gmail.com> | 2009-07-20 09:36:16 +0000 |
| commit | 3c74a8e4bf6a7a5471e238bebc8bd6383733e6ee (patch) | |
| tree | b0b76c83c76f021f61512b456937c683cdb365a8 /docs | |
| parent | 8bb70f1671f0dc0966b312956745219b47f94a5b (diff) | |
| download | deluge-3c74a8e4bf6a7a5471e238bebc8bd6383733e6ee.tar.gz deluge-3c74a8e4bf6a7a5471e238bebc8bd6383733e6ee.tar.bz2 deluge-3c74a8e4bf6a7a5471e238bebc8bd6383733e6ee.zip | |
update the docs, creating a simple structure for user orientated documentation
Diffstat (limited to 'docs')
33 files changed, 741 insertions, 53 deletions
diff --git a/docs/build/doctrees/core/index.doctree b/docs/build/doctrees/core/index.doctree Binary files differnew file mode 100644 index 000000000..d935f89a7 --- /dev/null +++ b/docs/build/doctrees/core/index.doctree diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle Binary files differindex cffc3d39f..ca33f75b2 100644 --- a/docs/build/doctrees/environment.pickle +++ b/docs/build/doctrees/environment.pickle diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree Binary files differindex 9ed4fbb2f..a63b60367 100644 --- a/docs/build/doctrees/index.doctree +++ b/docs/build/doctrees/index.doctree diff --git a/docs/build/doctrees/interfaces/console.doctree b/docs/build/doctrees/interfaces/console.doctree Binary files differnew file mode 100644 index 000000000..fb36f49d7 --- /dev/null +++ b/docs/build/doctrees/interfaces/console.doctree diff --git a/docs/build/doctrees/interfaces/gtk.doctree b/docs/build/doctrees/interfaces/gtk.doctree Binary files differnew file mode 100644 index 000000000..7a018c1f2 --- /dev/null +++ b/docs/build/doctrees/interfaces/gtk.doctree diff --git a/docs/build/doctrees/interfaces/index.doctree b/docs/build/doctrees/interfaces/index.doctree Binary files differnew file mode 100644 index 000000000..96ca5f80f --- /dev/null +++ b/docs/build/doctrees/interfaces/index.doctree diff --git a/docs/build/doctrees/interfaces/web.doctree b/docs/build/doctrees/interfaces/web.doctree Binary files differnew file mode 100644 index 000000000..4cd6c4f68 --- /dev/null +++ b/docs/build/doctrees/interfaces/web.doctree diff --git a/docs/build/html/_sources/core/index.txt b/docs/build/html/_sources/core/index.txt new file mode 100644 index 000000000..f276a1b2d --- /dev/null +++ b/docs/build/html/_sources/core/index.txt @@ -0,0 +1,2 @@ +The Deluge Core +===============
\ No newline at end of file diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt index 1e4d84e3c..2feba1fed 100644 --- a/docs/build/html/_sources/index.txt +++ b/docs/build/html/_sources/index.txt @@ -2,13 +2,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to deluge's documentation! +Welcome to Deluge's documentation! ================================== Contents: .. toctree:: :maxdepth: 2 + + Core <core/index.rst> + Interfaces <interfaces/index.rst> Indices and tables ================== diff --git a/docs/build/html/_sources/interfaces/console.txt b/docs/build/html/_sources/interfaces/console.txt new file mode 100644 index 000000000..5781ee262 --- /dev/null +++ b/docs/build/html/_sources/interfaces/console.txt @@ -0,0 +1,2 @@ +Deluge Console UI +=================
\ No newline at end of file diff --git a/docs/build/html/_sources/interfaces/gtk.txt b/docs/build/html/_sources/interfaces/gtk.txt new file mode 100644 index 000000000..51bd946ca --- /dev/null +++ b/docs/build/html/_sources/interfaces/gtk.txt @@ -0,0 +1,2 @@ +Deluge GTK UI +=============
\ No newline at end of file diff --git a/docs/build/html/_sources/interfaces/index.txt b/docs/build/html/_sources/interfaces/index.txt new file mode 100644 index 000000000..6ac5469bb --- /dev/null +++ b/docs/build/html/_sources/interfaces/index.txt @@ -0,0 +1,10 @@ +Deluge's Interfaces +=================== + +Interfaces. + +.. toctree:: + + Gtk Interface <gtk> + Web Interface <web> + Console Interface <console>
\ No newline at end of file diff --git a/docs/build/html/_sources/interfaces/web.txt b/docs/build/html/_sources/interfaces/web.txt new file mode 100644 index 000000000..b3ac197d9 --- /dev/null +++ b/docs/build/html/_sources/interfaces/web.txt @@ -0,0 +1,19 @@ +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.
\ No newline at end of file diff --git a/docs/build/html/core/index.html b/docs/build/html/core/index.html new file mode 100644 index 000000000..c3a84fa7e --- /dev/null +++ b/docs/build/html/core/index.html @@ -0,0 +1,113 @@ +<!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’s Interfaces" href="../interfaces/index.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="../interfaces/index.html" title="Deluge’s Interfaces" + 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> +</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="../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/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="../interfaces/index.html" title="Deluge’s Interfaces" + >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 20, 2009. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1. + </div> + </body> +</html>
\ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index ab1cd8a1f..1d5d496ee 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Index — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -19,7 +19,7 @@ </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.1.0 documentation" href="index.html" /> + <link rel="top" title="deluge v1.2.0-dev documentation" href="index.html" /> </head> <body> <div class="related"> @@ -31,7 +31,7 @@ <li class="right" > <a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -201,7 +201,7 @@ <li class="right" > <a href="modindex.html" title="Global Module Index" >modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 67090c200..72ae79c2e 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Welcome to deluge’s documentation! — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -19,8 +19,8 @@ </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.1.0 documentation" href="" /> - <link rel="next" title="deluge.common" href="modules/common.html" /> + <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"> @@ -33,9 +33,9 @@ <a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > - <a href="modules/common.html" title="deluge.common" + <a href="core/index.html" title="The Deluge Core" accesskey="N">next</a> |</li> - <li><a href="">deluge v1.1.0 documentation</a> »</li> + <li><a href="">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -45,9 +45,16 @@ <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> +<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 class="simple"> +<ul> +<li class="toctree-l1"><a class="reference external" href="core/index.html">Core</a></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"> @@ -74,7 +81,7 @@ <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> +<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> @@ -84,8 +91,8 @@ </ul> <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> + <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" @@ -118,9 +125,9 @@ <a href="modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > - <a href="modules/common.html" title="deluge.common" + <a href="core/index.html" title="The Deluge Core" >next</a> |</li> - <li><a href="">deluge v1.1.0 documentation</a> »</li> + <li><a href="">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/interfaces/console.html b/docs/build/html/interfaces/console.html new file mode 100644 index 000000000..452f291aa --- /dev/null +++ b/docs/build/html/interfaces/console.html @@ -0,0 +1,116 @@ +<!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 20, 2009. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1. + </div> + </body> +</html>
\ No newline at end of file diff --git a/docs/build/html/interfaces/gtk.html b/docs/build/html/interfaces/gtk.html new file mode 100644 index 000000000..12225858f --- /dev/null +++ b/docs/build/html/interfaces/gtk.html @@ -0,0 +1,116 @@ +<!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 20, 2009. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1. + </div> + </body> +</html>
\ No newline at end of file diff --git a/docs/build/html/interfaces/index.html b/docs/build/html/interfaces/index.html new file mode 100644 index 000000000..6e4d88a29 --- /dev/null +++ b/docs/build/html/interfaces/index.html @@ -0,0 +1,122 @@ +<!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="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="gtk.html" title="Deluge GTK UI" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="../core/index.html" title="The Deluge Core" + 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/index.html" + title="previous chapter">The Deluge Core</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/index.html" title="The Deluge Core" + >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 20, 2009. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1. + </div> + </body> +</html>
\ No newline at end of file diff --git a/docs/build/html/interfaces/web.html b/docs/build/html/interfaces/web.html new file mode 100644 index 000000000..bb9538ca9 --- /dev/null +++ b/docs/build/html/interfaces/web.html @@ -0,0 +1,137 @@ +<!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 20, 2009. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1. + </div> + </body> +</html>
\ No newline at end of file diff --git a/docs/build/html/modindex.html b/docs/build/html/modindex.html index 4801f9487..d33167bbe 100644 --- a/docs/build/html/modindex.html +++ b/docs/build/html/modindex.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Global Module Index — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -19,7 +19,7 @@ </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.1.0 documentation" href="index.html" /> + <link rel="top" title="deluge v1.2.0-dev documentation" href="index.html" /> @@ -34,7 +34,7 @@ <li class="right" > <a href="" title="Global Module Index" accesskey="M">modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -97,7 +97,7 @@ <li class="right" > <a href="" title="Global Module Index" >modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/modules/common.html b/docs/build/html/modules/common.html index e9ce650e5..f5e07d189 100644 --- a/docs/build/html/modules/common.html +++ b/docs/build/html/modules/common.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>deluge.common — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -19,9 +19,9 @@ </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.1.0 documentation" href="../index.html" /> + <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="Welcome to deluge’s documentation!" href="../index.html" /> + <link rel="prev" title="Deluge Console UI" href="../interfaces/console.html" /> </head> <body> <div class="related"> @@ -37,9 +37,9 @@ <a href="config.html" title="deluge.config" accesskey="N">next</a> |</li> <li class="right" > - <a href="../index.html" title="Welcome to deluge’s documentation!" + <a href="../interfaces/console.html" title="Deluge Console UI" accesskey="P">previous</a> |</li> - <li><a href="../index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="../index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -507,8 +507,8 @@ <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> + <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> @@ -547,9 +547,9 @@ <a href="config.html" title="deluge.config" >next</a> |</li> <li class="right" > - <a href="../index.html" title="Welcome to deluge’s documentation!" + <a href="../interfaces/console.html" title="Deluge Console UI" >previous</a> |</li> - <li><a href="../index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="../index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/modules/config.html b/docs/build/html/modules/config.html index 40c4c9e04..82017b7df 100644 --- a/docs/build/html/modules/config.html +++ b/docs/build/html/modules/config.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>deluge.config — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -19,7 +19,7 @@ </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.1.0 documentation" href="../index.html" /> + <link rel="top" title="deluge v1.2.0-dev documentation" href="../index.html" /> <link rel="prev" title="deluge.common" href="common.html" /> </head> <body> @@ -35,7 +35,7 @@ <li class="right" > <a href="common.html" title="deluge.common" accesskey="P">previous</a> |</li> - <li><a href="../index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="../index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -348,7 +348,7 @@ changing the item’s type unless it is None</p> <li class="right" > <a href="common.html" title="deluge.common" >previous</a> |</li> - <li><a href="../index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="../index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 1d46e3000..4f5136420 100644 --- a/docs/build/html/objects.inv +++ b/docs/build/html/objects.inv @@ -1,6 +1,6 @@ # Sphinx inventory version 1 # Project: deluge -# Version: 1.1.0 +# 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 @@ -10,14 +10,14 @@ deluge.config.Config.save method modules/config.html deluge.common.is_ip function modules/common.html deluge.config.Config.get_item method modules/config.html deluge.common.fsize function modules/common.html -deluge.common.ftime function modules/common.html +deluge.config.Config.register_set_function method modules/config.html deluge.common.free_space function modules/common.html deluge.config.Config.config_file attribute modules/config.html deluge.common.open_file function modules/common.html deluge.common.get_default_config_dir function modules/common.html deluge.common.open_url_in_browser function modules/common.html deluge.common.windows_check function modules/common.html -deluge.config.Config.register_set_function method modules/config.html +deluge.common.ftime function modules/common.html deluge.common.is_url function modules/common.html deluge.common.fpcnt function modules/common.html deluge.common.fspeed function modules/common.html @@ -28,9 +28,9 @@ deluge.config.Config.config attribute modules/config.html deluge.config.Config.apply_set_functions method modules/config.html deluge.common.get_revision function modules/common.html deluge.common.fdate function modules/common.html -deluge.common.get_pixmap function modules/common.html -deluge.common.fpeer function modules/common.html deluge.common.is_magnet function modules/common.html +deluge.common.fpeer function modules/common.html +deluge.common.get_pixmap function modules/common.html deluge.common.fetch_url function modules/common.html deluge.config.Config.load method modules/config.html deluge.common.create_magnet_uri function modules/common.html diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 362f8ee07..8fe6df5ba 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -5,13 +5,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Search — deluge v1.1.0 documentation</title> + <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.1.0', + VERSION: '1.2.0-dev', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -20,7 +20,7 @@ <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.1.0 documentation" href="index.html" /> + <link rel="top" title="deluge v1.2.0-dev documentation" href="index.html" /> </head> <body> <div class="related"> @@ -32,7 +32,7 @@ <li class="right" > <a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> @@ -83,7 +83,7 @@ <li class="right" > <a href="modindex.html" title="Global Module Index" >modules</a> |</li> - <li><a href="index.html">deluge v1.1.0 documentation</a> »</li> + <li><a href="index.html">deluge v1.2.0-dev documentation</a> »</li> </ul> </div> diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 0afcb1534..3a797cbb7 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({desctypes:{"0":"method","1":"function","2":"attribute","3":"class"},terms:{represent:2,all:1,config_fil:1,newer:1,get_pixmap:2,show:2,fsize:2,fpeer:2,human:2,config:[0,1,2],follow:1,disk:1,speed:2,paramet:[1,2],content:[0,1],onli:[1,2],btih:2,ratio:2,monitor:1,easi:2,call:1,decim:2,readabl:2,epoch:2,param:1,should:[0,1],platform:2,window:2,program:2,register_change_callback:1,bittorr:2,folder:2,save:1,local:2,build:2,file:[0,1,2],liter:[1,2],"return":[1,2],string:[1,2],variou:[1,2],format:[1,2],fals:[1,2],initi:1,util:2,total_p:2,nov:0,get_item:1,like:0,register_set_funct:1,name:[1,2],anyth:1,docutil:[1,2],list:2,magnet:2,"default":[1,2],common:[0,2],contain:0,urn:2,create_magnet_uri:2,fname:2,page:0,input_rang:1,num_peer:2,"float":2,some:1,direct:0,percentag:2,realli:1,fspeed:2,intern:1,signifi:1,connect:2,toctre:0,download:2,hash:2,config_dir:1,index:0,shown:2,announc:2,space:2,is_url:2,someth:1,fpcnt:2,per:2,your:0,access:[1,2],written:1,version:[1,2],ftime:2,adapt:0,print:1,get_default_config_dir:2,get:[1,2],output_vers:1,sphinx:0,metadata:2,object:1,run:1,kei:1,pixmap:2,usag:[1,2],given:2,free:2,"__setitem__":1,succeed:1,dictionari:1,peer:2,path:[1,2],"byte":2,modifi:1,tue:0,valu:[1,2],open_url_in_brows:2,search:0,convers:1,rtype:1,is_magnet:2,could:1,current:[1,2],http:2,fetch:2,base:[1,2],place:2,includ:2,osx_check:2,span:[1,2],desktop:2,chang:1,timezon:2,infohash:2,load:1,pre:[1,2],rang:[1,2],configur:[1,2],simpli:1,directli:1,modul:[0,1],within:2,number:2,root:0,system:2,filenam:[1,2],initiliaz:1,set:1,done:1,org:2,owner:1,total:2,open:2,along:1,unit:2,size:2,regex:2,differ:1,fetch_url:2,from:2,conf:1,would:1,transfer:2,regist:1,two:2,least:0,sinc:[1,2],avail:2,master:0,tracker:2,second:2,dict:1,type:[1,2],valueerror:1,gib:2,"function":[1,2],option:2,form:2,fsize_b:2,convert:1,vista_check:2,provid:2,part:2,indic:0,func:1,input:1,apply_al:1,line:1,"true":[1,2],than:1,those:1,must:1,info:2,none:[1,2],look:2,augment:1,whether:1,free_spac:2,delug:[0,1,2],windows_check:2,url:2,below:1,displai:2,can:[0,1],str:1,fdate:2,dec:2,similar:1,torrent:2,def:1,browser:2,control:1,files:2,quickstart:0,creat:[0,1,2],item:1,"int":[1,2],get_default_download_dir:2,argument:1,accept:1,repres:2,exist:2,have:1,tabl:0,need:1,revis:2,check:2,get_vers:2,vista:2,is_ip:2,"__getitem__":1,want:1,filepath:2,mib:2,when:1,same:1,get_revis:2,note:1,set_item:1,wai:1,bool:[1,2],take:1,which:1,tupl:1,test:[1,2],you:[0,1],document:0,simpl:2,complet:0,"23m":2,unless:1,determin:2,see:[1,2],less:1,after:1,what:1,keyerror:1,befor:1,mac:2,rais:1,apply_set_funct:1,thi:[0,1],date:2,kib:2,data:2,"class":[1,2],serial:1,welcom:0,svn:2,open_fil:2,run_convert:1,directori:[1,2],valid:2,uri:2,doe:[1,2],callback:1,exampl:1,su5225urmtueqldxqwrb2eqwn6kltykn:2,allow:1,time:2,apply_now:1,egg:2,get_path_s:2},titles:["Welcome to deluge’s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">deluge.config</span></tt>","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">deluge.common</span></tt>"],modules:{"deluge.config":1,"deluge.common":2},descrefs:{"deluge.common":{is_ip:[2,1],get_pixmap:[2,1],get_default_download_dir:[2,1],fspeed:[2,1],fpeer:[2,1],get_revision:[2,1],is_url:[2,1],vista_check:[2,1],fetch_url:[2,1],open_file:[2,1],get_version:[2,1],fsize:[2,1],ftime:[2,1],get_default_config_dir:[2,1],open_url_in_browser:[2,1],get_path_size:[2,1],free_space:[2,1],windows_check:[2,1],fpcnt:[2,1],osx_check:[2,1],fdate:[2,1],create_magnet_uri:[2,1],is_magnet:[2,1]},"deluge.config.Config":{apply_set_functions:[1,0],apply_all:[1,0],config_file:[1,2],"__getitem__":[1,0],run_converter:[1,0],set_item:[1,0],load:[1,0],"__setitem__":[1,0],register_change_callback:[1,0],register_set_function:[1,0],save:[1,0],config:[1,2],get_item:[1,0]},"deluge.config":{Config:[1,3]}},filenames:["index","modules/config","modules/common"]})
\ No newline at end of file +Search.setIndex({desctypes:{"0":"method","1":"function","2":"attribute","3":"class"},terms:{represent:7,all:1,mib:7,config_fil:1,func:1,get_pixmap:7,show:7,when:[1,4],overrid:4,fpeer:7,human:7,follow:1,disk:1,speed:7,paramet:[1,7],content:[0,1],onli:[1,7],ratio:7,monitor:1,easi:7,is_magnet:7,gtk:[0,6,3],readabl:7,set_item:1,param:1,should:[0,1],platform:7,window:[4,7],program:7,register_change_callback:1,bittorr:7,folder:7,save:1,local:7,take:1,liter:[1,7],"return":[1,7],string:[1,7],variou:[1,7],format:[1,7],fals:[1,7],initi:1,util:7,print:1,nov:0,get_item:1,like:0,daemon:4,register_set_funct:1,name:[1,7],anyth:1,docutil:[1,7],list:7,magnet:7,item:1,common:[0,7],have:1,contain:0,urn:7,create_magnet_uri:7,page:0,input_rang:1,certif:4,www:[],num_peer:7,some:1,direct:0,percentag:7,realli:1,fspeed:7,intern:1,signifi:1,connect:7,toctre:0,download:7,run:[1,4],simpl:7,config_dir:1,index:0,shown:7,total:7,space:7,is_url:7,someth:1,abl:4,below:1,per:7,your:[0,4],access:[1,4,7],written:1,version:[1,7],ftime:7,adapt:0,total_p:7,get_default_config_dir:7,output_vers:1,open_fil:7,metadata:7,core:[0,5],full:4,hash:7,kei:[1,4],pixmap:7,usag:[1,7],privat:4,free:7,"__setitem__":1,succeed:1,web:[0,4,3],dictionari:1,peer:7,path:[1,7],along:1,modifi:1,tue:0,valu:[1,4,7],open_url_in_brows:7,search:0,callback:1,convers:1,ssl:[3,4],rtype:1,via:4,similar:1,could:1,current:[1,7],torrent:7,base:[1,7],place:7,def:1,osx_check:7,dict:1,desktop:7,chang:1,timezon:7,infohash:7,apply_set_funct:1,load:1,control:1,rang:[1,7],configur:[3,1,4,7],simpli:1,is_ip:7,directli:1,within:7,modul:[0,1],"float":7,prefer:4,number:7,system:7,filenam:[1,7],initiliaz:1,set:1,done:1,org:7,owner:1,announc:7,open:7,"byte":7,unit:7,size:7,regex:7,differ:[1,4],fetch_url:7,span:[1,7],object:1,wai:[1,4],transfer:7,top:4,enabl:4,regist:1,add:4,least:0,sinc:[1,7],avail:7,type:[1,7],call:1,includ:7,which:[1,4],master:0,intend:4,valueerror:1,gib:7,"function":[1,7],from:7,consol:[0,2,3],option:7,form:7,fsize_b:7,su5225urmtueqldxqwrb2eqwn6kltykn:7,provid:7,convert:1,specifi:4,wish:4,decim:7,part:7,accept:1,newer:1,input:1,apply_al:1,line:1,given:7,"true":[1,7],than:1,those:1,must:1,info:7,none:[1,7],look:7,augment:1,whether:1,free_spac:7,second:7,windows_check:7,directori:[1,7],fpcnt:7,displai:7,can:[0,1],str:1,fdate:7,dec:7,root:0,fetch:7,vista_check:7,browser:7,pre:[1,7],files:7,would:1,conf:1,creat:[0,1,4,7],quickstart:0,"int":[1,7],get_default_download_dir:7,tabl:0,argument:1,indic:0,repres:7,twist:4,"default":[1,4,7],exist:7,file:[0,1,7],interfac:[0,4,3],need:1,revis:7,featur:4,check:7,get_vers:7,vista:7,encrypt:4,"__getitem__":1,want:[1,4],inform:4,allow:1,get:[1,7],fsize:7,same:[1,4],get_revis:7,note:1,how:4,epoch:7,other:4,bool:[1,7],build:7,fname:7,tupl:1,test:[1,7],you:[0,1,4],tracker:7,config:[0,1,7],complet:0,"23m":7,http:7,webserv:4,see:[1,4,7],less:1,after:1,what:1,keyerror:1,befor:1,mac:7,rais:1,two:7,thi:[0,1],date:7,kib:7,unless:1,"class":[1,7],serial:1,welcom:0,svn:7,sphinx:0,run_convert:1,framework:4,url:7,com:[],valid:7,filepath:7,delug:[0,1,2,3,4,5,6,7],uri:7,data:7,doe:[1,7],btih:7,extj:4,exampl:1,yatblog:[],determin:7,time:7,apply_now:1,built:4,egg:7,get_path_s:7,document:0},titles:["Welcome to Deluge’s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">deluge.config</span></tt>","Deluge Console UI","Deluge’s Interfaces","Deluge Web UI","The Deluge Core","Deluge GTK UI","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">deluge.common</span></tt>"],modules:{"deluge.config":1,"deluge.common":7},descrefs:{"deluge.common":{is_ip:[7,1],get_pixmap:[7,1],get_default_download_dir:[7,1],fspeed:[7,1],fpeer:[7,1],get_revision:[7,1],is_url:[7,1],vista_check:[7,1],fetch_url:[7,1],open_file:[7,1],get_version:[7,1],fsize:[7,1],ftime:[7,1],get_default_config_dir:[7,1],open_url_in_browser:[7,1],get_path_size:[7,1],free_space:[7,1],windows_check:[7,1],fpcnt:[7,1],osx_check:[7,1],fdate:[7,1],create_magnet_uri:[7,1],is_magnet:[7,1]},"deluge.config.Config":{apply_set_functions:[1,0],apply_all:[1,0],config_file:[1,2],"__getitem__":[1,0],run_converter:[1,0],set_item:[1,0],load:[1,0],"__setitem__":[1,0],register_change_callback:[1,0],register_set_function:[1,0],save:[1,0],config:[1,2],get_item:[1,0]},"deluge.config":{Config:[1,3]}},filenames:["index","modules/config","interfaces/console","interfaces/index","interfaces/web","core/index","interfaces/gtk","modules/common"]})
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 2db6520ff..a77e2f4e0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,6 +12,7 @@ # serve to show the default value. import sys, os +import deluge.common # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it @@ -42,9 +43,9 @@ copyright = '2008, Andrew Resch' # other places throughout the built documents. # # The short X.Y version. -version = '1.1.0' +version = deluge.common.get_version() # The full version, including alpha/beta/rc tags. -release = '1.1.0' +release = deluge.common.get_version() # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/docs/source/core/index.rst b/docs/source/core/index.rst new file mode 100644 index 000000000..f276a1b2d --- /dev/null +++ b/docs/source/core/index.rst @@ -0,0 +1,2 @@ +The Deluge Core +===============
\ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 1e4d84e3c..2feba1fed 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,13 +2,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to deluge's documentation! +Welcome to Deluge's documentation! ================================== Contents: .. toctree:: :maxdepth: 2 + + Core <core/index.rst> + Interfaces <interfaces/index.rst> Indices and tables ================== diff --git a/docs/source/interfaces/console.rst b/docs/source/interfaces/console.rst new file mode 100644 index 000000000..5781ee262 --- /dev/null +++ b/docs/source/interfaces/console.rst @@ -0,0 +1,2 @@ +Deluge Console UI +=================
\ No newline at end of file diff --git a/docs/source/interfaces/gtk.rst b/docs/source/interfaces/gtk.rst new file mode 100644 index 000000000..51bd946ca --- /dev/null +++ b/docs/source/interfaces/gtk.rst @@ -0,0 +1,2 @@ +Deluge GTK UI +=============
\ No newline at end of file diff --git a/docs/source/interfaces/index.rst b/docs/source/interfaces/index.rst new file mode 100644 index 000000000..6ac5469bb --- /dev/null +++ b/docs/source/interfaces/index.rst @@ -0,0 +1,10 @@ +Deluge's Interfaces +=================== + +Interfaces. + +.. toctree:: + + Gtk Interface <gtk> + Web Interface <web> + Console Interface <console>
\ No newline at end of file diff --git a/docs/source/interfaces/web.rst b/docs/source/interfaces/web.rst new file mode 100644 index 000000000..b3ac197d9 --- /dev/null +++ b/docs/source/interfaces/web.rst @@ -0,0 +1,19 @@ +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.
\ No newline at end of file |