use docs generated by sphinx to set the project's web page.

[simple-xmbc-rem] / www / _sources / setupdialog.txt

diff --git a/www/_sources/setupdialog.txt b/www/_sources/setupdialog.txt
new file mode 100644 (file)
index 0000000..b71687a
--- /dev/null
+++ b/www/_sources/setupdialog.txt
@@ -0,0 +1,73 @@
+Setup Dialog
+============
+
+The **Setup** dialog can be activated from application's menu. The changes are
+saved only if you press the **Done** button. Clicking outside the dialog is
+interpretted as canceling the current changes.
+
+XBMC
+----
+
+On the phone
+````````````
+
+Use these settings to configure the network connection between XBMC and |SXR|.
+If the XBMC requires an *username* and *password*, check the **Requires
+authentication** and complete those fields, too.
+
+* **Server**: the IP or name of the XBMC server
+* **Port**: port where XBMC listens for HTTP connections
+* **Username**: username configured in XBMC
+* **Password**: password configured in XBMC 
+
+.. warning:: if set, the *username* and *password* are stored in clear on the
+   phone.
+
+.. image:: simplexbmcremote-0.8.3--setup--xbmc.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--xbmc.png
+
+On the server
+`````````````
+
+The network configuration for XBMC is accessible via **System > Network >
+Settings > Services**.
+
+1. As a bare minimum, you will have to **Allow control of XBMC via HTTP** and
+   configure a port. The **Port** value must be the same with that used in |SXR|.
+
+2. If you configure a **Username** and **Password**, you will have to check the
+   **Requires authentication** and set |SXR| accordingly.
+
+3. You will also have to activate in XBMC the **Allow programs from other
+   systems to control XBMC** (or you could check only **Allow programs on this
+   system to control XBMC**, use SSSH to do some portforwarding to your phone,
+   then set the *Server* in |SXR| to point to **localhost**).
+
+.. image:: xbmc--system--network--services.png
+
+Screen
+------
+
+You can disable the screen saver by checking the **Disable screensaver**.
+
+.. warning:: Currently, dimming is not working, so you will only be able to disable the screensaver.
+
+.. image:: simplexbmcremote-0.8.3--setup--screen.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--screen.png
+
+Notifications
+-------------
+
+In case of some error, |SXR| will display a notification. The time these
+notifications are displayed is controlled by the slider under **Notifications**.
+If you want to completely dissable these notifications, move the slider
+completely to the left.
+
+.. image:: simplexbmcremote-0.8.3--setup--notifications.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--notifications.png
+
+
+.. |SXR| replace:: *Simple XBMC Remote*