← Back to branch summary

~ubuntu-branches/ubuntu/lucid/kde-l10n-engb/lucid

« back to all changes in this revision

Viewing changes to docs/kdepim/kalarm/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2009-12-21 18:54:48 UTC
  • mfrom: (1.1.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20091221185448-vdr4pvc512kmibqu
Tags: 4:4.3.85-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/kdepim/kalarm/index.docbook
49
49
 
50
50
<!-- Don't change format of date and version of the documentation -->
51
51
 
52
 
<date>2009-05-25</date>
53
 
<releaseinfo>2.02.00</releaseinfo>
 
52
<date>2009-11-28</date>
 
53
<releaseinfo>2.04.00</releaseinfo>
54
54
 
55
55
<abstract>
56
56
<para>&kalarm; is a personal alarm message, command and email scheduler for &kde;.</para>
163
163
<para>Email alarms send a email. Nothing is displayed unless an error
164
164
occurs.</para>
165
165
</listitem>
 
166
 
 
167
<listitem>
 
168
<para>Audio alarms play an audio file. Nothing is displayed unless an
 
169
error occurs.</para>
 
170
</listitem>
166
171
</itemizedlist>
167
172
 
168
173
<sect2 id="errors">
189
194
 
190
195
<para>The main &kalarm; window displays the current list of pending
191
196
alarms, showing their times, repetition intervals, colours, and
192
 
message texts, names of files to display, commands to execute or email
193
 
subjects. (For a recurring alarm, the time shown is its next scheduled
194
 
trigger time. For an alarm with a reminder, the time shown is the time
195
 
of the alarm proper, not the reminder time.) An icon at the left of
196
 
each alarm text/file/command/email subject indicates the type of
197
 
alarm.</para>
 
197
message texts, names of files to play or display, commands to execute
 
198
or email subjects. (For a recurring alarm, the time shown is its next
 
199
scheduled trigger time. For an alarm with a reminder, the time shown
 
200
is the time of the alarm proper, not the reminder time.) An icon at
 
201
the left of each alarm text/file/command/email subject indicates the
 
202
type of alarm.</para>
198
203
 
199
204
<screenshot>
200
205
<screeninfo>Screenshot of the &kalarm; main window</screeninfo>
294
299
<para>Email alarms: in addition to the subject and body of the email,
295
300
the recipients and the URLs of attachments are searched.</para>
296
301
</listitem>
 
302
 
 
303
<listitem>
 
304
<para>Audio alarms: the file path/&URL; is searched.</para>
 
305
</listitem>
297
306
</itemizedlist>
298
307
 
299
308
<note><para>Only alarms currently shown in the alarm list can be
315
324
 
316
325
<itemizedlist>
317
326
<listitem>
318
 
<para>Select <menuchoice><guimenu>Actions</guimenu>
 
327
<para>Select <menuchoice><guimenu>File</guimenu>
319
328
<guimenuitem>New</guimenuitem></menuchoice>.</para>
320
329
</listitem>
321
330
 
346
355
<listitem>
347
356
<para>To base your new alarm on an existing one, highlight the existing
348
357
alarm in the list and select <menuchoice>
349
 
<guimenu>Actions</guimenu><guimenuitem>Copy</guimenuitem></menuchoice>.
 
358
<guimenu>File</guimenu><guimenuitem>Copy</guimenuitem></menuchoice>.
350
359
This opens the <link linkend="alarm-edit-dlg">Alarm Edit dialogue</link>
351
360
already filled in with a copy of the selected alarm's details.</para>
352
361
</listitem>
382
391
</listitem>
383
392
 
384
393
<listitem>
385
 
<para>To create a file display alarm, drag a file &URL; onto &kalarm;'s
386
 
main window or system tray icon. This opens the
 
394
<para>To create a file display alarm, drag a text or image file &URL;
 
395
onto &kalarm;'s main window or system tray icon. This opens the
 
396
<link linkend="alarm-edit-dlg">Alarm Edit dialogue</link> and sets the
 
397
file name.</para>
 
398
</listitem>
 
399
 
 
400
<listitem>
 
401
<para>To create an audio alarm, drag an audio file &URL; onto
 
402
&kalarm;'s main window or system tray icon. This opens the
387
403
<link linkend="alarm-edit-dlg">Alarm Edit dialogue</link> and sets the
388
404
file name.</para>
389
405
</listitem>
411
427
 
412
428
<listitem>
413
429
<para>Select it by clicking on its entry in the alarm list. Then
414
 
choose <menuchoice><guimenu>Actions</guimenu>
 
430
choose <menuchoice><guimenu>Edit</guimenu>
415
431
<guimenuitem>Edit</guimenuitem></menuchoice>.</para>
416
432
</listitem>
417
433
 
431
447
<sect2>
432
448
<title>Deleting/Reactivating an Alarm</title>
433
449
 
434
 
<para>To delete existing alarms, do one of the following:</para>
 
450
<para>To delete existing alarms, select one or more by clicking on
 
451
their entries in the alarm list. Then do one of the following:</para>
435
452
 
436
453
<itemizedlist>
437
454
<listitem>
438
 
<para>Select one or more alarms by clicking on their entries in the
439
 
alarm list. Then choose <menuchoice>
440
 
<guimenu>Actions</guimenu><guimenuitem>Delete</guimenuitem>
 
455
<para>Choose <menuchoice>
 
456
<guimenu>Edit</guimenu><guimenuitem>Delete</guimenuitem>
441
457
</menuchoice>.</para>
442
458
</listitem>
443
459
<listitem>
444
 
<para><mousebutton>Right</mousebutton> click on the desired entries in
445
 
the alarm list and choose
 
460
<para><mousebutton>Right</mousebutton> click on the selected entries
 
461
and choose
446
462
<menuchoice><guimenuitem>Delete</guimenuitem></menuchoice>
447
463
from the context menu.</para>
448
464
</listitem>
 
465
<listitem>
 
466
<para>To delete them without a confirmation prompt, type
 
467
&Shift;-<keycap>Delete</keycap>.</para>
 
468
</listitem>
449
469
</itemizedlist>
450
470
 
451
471
<para>When you delete an active alarm, it is archived, provided that
517
537
<itemizedlist>
518
538
<listitem>
519
539
<para>Select the <menuchoice>
520
 
<guimenu>Actions</guimenu><guimenuitem>New From Template</guimenuitem>
 
540
<guimenu>File</guimenu><guimenuitem>New From Template</guimenuitem>
521
541
</menuchoice> menu item, and then select the desired template.</para>
522
542
</listitem>
523
543
 
565
585
 
566
586
<listitem>
567
587
<para>Highlight an alarm in the alarm list and select <menuchoice>
568
 
<guimenu>Actions</guimenu><guimenuitem>Create Template...</guimenuitem>
 
588
<guimenu>File</guimenu><guimenuitem>Create Template...</guimenuitem>
569
589
</menuchoice>. This opens the Template Edit dialogue already filled in
570
590
with a copy of the selected alarm's details.</para>
571
591
</listitem>
659
679
you edit an existing alarm, it is automatically saved back into its
660
680
original alarm calendar.</para>
661
681
 
 
682
<screenshot>
 
683
<screeninfo>Screenshot of the &kalarm; main window, showing the
 
684
calendar list</screeninfo>
 
685
<mediaobject>
 
686
<imageobject>
 
687
<imagedata fileref="mainwindow-calendars.png" format="PNG"/>
 
688
</imageobject>
 
689
<textobject>
 
690
<phrase>Main window showing the calendar list</phrase>
 
691
</textobject>
 
692
</mediaobject>
 
693
</screenshot>
 
694
 
662
695
<sect3>
663
696
<title>Calendar Types and Options</title>
664
697
 
1415
1448
</itemizedlist>
1416
1449
 
1417
1450
</sect3>
 
1451
 
 
1452
<sect3>
 
1453
<title>Audio Alarms</title>
 
1454
 
 
1455
<para>Audio alarms play an audio file without displaying any alarm
 
1456
message.</para>
 
1457
 
 
1458
<para>Set the following options:</para>
 
1459
 
 
1460
<itemizedlist>
 
1461
<listitem>
 
1462
<para>Enter the sound file path, or use the button beside the
 
1463
edit box to display a file selection dialogue.</para>
 
1464
</listitem>
 
1465
 
 
1466
<listitem>
 
1467
<para>Tick <guilabel>Repeat</guilabel> to continually repeat the
 
1468
audio file until the <guilabel>Stop Play</guilabel> option is
 
1469
selected. To stop playing the file, select the
 
1470
<menuchoice><guimenu>Actions</guimenu>
 
1471
<guimenuitem>Stop Play</guimenuitem></menuchoice> menu option, or
 
1472
<mousebutton>Right</mousebutton> click on the system tray icon
 
1473
and choose
 
1474
<menuchoice><guimenuitem>Stop Play</guimenuitem></menuchoice>
 
1475
from the context menu. If you wish, you can set up a global
 
1476
shortcut key for this action.</para>
 
1477
</listitem>
 
1478
 
 
1479
<listitem>
 
1480
<para>Tick <guilabel>Volume</guilabel> and adjust the slider
 
1481
control if you want to adjust the volume at which the audio file is
 
1482
played.</para>
 
1483
</listitem>
 
1484
 
 
1485
<listitem>
 
1486
<para>If you wish, you can fade the volume. Fading means to start
 
1487
playing the audio file at one volume and gradually change to the final
 
1488
volume, over a specified time interval. The final volume is that
 
1489
entered in <guilabel>Volume</guilabel> above. To enable fade, tick
 
1490
<guilabel>Fade</guilabel>, and then enter the fade period in seconds
 
1491
in the <guilabel>Fade time</guilabel> field, and adjust the
 
1492
<guilabel>Initial volume</guilabel> slider.</para>
 
1493
</listitem>
 
1494
</itemizedlist>
 
1495
</sect3>
1418
1496
</sect2>
1419
1497
 
1420
1498
<sect2>
1774
1852
 
1775
1853
<para>Press the <guibutton>OK</guibutton> button
1776
1854
when all details are correct, to add the alarm to the scheduled
1777
 
list.</para>
 
1855
list. Note that when editing an existing alarm, the
 
1856
<guibutton>OK</guibutton> button is disabled while no changes have
 
1857
been made.</para>
1778
1858
 
1779
1859
</sect2>
1780
1860
</sect1>
1929
2009
<para>&kalarm; by default displays an icon in the system tray. The icon
1930
2010
provides both control and an alarm monitoring status indication. A
1931
2011
normal &kalarm; icon indicates that alarms are being monitored, while
1932
 
a grey icon indicates that alarms are not being monitored.</para>
 
2012
a grey icon indicates that alarms are not being monitored. If some
 
2013
individual alarms are disabled, a small cross is overlaid on the
 
2014
icon.</para>
1933
2015
 
1934
2016
<para>If you hover the mouse cursor over the system tray icon, a
1935
2017
summary of the first few message alarms due in the next 24 hours are
1970
2052
</varlistentry>
1971
2053
 
1972
2054
<varlistentry>
 
2055
<term><menuchoice><guimenuitem>Stop Play</guimenuitem></menuchoice></term>
 
2056
<listitem><para><action>Halts playback of the audio file currently
 
2057
playing.</action></para>
 
2058
</listitem>
 
2059
</varlistentry>
 
2060
 
 
2061
<varlistentry>
 
2062
<term><menuchoice><guimenuitem>Spread Windows</guimenuitem></menuchoice></term>
 
2063
<listitem><para><action>Spreads alarm and error message windows across
 
2064
the screen, or groups them together again.</action></para>
 
2065
</listitem>
 
2066
</varlistentry>
 
2067
 
 
2068
<varlistentry>
1973
2069
<term><menuchoice><guimenuitem>Configure &kalarm;...</guimenuitem></menuchoice></term>
1974
2070
<listitem><para><action>Displays the &kalarm; Configuration dialogue.</action></para>
1975
2071
<para>The Configuration dialogue is described in
2344
2440
</itemizedlist>
2345
2441
</listitem>
2346
2442
 
 
2443
<listitem><para><guilabel>KOrganiser event duration</guilabel>: Enter
 
2444
the event duration to set in KOrganiser for alarms which are copied to
 
2445
KOrganiser. The default duration is zero.</para>
 
2446
</listitem>
 
2447
 
2347
2448
</itemizedlist>
2348
2449
</sect1>
2349
2450
 
2795
2896
  option in &kalarm;'s command line. All subsequent command parameters
2796
2897
  and options  are interpreted as forming the command line to execute.
2797
2898
  <option>--exec</option>, <option>--file</option> and
2798
 
  <option>--mail</option> cannot be specified with this option.
2799
 
  <option>--ack-confirm</option>, <option>--beep</option>,
2800
 
  <option>--color</option> and <option>--colorfg</option> are ignored
2801
 
  with this option.</entry>
 
2899
  <option>--mail</option> cannot be specified with this option.</entry>
2802
2900
</row>
2803
2901
<row>
2804
2902
  <entry><option>-f</option>, <option>--file <replaceable>URL</replaceable></option></entry>
2841
2939
  <replaceable>period</replaceable></option></entry>
2842
2940
  <entry>Cancel the alarm if it cannot be triggered within the
2843
2941
  specified <replaceable>period</replaceable> after the correct
2844
 
  time. The <replaceable>period</replaceable> period is specified in
 
2942
  time. The <replaceable>period</replaceable> is specified in
2845
2943
  the same format as described for <option>--reminder</option>.
2846
2944
  The default value of <replaceable>period</replaceable> is 1
2847
2945
  minute.</entry>
2866
2964
</row>
2867
2965
<row>
2868
2966
  <entry><option>-p</option>, <option>--play <replaceable>URL</replaceable></option></entry>
2869
 
  <entry>Specify the path or &URL; of an audio file to be played once
2870
 
  when the alarm message is displayed. 
 
2967
  <entry>Specify the path or &URL; of an audio file to be played once,
 
2968
  either as an audio alarm or when the alarm message is displayed. 
2871
2969
  <option>--play-repeat</option>, <option>--beep</option> and
2872
2970
  <option>--speak</option> cannot be specified with this
2873
2971
  option.</entry>
2875
2973
<row>
2876
2974
  <entry><option>-P</option>, <option>--play-repeat <replaceable>URL</replaceable></option></entry>
2877
2975
  <entry>Specify the path or &URL; of an audio file to be played
2878
 
  repeatedly for as long as the alarm message is displayed.
 
2976
  repeatedly, either until <guilabel>Stop Play</guilabel> is used, or
 
2977
  for as long as the alarm message is displayed.
2879
2978
  <option>--play</option>, <option>--beep</option> and
2880
2979
  <option>--speak</option> cannot be specified with this
2881
2980
  option.</entry>
2984
3083
</informaltable>
2985
3084
 
2986
3085
<para>Either a message text, <option>--file</option>,
2987
 
<option>--exec</option> or <option>--exec-display</option> must be
 
3086
<option>--exec</option>, <option>--exec-display</option>,
 
3087
<option>--play</option> or <option>--play-repeat</option> must be
2988
3088
specified; except as noted above, all the options are optional.</para>
2989
3089
 
2990
3090
<para>Two alternative examples which display a multi-line message with
3020
3120
  specified event ID.</entry>
3021
3121
</row>
3022
3122
<row>
 
3123
  <entry><option>--edit-new-audio</option></entry>
 
3124
  <entry>Display the Alarm Edit dialogue, in order to edit a new audio
 
3125
  alarm.</entry>
 
3126
</row>
 
3127
<row>
3023
3128
  <entry><option>--edit-new-command</option></entry>
3024
3129
  <entry>Display the Alarm Edit dialogue, in order to edit a new command
3025
3130
  alarm.</entry>
4096
4201
</refsect1>
4097
4202
</refentry>
4098
4203
 
 
4204
 
 
4205
<refentry id="scheduleAudio">
 
4206
<refmeta>
 
4207
<refentrytitle>scheduleAudio</refentrytitle>
 
4208
</refmeta>
 
4209
<refnamediv>
 
4210
<refname>scheduleAudio</refname>
 
4211
<refpurpose>schedule a new alarm which executes a shell
 
4212
command.</refpurpose>
 
4213
</refnamediv>
 
4214
<refsynopsisdiv>
 
4215
<synopsis>
 
4216
bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
 
4217
                   int <replaceable>volumePercent</replaceable>,
 
4218
                   const QString&amp; <replaceable>startDateTime</replaceable>,
 
4219
                   int <replaceable>lateCancel</replaceable>,
 
4220
                   unsigned <replaceable>flags</replaceable>,
 
4221
                   const QString&amp; <replaceable>recurrence</replaceable>,
 
4222
                   int <replaceable>subRepeatInterval</replaceable>, 
 
4223
                   int <replaceable>subRepeatCount</replaceable>)
 
