use docs generated by sphinx to set the project's web page.
[simple-xmbc-rem] / www / setupdialog.html
1
2
3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml">
7   <head>
8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9     
10     <title>Setup Dialog &mdash; Simple XBMC Remote v0.8.3 documentation</title>
11     <link rel="stylesheet" href="_static/default.css" type="text/css" />
12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13     <script type="text/javascript">
14       var DOCUMENTATION_OPTIONS = {
15         URL_ROOT:    '',
16         VERSION:     '0.8.3',
17         COLLAPSE_INDEX: false,
18         FILE_SUFFIX: '.html',
19         HAS_SOURCE:  true
20       };
21     </script>
22     <script type="text/javascript" src="_static/jquery.js"></script>
23     <script type="text/javascript" src="_static/underscore.js"></script>
24     <script type="text/javascript" src="_static/doctools.js"></script>
25     <link rel="top" title="Simple XBMC Remote v0.8.3 documentation" href="index.html" />
26     <link rel="prev" title="Main Window" href="mainwindow.html" /> 
27   </head>
28   <body>
29     <div class="related">
30       <h3>Navigation</h3>
31       <ul>
32         <li class="right" style="margin-right: 10px">
33           <a href="genindex.html" title="General Index"
34              accesskey="I">index</a></li>
35         <li class="right" >
36           <a href="mainwindow.html" title="Main Window"
37              accesskey="P">previous</a> |</li>
38         <li><a href="index.html">Simple XBMC Remote v0.8.3 documentation</a> &raquo;</li> 
39       </ul>
40     </div>  
41
42     <div class="document">
43       <div class="documentwrapper">
44         <div class="bodywrapper">
45           <div class="body">
46             
47   <div class="section" id="setup-dialog">
48 <h1>Setup Dialog<a class="headerlink" href="#setup-dialog" title="Permalink to this headline">¶</a></h1>
49 <p>The <strong>Setup</strong> dialog can be activated from application&#8217;s menu. The changes are
50 saved only if you press the <strong>Done</strong> button. Clicking outside the dialog is
51 interpretted as canceling the current changes.</p>
52 <div class="section" id="xbmc">
53 <h2>XBMC<a class="headerlink" href="#xbmc" title="Permalink to this headline">¶</a></h2>
54 <div class="section" id="on-the-phone">
55 <h3>On the phone<a class="headerlink" href="#on-the-phone" title="Permalink to this headline">¶</a></h3>
56 <p>Use these settings to configure the network connection between XBMC and <em>Simple XBMC Remote</em>.
57 If the XBMC requires an <em>username</em> and <em>password</em>, check the <strong>Requires
58 authentication</strong> and complete those fields, too.</p>
59 <ul class="simple">
60 <li><strong>Server</strong>: the IP or name of the XBMC server</li>
61 <li><strong>Port</strong>: port where XBMC listens for HTTP connections</li>
62 <li><strong>Username</strong>: username configured in XBMC</li>
63 <li><strong>Password</strong>: password configured in XBMC</li>
64 </ul>
65 <div class="admonition warning">
66 <p class="first admonition-title">Warning</p>
67 <p class="last">if set, the <em>username</em> and <em>password</em> are stored in clear on the
68 phone.</p>
69 </div>
70 <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>
71 </div>
72 <div class="section" id="on-the-server">
73 <h3>On the server<a class="headerlink" href="#on-the-server" title="Permalink to this headline">¶</a></h3>
74 <p>The network configuration for XBMC is accessible via <strong>System &gt; Network &gt;
75 Settings &gt; Services</strong>.</p>
76 <ol class="arabic simple">
77 <li>As a bare minimum, you will have to <strong>Allow control of XBMC via HTTP</strong> and
78 configure a port. The <strong>Port</strong> value must be the same with that used in <em>Simple XBMC Remote</em>.</li>
79 <li>If you configure a <strong>Username</strong> and <strong>Password</strong>, you will have to check the
80 <strong>Requires authentication</strong> and set <em>Simple XBMC Remote</em> accordingly.</li>
81 <li>You will also have to activate in XBMC the <strong>Allow programs from other
82 systems to control XBMC</strong> (or you could check only <strong>Allow programs on this
83 system to control XBMC</strong>, use SSSH to do some portforwarding to your phone,
84 then set the <em>Server</em> in <em>Simple XBMC Remote</em> to point to <strong>localhost</strong>).</li>
85 </ol>
86 <img alt="_images/xbmc--system--network--services.png" src="_images/xbmc--system--network--services.png" />
87 </div>
88 </div>
89 <div class="section" id="screen">
90 <h2>Screen<a class="headerlink" href="#screen" title="Permalink to this headline">¶</a></h2>
91 <p>You can disable the screen saver by checking the <strong>Disable screensaver</strong>.</p>
92 <div class="admonition warning">
93 <p class="first admonition-title">Warning</p>
94 <p class="last">Currently, dimming is not working, so you will only be able to disable the screensaver.</p>
95 </div>
96 <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>
97 </div>
98 <div class="section" id="notifications">
99 <h2>Notifications<a class="headerlink" href="#notifications" title="Permalink to this headline">¶</a></h2>
100 <p>In case of some error, <em>Simple XBMC Remote</em> will display a notification. The time these
101 notifications are displayed is controlled by the slider under <strong>Notifications</strong>.
102 If you want to completely dissable these notifications, move the slider
103 completely to the left.</p>
104 <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>
105 </div>
106 </div>
107
108
109           </div>
110         </div>
111       </div>
112       <div class="sphinxsidebar">
113         <div class="sphinxsidebarwrapper">
114   <h3><a href="index.html">Table Of Contents</a></h3>
115   <ul>
116 <li><a class="reference internal" href="#">Setup Dialog</a><ul>
117 <li><a class="reference internal" href="#xbmc">XBMC</a><ul>
118 <li><a class="reference internal" href="#on-the-phone">On the phone</a></li>
119 <li><a class="reference internal" href="#on-the-server">On the server</a></li>
120 </ul>
121 </li>
122 <li><a class="reference internal" href="#screen">Screen</a></li>
123 <li><a class="reference internal" href="#notifications">Notifications</a></li>
124 </ul>
125 </li>
126 </ul>
127
128   <h4>Previous topic</h4>
129   <p class="topless"><a href="mainwindow.html"
130                         title="previous chapter">Main Window</a></p>
131   <h3>This Page</h3>
132   <ul class="this-page-menu">
133     <li><a href="_sources/setupdialog.txt"
134            rel="nofollow">Show Source</a></li>
135   </ul>
136 <div id="searchbox" style="display: none">
137   <h3>Quick search</h3>
138     <form class="search" action="search.html" method="get">
139       <input type="text" name="q" size="18" />
140       <input type="submit" value="Go" />
141       <input type="hidden" name="check_keywords" value="yes" />
142       <input type="hidden" name="area" value="default" />
143     </form>
144     <p class="searchtip" style="font-size: 90%">
145     Enter search terms or a module, class or function name.
146     </p>
147 </div>
148 <script type="text/javascript">$('#searchbox').show(0);</script>
149         </div>
150       </div>
151       <div class="clearer"></div>
152     </div>
153     <div class="related">
154       <h3>Navigation</h3>
155       <ul>
156         <li class="right" style="margin-right: 10px">
157           <a href="genindex.html" title="General Index"
158              >index</a></li>
159         <li class="right" >
160           <a href="mainwindow.html" title="Main Window"
161              >previous</a> |</li>
162         <li><a href="index.html">Simple XBMC Remote v0.8.3 documentation</a> &raquo;</li> 
163       </ul>
164     </div>
165     <div class="footer">
166         &copy; Copyright 2011, Ionutz Borcoman.
167       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
168     </div>
169   </body>
170 </html>