summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJussi Kukkonen <jussi.kukkonen@intel.com>2013-09-02 11:28:28 +0300
committerJens Georg <mail@jensge.org>2014-11-08 13:51:48 +0100
commit0ca67df803f8f31070b88c613e5ce19565e973a8 (patch)
treed9f80bd27a8fffa64d01975aab8de38d67df184b /doc
parentb59f372212cd3201eb93b8dd1c1f07d653458392 (diff)
downloadrygel-0ca67df803f8f31070b88c613e5ce19565e973a8.tar.gz
core: Add initial EnergyManagement service implementation
EnergyManagement is a way to tell controlpoints that the device (e.g. Mediaserver or Renderer) may suspend, and also advice on how it can be woken up: http://upnp.org/specs/lp/UPnP-lp-EnergyManagement-v1-Service.pdf
Diffstat (limited to 'doc')
-rw-r--r--doc/man/rygel.conf.xml40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/man/rygel.conf.xml b/doc/man/rygel.conf.xml
index 5cab37fc..057c8b0f 100644
--- a/doc/man/rygel.conf.xml
+++ b/doc/man/rygel.conf.xml
@@ -276,6 +276,16 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
</varlistentry>
<varlistentry>
<term>
+ <option>energy-management</option>
+ </term>
+ <listitem>
+ <para>
+ Set to <userinput>true</userinput> to if you would like the UPnP device to contain a EnergyManagement service. Not that additional configuration is required, see EnergyManagement settings.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
<option>diagnostics</option>
</term>
<listitem>
@@ -287,6 +297,36 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
</variablelist>
</refsect1>
<refsect1>
+ <title>EnergyManagement settings</title>
+ <para>The settings in <option>[EnergyManagement-IFACENAME]</option> sections specify the settings that relate to EnergyManagement services on this interface. Example: <option>[EnergyManagement-eth0].</option></para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>mode-on-suspend</option>
+ </term>
+ <listitem>
+ <para>The <code>NetworkInterfaceMode</code> that should be used when suspended. Default is "Unimplemented", other valid values are "IP-up-Periodic”, "IP-down-no-Wake", "IP-down-with-WakeOn", "IP-down-with-WakeAuto", "IP-down-with-WakeOnAuto".</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>supported-transport</option>
+ </term>
+ <listitem>
+ <para>Optional <code>WakeSupportedTransport</code> that the service should advertize. Valid values are "UDP-Broadcast", "UDP-Unicast", "TCP-Unicast", "Other".</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>password</option>
+ </term>
+ <listitem>
+ <para>Optional hexadecimal password that will be used to build the <code>WakeOnPattern</code>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
<title>Tracker Plugin</title>
<para>The tracker plugin uses the centralized database of meta information
from the tracker project. See the