4224
</synopsis>
 
4225
<synopsis>
 
4226
bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
 
4227
                   int <replaceable>volumePercent</replaceable>,
 
4228
                   const QString&amp; <replaceable>startDateTime</replaceable>,
 
4229
                   int <replaceable>lateCancel</replaceable>,
 
4230
                   unsigned <replaceable>flags</replaceable>,
 
4231
                   int <replaceable>recurType</replaceable>,
 
4232
                   int <replaceable>recurInterval</replaceable>,
 
4233
                   int <replaceable>recurCount</replaceable>)
 
4234
</synopsis>
 
4235
<synopsis>
 
4236
bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
 
4237
                   int <replaceable>volumePercent</replaceable>,
 
4238
                   const QString&amp; <replaceable>startDateTime</replaceable>,
 
4239
                   int <replaceable>lateCancel</replaceable>,
 
4240
                   unsigned <replaceable>flags</replaceable>,
 
4241
                   int <replaceable>recurType</replaceable>,
 
4242
                   int <replaceable>recurInterval</replaceable>,
 
4243
                   const QString&amp; <replaceable>endDateTime</replaceable>)
 
4244
</synopsis>
 
4245
 
 
4246
<refsect2>
 
4247
<title>Parameters</title>
 
4248
<variablelist>
 
