Git commit 4da7405c92e2c119514a56cd34f88d0b15cb2217 by David Jarvie. Committed on 29/05/2013 at 01:43. Pushed by djarvie into branch 'master'.
Update to KDE 4.10 version M +44 -3 doc/kalarm/index.docbook http://commits.kde.org/kdepim/4da7405c92e2c119514a56cd34f88d0b15cb2217 diff --git a/doc/kalarm/index.docbook b/doc/kalarm/index.docbook index 17458a5..f2a4132 100644 --- a/doc/kalarm/index.docbook +++ b/doc/kalarm/index.docbook @@ -33,7 +33,7 @@ </authorgroup> <copyright> -<year>2001</year><year>2002</year><year>2003</year><year>2004</year><year>2005</year><year>2006</year><year>2007</year><year>2008</year><year>2009</year><year>2010</year><year>2011</year> +<year>2001</year><year>2002</year><year>2003</year><year>2004</year><year>2005</year><year>2006</year><year>2007</year><year>2008</year><year>2009</year><year>2010</year><year>2011</year><year>2012</year><year>2013</year> <holder>&David.Jarvie;</holder> </copyright> @@ -41,8 +41,8 @@ <!-- Don't change format of date and version of the documentation --> -<date>2012-08-10</date> -<releaseinfo>2.09.01 (&kde; 4.9)</releaseinfo> +<date>2013-05-28</date> +<releaseinfo>2.10.00 (&kde; 4.10)</releaseinfo> <abstract> <para>&kalarm; is a personal alarm message, command and email scheduler for &kde;.</para> @@ -3309,6 +3309,13 @@ including displaying the of the specified name, in order to edit a new alarm.</entry> </row> <row> + <entry><option>--list</option></entry> + <entry>Output a list of scheduled alarms to <filename>stdout</filename>. + The list shows brief details of each pending alarm: its resource + identifier (if using Akonadi), UID, next scheduled time and message + text or file.</entry> +</row> +<row> <entry><option>--tray</option></entry> <entry>Display &kalarm; as an icon in the system tray.</entry> </row> @@ -3384,6 +3391,7 @@ request the following functions:</para> <listitem><para>cancel an already scheduled alarm</para></listitem> <listitem><para>trigger an already scheduled alarm</para></listitem> <listitem><para>display the Alarm Edit dialog</para></listitem> +<listitem><para>list scheduled alarms</para></listitem> </itemizedlist> <para>Each of the above functions is implemented both by a &DBus; call @@ -4668,6 +4676,39 @@ parameter, the dialog is preset with details from the template.</para> </refsect1> </refentry> +<refentry id="dbus_list"> +<refmeta> +<refentrytitle>list</refentrytitle> +</refmeta> +<refnamediv> +<refname>list</refname> +<refpurpose>Return a list of scheduled alarms.</refpurpose> +</refnamediv> +<refsynopsisdiv> +<synopsis> +QString list() +</synopsis> + +<refsect2> +<title>Return value</title> +<para>List of alarms, separated by newlines, each in the format +<returnvalue><replaceable>resource_id</replaceable>:<replaceable>UID</replaceable> <replaceable>time</replaceable> <replaceable>text</replaceable></returnvalue> (if using Akonadi), +or +<returnvalue><replaceable>UID</replaceable> <replaceable>time</replaceable> <replaceable>text</replaceable></returnvalue> (if using KResources).</para> +</refsect2> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para><function>list()</function> is a &DBus; call to return a string +containing a summary of scheduled alarms. The list shows brief details +of each pending alarm: its resource identifier (if using Akonadi), UID, +next scheduled time and message text or file.</para> + +</refsect1> +</refentry> + </sect1> <sect1 id="cmdline-interface">
