use docs generated by sphinx to set the project's web page.
[simple-xmbc-rem] / www / setupdialog.html
diff --git a/www/setupdialog.html b/www/setupdialog.html
new file mode 100644 (file)
index 0000000..97bc5fc
--- /dev/null
@@ -0,0 +1,170 @@
+
+
+<!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>Setup Dialog &mdash; Simple XBMC Remote v0.8.3 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:     '0.8.3',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="top" title="Simple XBMC Remote v0.8.3 documentation" href="index.html" />
+    <link rel="prev" title="Main Window" href="mainwindow.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="mainwindow.html" title="Main Window"
+             accesskey="P">previous</a> |</li>
+        <li><a href="index.html">Simple XBMC Remote v0.8.3 documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <div class="section" id="setup-dialog">
+<h1>Setup Dialog<a class="headerlink" href="#setup-dialog" title="Permalink to this headline">¶</a></h1>
+<p>The <strong>Setup</strong> dialog can be activated from application&#8217;s menu. The changes are
+saved only if you press the <strong>Done</strong> button. Clicking outside the dialog is
+interpretted as canceling the current changes.</p>
+<div class="section" id="xbmc">
+<h2>XBMC<a class="headerlink" href="#xbmc" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="on-the-phone">
+<h3>On the phone<a class="headerlink" href="#on-the-phone" title="Permalink to this headline">¶</a></h3>
+<p>Use these settings to configure the network connection between XBMC and <em>Simple XBMC Remote</em>.
+If the XBMC requires an <em>username</em> and <em>password</em>, check the <strong>Requires
+authentication</strong> and complete those fields, too.</p>
+<ul class="simple">
+<li><strong>Server</strong>: the IP or name of the XBMC server</li>
+<li><strong>Port</strong>: port where XBMC listens for HTTP connections</li>
+<li><strong>Username</strong>: username configured in XBMC</li>
+<li><strong>Password</strong>: password configured in XBMC</li>
+</ul>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">if set, the <em>username</em> and <em>password</em> are stored in clear on the
+phone.</p>
+</div>
+<a class="reference external image-reference" href="_images/simplexbmcremote-0.8.3--setup--xbmc.png"><img alt="_images/simplexbmcremote-0.8.3--setup--xbmc.png" src="_images/simplexbmcremote-0.8.3--setup--xbmc.png" style="width: 400.0px; height: 240.0px;" /></a>
+</div>
+<div class="section" id="on-the-server">
+<h3>On the server<a class="headerlink" href="#on-the-server" title="Permalink to this headline">¶</a></h3>
+<p>The network configuration for XBMC is accessible via <strong>System &gt; Network &gt;
+Settings &gt; Services</strong>.</p>
+<ol class="arabic simple">
+<li>As a bare minimum, you will have to <strong>Allow control of XBMC via HTTP</strong> and
+configure a port. The <strong>Port</strong> value must be the same with that used in <em>Simple XBMC Remote</em>.</li>
+<li>If you configure a <strong>Username</strong> and <strong>Password</strong>, you will have to check the
+<strong>Requires authentication</strong> and set <em>Simple XBMC Remote</em> accordingly.</li>
+<li>You will also have to activate in XBMC the <strong>Allow programs from other
+systems to control XBMC</strong> (or you could check only <strong>Allow programs on this
+system to control XBMC</strong>, use SSSH to do some portforwarding to your phone,
+then set the <em>Server</em> in <em>Simple XBMC Remote</em> to point to <strong>localhost</strong>).</li>
+</ol>
+<img alt="_images/xbmc--system--network--services.png" src="_images/xbmc--system--network--services.png" />
+</div>
+</div>
+<div class="section" id="screen">
+<h2>Screen<a class="headerlink" href="#screen" title="Permalink to this headline">¶</a></h2>
+<p>You can disable the screen saver by checking the <strong>Disable screensaver</strong>.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">Currently, dimming is not working, so you will only be able to disable the screensaver.</p>
+</div>
+<a class="reference external image-reference" href="_images/simplexbmcremote-0.8.3--setup--screen.png"><img alt="_images/simplexbmcremote-0.8.3--setup--screen.png" src="_images/simplexbmcremote-0.8.3--setup--screen.png" style="width: 400.0px; height: 240.0px;" /></a>
+</div>
+<div class="section" id="notifications">
+<h2>Notifications<a class="headerlink" href="#notifications" title="Permalink to this headline">¶</a></h2>
+<p>In case of some error, <em>Simple XBMC Remote</em> will display a notification. The time these
+notifications are displayed is controlled by the slider under <strong>Notifications</strong>.
+If you want to completely dissable these notifications, move the slider
+completely to the left.</p>
+<a class="reference external image-reference" href="_images/simplexbmcremote-0.8.3--setup--notifications.png"><img alt="_images/simplexbmcremote-0.8.3--setup--notifications.png" src="_images/simplexbmcremote-0.8.3--setup--notifications.png" style="width: 400.0px; height: 240.0px;" /></a>
+</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 internal" href="#">Setup Dialog</a><ul>
+<li><a class="reference internal" href="#xbmc">XBMC</a><ul>
+<li><a class="reference internal" href="#on-the-phone">On the phone</a></li>
+<li><a class="reference internal" href="#on-the-server">On the server</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#screen">Screen</a></li>
+<li><a class="reference internal" href="#notifications">Notifications</a></li>
+</ul>
+</li>
+</ul>
+
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="mainwindow.html"
+                        title="previous chapter">Main Window</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/setupdialog.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="mainwindow.html" title="Main Window"
+             >previous</a> |</li>
+        <li><a href="index.html">Simple XBMC Remote v0.8.3 documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2011, Ionutz Borcoman.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
+    </div>
+  </body>
+</html>
\ No newline at end of file