4249
<varlistentry>
 
4250
<term><parameter>audioURL</parameter></term>
 
4251
<listitem>
 
4252
<para>Specifies the audio file which is to be played.</para>
 
4253
</listitem>
 
4254
</varlistentry>
 
4255
 
 
4256
<varlistentry>
 
4257
<term><parameter>volumePercent</parameter></term>
 
4258
<listitem>
 
4259
<para>Specifies the volume level to use, as a percentage of full
 
4260
volume. Specify -1 to use the default volume.</para>
 
4261
</listitem>
 
4262
</varlistentry>
 
4263
 
 
4264
<varlistentry>
 
4265
<term><parameter>startDateTime</parameter></term>
 
4266
<listitem>
 
4267
<para>Specifies the scheduled date, or date and time, at which the
 
4268
message should be displayed. For a date-only alarm, the string should
 
4269
be in the format <replaceable>YYYY-MM-DD [TZ]</replaceable> (as
 
4270
returned by <methodname>QDate::toString(Qt::ISODate)</methodname>). For
 
4271
an alarm with a date and time, the string should be in the format
 
4272
<replaceable>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable> (as returned by
 
4273
<methodname>QDateTime::toString(Qt::ISODate)</methodname>) or
 
4274
<replaceable>HH:MM[:SS] [Clock]</replaceable> (as returned by
 
4275
<methodname>QTime::toString(Qt::ISODate)</methodname>). If no date is
 
