doc: finished documenting the current interface.
[simple-xmbc-rem] / docs / setupdialog.rst
1 Setup Dialog
2 ============
3
4 The **Setup** dialog can be activated from application's menu. The changes are
5 saved only if you press the **Done** button. Clicking outside the dialog is
6 interpretted as canceling the current changes.
7
8 XBMC
9 ----
10
11 On the phone
12 ````````````
13
14 Use these settings to configure the network connection between XBMC and |SXR|.
15 If the XBMC requires an *username* and *password*, check the **Requires
16 authentication** and complete those fields, too.
17
18 * **Server**: the IP or name of the XBMC server
19 * **Port**: port where XBMC listens for HTTP connections
20 * **Username**: username configured in XBMC
21 * **Password**: password configured in XBMC 
22
23 .. warning:: if set, the *username* and *password* are stored in clear on the
24    phone.
25
26 .. image:: simplexbmcremote-0.8.3--setup--xbmc.png
27    :scale: 50
28    :target: _images/simplexbmcremote-0.8.3--setup--xbmc.png
29
30 On the server
31 `````````````
32
33 The network configuration for XBMC is accessible via **System > Network >
34 Settings > Services**.
35
36 1. As a bare minimum, you will have to **Allow control of XBMC via HTTP** and
37    configure a port. The **Port** value must be the same with that used in |SXR|.
38
39 2. If you configure a **Username** and **Password**, you will have to check the
40    **Requires authentication** and set |SXR| accordingly.
41
42 3. You will also have to activate in XBMC the **Allow programs from other
43    systems to control XBMC** (or you could check only **Allow programs on this
44    system to control XBMC**, use SSSH to do some portforwarding to your phone,
45    then set the *Server* in |SXR| to point to **localhost**).
46
47 .. image:: xbmc--system--network--services.png
48
49 Screen
50 ------
51
52 You can disable the screen saver by checking the **Disable screensaver**.
53
54 .. warning:: Currently, dimming is not working, so you will only be able to disable the screensaver.
55
56 .. image:: simplexbmcremote-0.8.3--setup--screen.png
57    :scale: 50
58    :target: _images/simplexbmcremote-0.8.3--setup--screen.png
59
60 Notifications
61 -------------
62
63 In case of some error, |SXR| will display a notification. The time these
64 notifications are displayed is controlled by the slider under **Notifications**.
65 If you want to completely dissable these notifications, move the slider
66 completely to the left.
67
68 .. image:: simplexbmcremote-0.8.3--setup--notifications.png
69    :scale: 50
70    :target: _images/simplexbmcremote-0.8.3--setup--notifications.png
71
72
73 .. |SXR| replace:: *Simple XBMC Remote*