4276
specified, today's date is used. Note that any seconds value is
 
4277
ignored.</para>
 
4278
 
 
4279
<para>If no time zone is specified, the local system time zone is
 
4280
assumed. If a time zone specifier <replaceable>TZ</replaceable> is
 
4281
present, it may be the name of a system time zone (&eg;
 
4282
<userinput>Europe/London</userinput>), <userinput>UTC</userinput>
 
4283
representing the UTC time zone, or <userinput>Clock</userinput> to use
 
4284
the local computer clock and ignore time zones.</para>
 
4285
</listitem>
 
4286
</varlistentry>
 
4287
 
 
4288
<varlistentry>
 
4289
<term><parameter>lateCancel</parameter></term>
 
4290
<listitem>
 
4291
<para>Causes the alarm to be cancelled if it cannot be triggered within
 
4292
the specified number of minutes after the alarm's scheduled time. If
 
4293
the value is 0, the alarm will not be cancelled no matter how late it
 
4294
is triggered.</para>
 
4295
</listitem>
 
4296
</varlistentry>
 
4297
 
 
4298
<varlistentry>
 
4299
<term><parameter>flags</parameter></term>
 
4300
<listitem>
 
4301
<para>Specifies the logical OR of the desired alarm flags. The flag
 
4302
bits are those defined in class <classname>KAlarmIface</classname> in
 
4303
<filename>kalarmiface.h</filename>. Note that not all flag bits are
 
4304
applicable to command alarms.</para>
 
4305
</listitem>
 
4306
</varlistentry>
 
4307
 
 
4308
<varlistentry>
 
4309
<term><parameter>recurrence</parameter></term>
 
4310
<listitem>
 
4311
<para>Specifies a regular recurrence for the alarm, using iCalendar
 
4312
syntax as defined in
 
4313
<ulink url="http://www.w3.org/2002/12/cal/rfc2445.html">RFC2445</ulink>.
 
4314
For example, <quote>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote>
 
4315
would specify 4 repetitions at 3-monthly intervals on the last Monday
 
4316
of the month. For a non-recurring alarm, specify an empty
 
4317
string.</para>
 
4318
</listitem>
 
4319
</varlistentry>
 
4320
 
 
4321
<varlistentry>
 
4322
<term><parameter>recurType</parameter></term>
 
4323
<listitem>
 
4324
<para>Specifies the recurrence type for the alarm. The permissible
 
4325
values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These
 
4326
are defined in class <classname>KAlarmIface</classname> in
 
4327
<filename>kalarmiface.h</filename>. Monthly recurrences are of the
 
4328
day of the month type, and yearly recurrences are of the date in
 
4329
the year type, with the date in both cases taken from the
 
4330
<parameter>startDateTime</parameter> parameter.</para>
 
4331
</listitem>
 
4332
</varlistentry>
 
4333
 
 
4334
<varlistentry>
 
4335
<term><parameter>recurInterval</parameter></term>
 
4336
<listitem>
 
4337
<para>Specifies the number of periods
 
4338
(minutes/days/weeks/months/years as specified by
 
4339
<parameter>recurType</parameter>) between recurrences of the
 
4340
alarm.</para>
 
4341
</listitem>
 
4342
</varlistentry>
 
4343
 
 
4344
<varlistentry>
 
4345
<term><parameter>recurCount</parameter></term>
 
4346
<listitem>
 
4347
<para>Specifies the number of times that the alarm should be
 
4348
repeated. Specify -1 to repeat the alarm indefinitely.</para>
 
4349
</listitem>
 
4350
</varlistentry>
 
4351
 
 
4352
<varlistentry>
 
4353
<term><parameter>endDateTime</parameter></term>
 
4354
<listitem>
 
4355
<para>Specifies the end date, or date and time, for recurrences of the
 
4356
alarm. If <parameter>startDateTime</parameter> includes a time, this
 
4357
parameter must also include a time; if <parameter>startDateTime</parameter>
 
4358
contains only a date, this parameter must also contain only a
 
4359
date. It must not contain a time zone specifier; the same time zone as
 
4360
for <parameter>startDateTime</parameter> is used to interpret this
 
4361
parameter's value.</para>
 
4362
</listitem>
 
4363
</varlistentry>
 
4364
 
 
4365
<varlistentry>
 
4366
<term><parameter>subRepeatInterval</parameter></term>
 
4367
<listitem>
 
4368
<para>Specifies the number of minutes between sub-repetitions of
 
4369
the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence
 
4370
is specified.</para>
 
4371
</listitem>
 
4372
</varlistentry>
 
4373
 
 
4374
<varlistentry>
 
4375
<term><parameter>subRepeatCount</parameter></term>
 
4376
<listitem>
 
4377
<para>Specifies the number of sub-repetitions of the alarm,
 
4378
including the initial occurrence.</para>
 
4379
</listitem>
 
4380
</varlistentry>
 
4381
</variablelist>
 
4382
</refsect2>
 
4383
</refsynopsisdiv>
 
4384
 
 
4385
<refsect1>
 
4386
<title>Description</title>
 
4387
<para><function>scheduleAudio()</function> is a D-Bus call to
 
4388
schedule the specified audio file to be played at the specified date
 
4389
and time. Apart from specifying a volume and omitting the message
 
4390
colour and font parameters, its usage is identical to
 
4391
<link linkend="scheduleMessage-descrip"><function>scheduleMessage</function></link>
 
4392
- see the description of that function for further details.</para>
 
4393
</refsect1>
 
4394
</refentry>
 
4395
 
4099
4396
<refentry id="dbus_edit">
4100
4397
<refmeta>
4101
4398
<refentrytitle>edit</refentrytitle>
4164
4461
<term><parameter>type</parameter></term>
4165
4462
<listitem>
4166
4463
<para>Specifies the alarm type. The permissible values are DISPLAY,
4167
 
COMMAND, EMAIL. These are defined in class
 
4464
COMMAND, EMAIL, AUDIO. These are defined in class
4168
4465
<classname>KAlarmIface</classname> in
4169
4466
<filename>kalarmiface.h</filename>.</para>
4170
4467
</listitem>
4422
4719
 
4423
4720
&install.intro.documentation;
4424
4721
 
4425
 
<para>&kalarm; is available for &kde; 2 and as a standalone package for
4426
 
&kde; 3 from <ulink url="http://www.astrojar.org.uk/kalarm">http://www.astrojar.org.uk/kalarm</ulink>
 
4722
<para>&kalarm; is available for &kde; 2 and as standalone packages for
 
4723
&kde; 3 and &kde; 4 from
 
4724
<ulink url="http://www.astrojar.org.uk/kalarm">http://www.astrojar.org.uk/kalarm</ulink>
4427
4725
</para>
4428
4726
 
4429
4727
</sect1>
4452
4750
depending on your platform and configuration.</para>
4453
4751
 
4454
4752
<para>You can find a list of changes in the
4455
 
<filename>ChangeLog</filename> file, or at <ulink
 
4753
<filename>Changelog</filename> file, or at <ulink
4456
4754
url="http://www.astrojar.org.uk/kalarm">http://www.astrojar.org.uk/kalarm</ulink>.</para>
4457
4755
</sect1>
4458
4756