<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&kalarm;">
  <!ENTITY package "kdepim">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % Dutch "INCLUDE"
><!-- change language only here -->
]>

<!-- The language must NOT be changed here. -->

<book lang="&language;">

<bookinfo>
<title
>Het handboek van &kalarm;</title>

<authorgroup>
<author
><firstname
>David</firstname
> <surname
>Jarvie</surname
> <affiliation
> <address
>&David.Jarvie.mail;</address>
</affiliation>
</author>

<othercredit role="developer"
><firstname
>David</firstname
> <surname
>Jarvie</surname
> <affiliation
><address
>&David.Jarvie.mail;</address
></affiliation>
<contrib
>Ontwikkelaar</contrib>
</othercredit>

&Niels.Reedijk;&Ruben.Van.Laerhoven; 
</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>
<holder
>&David.Jarvie;</holder>
</copyright>

<legalnotice
>&FDLNotice;</legalnotice>

<!-- Don't change format of date and version of the documentation -->

<date
>2010-09-30</date>
<releaseinfo
>2.06.00 (&kde; 4.6)</releaseinfo>

<abstract>
<para
>&kalarm; is een persoonlijke planner voor herinneringen, commando's en e-mailberichten voor &kde;.</para>
</abstract>


<keywordset>
<keyword
>KDE</keyword>
<keyword
>kdepim</keyword>
<keyword
>kalarm</keyword>
<keyword
>herinnering</keyword>
<keyword
>herinnering vooraf</keyword>
<keyword
>takenplanner</keyword>
</keywordset>

</bookinfo>


<chapter id="introduction">
<title
>Inleiding</title>

<para
>&kalarm; stelt u in staat persoonlijke herinneringsberichten, het afspelen van geluidsbestanden, het uitvoeren van commando's en het verzenden van e-mails in te plannen.</para>

<para
>In zijn standaard grafische modus toont &kalarm; de lijst met herinneringendie in de wachtrij staan, met hun tijd(en) en details. U kunt nieuwe herinneringen aanmaken of u kunt bestaande herinneringen wijzigen of verwijderen. U kunt ook, als optie, reeds verlopen herinneringen bekijken.</para>

<para
>Bij het instellen van een herinnering, kunt u kiezen of deze herhaald moet worden, en of de herinnering geannuleerd moet worden als er geen melding van gemaakt kan worden op de ingestelde tijd. U kunt een berichttekst intypen, een tekst- of beeldbestand kiezen dat getoond moet worden, of een commando specificeren waarvan de uitvoer getoond moet worden bij het tonen van de herinnering. U kunt ook de kleur van het herinneringsbericht kiezen, of er een geluid afgespeeld moet worden en of het bericht voorgelezen moet worden.</para>

<para
>Herinneringen kunnen ook ingesteld worden vanaf de commandoregel, of via een &DBus;-oproep vanuit een ander programma.</para>

<para
>Wanneer een herinnering afloopt, wordt er een visueel herinneringsbericht getoond op elk &kde;-bureaublad opdat u het zeker ziet. Dit berichtvenster toont de geplande tijd voor de herinnering, en het heeft meestal een uitsteloptie om de herinnering later opnieuw te laten tonen. Een voorbeeld van een herinneringsbericht:</para>

<screenshot>
<screeninfo
>Schermafbeelding van een berichtvenster van &kalarm;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="alarmmessage.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Herinneringsbericht</phrase>
</textobject>
</mediaobject>
</screenshot>

<para
>Wanneer er een commando uitgevoerd of een e-mail verzonden moet worden door de herinnering, geeft &kalarm; niets weer.</para>

<para
>Normaal staat er een pictogram van &kalarm; in het systeemvak hoewel dit, indien gewenst, verborgen kan worden.</para>

</chapter>

<chapter id="using-kalarm">
<title
>&kalarm; gebruiken</title>

<para
>Als &kalarm; uitgevoerd wordt zonder extra parameters op de commandoregel, start &kalarm; in grafische modus, en toont daarbij de huidige lijst met openstaande herinneringen.</para>

<tip
><para
>Alle schuifregelaars in &kalarm; hebben een versnelling. Om de waarden met grotere stappen te veranderen: druk op &Shift; en klik op één van depijltjes van de schuifregelaar.</para>

<mediaobject>
<imageobject>
<imagedata fileref="spinbox.png" format="PNG"/>
</imageobject>
</mediaobject>
</tip>

<sect1 id="alarm-types">
<title
>Typen herinneringen</title>

<para
>De beschikbare basisfuncties in &kalarm; voor verschillende typen herinneringen zijn:</para>

<itemizedlist>
<listitem>
<para
>Herinneringen kunnen getoond worden met een tekstbericht dat u intypt, met de inhoud van een tekst- of beeldbestand, of met de tekstuitvoer van een commando dat uitgevoerd wordt op het moment dat de herinneringstijd bereikt wordt. Daarbij kan er ook een audiobestand afgespeeld worden, tekst voorgelezen worden of een bieptoon uitgestuurd worden. U kunt eveneens commando's instellen die uitgevoerd moeten worden voordat en nadat het herinneringsbericht getoond wordt.</para>
</listitem>

<listitem>
<para
>Commandoherinneringen voeren ofwel een enkel commando ofwel een shellscript uit (door u ingetypt). Er wordt bij zo'n herinnering niets getoond, behalve als er een fout optreedt.</para>
</listitem>

<listitem>
<para
>Herinneringen via e-mail verzenden een e-mail. Er wordt niets getoond, behalve als er een fout optreedt.</para>
</listitem>

<listitem>
<para
>Audioherinneringen spelen een audio-bestand af. Er wordt niets getoond, behalve als er een fout optreedt.</para>
</listitem>
</itemizedlist>

<sect2 id="errors">
<title
>Afhandelen van fouten</title>

<para
>Wanneer er een fout optreedt bij het uitvoeren van een herinnering, wordt er een foutmelding getoond (behalve als u ervoor hebt ingesteld dat dat type berichten niet meer getoond moet worden).</para>

<para
>Als er de laatste keer bij het uitvoeren van een commandoherinnering een fout optrad, wordt er een wit-op-rood uitroepteken getoond in de kolom met kleuren bij de berichten. Details van de fout worden weergegeven in een tekstballon wanneer u uw muisaanwijzer op die regel in de lijst met herinneringen zet. Dezelfde foutmeldingen worden getoond bij schermherinneringen als er een uitvoerfout optrad bij een commando voor of na het alarm (zoals gedefinieerd in het dialoogvenster Speciale Acties), maar hier zonder de rode achtergrond in de kleurenkolom.</para>

</sect2>
</sect1>

<sect1 id="alarm-list">
<title
>Herinneringslijst</title>

<para
>Het hoofdvenster van &kalarm; toont de huidige lijst met openstaande herinneringen. Daarbij worden ook de tijden, de herhalingsintervallen en kleuren getoond, en ook de berichttekst, de naam van de bestanden die afgespeeld of getoond moeten worden, het commando dat uitgevoerd moet worden, of het onderwerp van de e-mail. (Voor een terugkerende herinnering wordt de tijd getoond waarop de eerstvolgende keer de herinnering plaatsvindt. Voor een herinnering met een herinnering vooraf, wordt de tijd getoond van de herinnering zelf, niet van de herinnering vooraf.) Een pictogram links van elke herinneringstekst/bestand/commando/e-mailonderwerp duidt het type herinnering aan.</para>

<screenshot>
<screeninfo
>Schermafbeelding van het hoofdvenster van &kalarm;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainwindow.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Hoofdvenster</phrase>
</textobject>
</mediaobject>
</screenshot>

<para
>In de lijst worden van herhaalde herinneringen deeerstvolgende keer dat ze plaatsvinden, en ook het basis herhalingsinterval getoond (&eg; <quote
>1 dag</quote
> voor iets dat dagelijks terugkomt, <quote
>3 weken</quote
> voor een herinnering die om de 3 weken maandag en woensdag voorkomt, of <quote
>aanmelden</quote
> voor een herinnering die herhaald wordt elke keer dat u zich aanmeldt).</para>

<para
>Als er de laatste keer bij het uitvoeren van een commandoherinnering, of van een pre- of postherinneringscommando, een fout optrad, wordt er een foutmelding getoond in de kleurenkolom, wat u hierboven kunt terugvinden in <link linkend="errors"
>Afhandelen van fouten</link
>.</para>

<sect2 id="listappear">
<title
>Het uiterlijk van de herinneringslijst veranderen</title>

<para
>De herinneringen kunnen gesorteerd worden op datum/tijd, herhalingsinterval, kleur, type of tekst door te klikken op de titelbalk van de desbetreffende kolom. Om de sortering om te keren klikt u nogmaals op de titelbalk van dezelfde kolom.</para>

<para
>Optioneel kunt u ook de resterende tijd tot een herinnering laten tonen, samen met, of in plaats van, de geplande tijd van de herinnering. Om de tijdskolom van de herinneringen te tonen of te verbergen, gaat u naar <menuchoice
><guimenu
>Beeld</guimenu
><guimenuitem
>Tijdstippen herinneringen tonen</guimenuitem
></menuchoice
>. Om de kolom met de resterende tijd te tonen of te verbergen, klikt u op <menuchoice
><guimenu
>Beeld</guimenu
><guimenuitem
>Resterende tijd tot herinneringen tonen</guimenuitem
></menuchoice
>. Er wordt steeds minstens één van de kolommen getoond.</para>

<para
>Als u meerdere kalenders gebruikt, kunt u een achtergrondkleur instellen voor kalenders. De bijbehorende herinneringen zullen dan ook die kleurcode krijgen.</para>

</sect2>

<sect2 id="expired">
<title
>Gearchiveerde herinneringen</title>

<para
>Standaard archiveert &kalarm; herinneringen voor een beperkte tijd wanneer ze verwijderd of verlopen zijn. (Opmerking: herinneringen die verwijderd zijn, worden enkel bijgehouden als ze reeds minstens één keer plaatsgevonden hebben.) U kunt instellen of &kalarm; herinneringen bijhoudt, en voor hoe lang, in het <link linkend="preferences-storage"
> Configuratievenster</link
>.</para>

<para
>Verlopen herinneringen kunnen toch getoond worden in de herinneringslijst door te klikken op <menuchoice
><guimenu
>Beeld</guimenu
><guimenuitem
> Verlopen herinneringen tonen</guimenuitem
></menuchoice
>. Om deze herinneringen terug te verbergen, klikt u nogmaals op hetzelfde item in het menu.</para>

</sect2>

<sect2 id="search">
<title
>Zoeken in de herinneringslijst</title>

<para
>U kunt de herinneringslijst doorzoeken om herinneringen te vinden die de zoektekst bevatten. Om deze functie op te starten, klikt u op <menuchoice
> <guimenu
> Bewerken</guimenu
><guimenuitem
> Zoeken...</guimenuitem
></menuchoice
>. In het dialoogvenster dat dan verschijnt, kunt u de typen herinneringen selecteren waarnaar gezocht moet worden. Om andere zoekresultaten te vinden kunt u <menuchoice
> <guimenu
>Bewerken</guimenu
><guimenuitem
>Volgende zoeken</guimenuitem
></menuchoice
> of <menuchoice
> <guimenu
>Bewerken</guimenu
><guimenuitem
>Vorige zoeken</guimenuitem
> </menuchoice
> aanklikken.</para>

<para
>Het zoeken wordt als volgt uitgevoerd:</para>

<itemizedlist>
<listitem>
<para
>Herinneringen met tekstbericht: de berichttekst wordt doorzocht.</para>
</listitem>

<listitem>
<para
>Herinneringen die een bestand tonen: er wordt gezocht in het bestandspad/&URL;.</para>
</listitem>

<listitem>
<para
>Commandoherinneringen: er wordt gezocht in het commando of het commandoscript.</para>
</listitem>

<listitem>
<para
>Herinneringen via e-mail: er wordt gezocht in het onderwerp en de inhoud van de e-mail, maar ook in de ontvanger(s), en de URL's van bijlagen.</para>
</listitem>

<listitem>
<para
>Audioherinneringen: er wordt gezocht in het bestandspad/&URL;.</para>
</listitem>
</itemizedlist>

<note
><para
>Men kan enkel herinneringen die momenteel getoond worden in de herinneringslijst selecteren om in te zoeken. Als u dus eveneens in de verlopen herinneringen wilt zoeken, moet u ze eerst zichtbaar maken (zie hierboven).</para
></note>
</sect2>
</sect1>

<sect1 id="create-edit">
<title
>Herinneringen aanmaken en bewerken</title>

<sect2>
<title
>Een nieuwe herinnering aanmaken</title>

<para
>Om een nieuwe herinnering aan te maken, moet u één van volgende stappen doen, en dan het type herinnering selecteren uit de lijst die tevoorschijn komt. Dit toont het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
>, waarin u herinneringen kan instellen.</para>

<itemizedlist>
<listitem>
<para
><menuchoice
><guimenu
>Bestand</guimenu
> <guimenuitem
>Nieuw</guimenuitem
></menuchoice
> selecteren.</para>
</listitem>

<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op het pictogram in het systeemvak en <menuchoice
><guimenuitem
>Nieuwe herinnering</guimenuitem
></menuchoice
> kiezen uit het contextmenu.</para>
</listitem>

<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken in de herinneringslijst, dan <menuchoice
><guimenuitem
>Nieuw</guimenuitem
></menuchoice
> kiezen uit het contextmenu.</para>
</listitem>
</itemizedlist>

<para
>Anders kunt u nieuwe herinneringen aanmaken door gebruik te maken van op voorhand geconfigureerde herinneringen uit verschillende bronnen:</para>

<itemizedlist>
<listitem>
<para
>Volg, om een nieuwe herinnering te baseren op een herinneringssjabloon, de instructies in het deel <link linkend="templates"
>Herinneringssjablonen</link
>.</para>
</listitem>

<listitem>
<para
>Om een nieuwe herinnering te baseren op een reeds bestaande herinnering, markeer de bestaande herinnering in de lijst, en selecteer <menuchoice
> <guimenu
>Bestand</guimenu
><guimenuitem
>Kopiëren</guimenuitem
></menuchoice
>. Dit opent het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
>, met de details van de geselecteerde herinnering reeds ingevuld.</para>
</listitem>

<listitem>
<para
>Sleep, om een nieuwe herinnering te creëren die een reeds bestaande e-mail toont, de juiste e-mail vanuit &kmail; naar het hoofdvenster van &kalarm;, of naar het pictogram van &kalarm; in het systeemvak. Dit opent het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
> met als herinneringstekst het hele e-mailbericht (inclusief de afzender, de ontvanger, &etc;).</para>
</listitem>

<listitem>
<para
>Sleep, om een nieuwe herinnering te creëren die een kopie verzendt van een reeds bestaand e-mailbericht, de originele e-mail vanuit &kmail; naar het hoofdvenster van &kalarm; of naar het pictogram van &kalarm; in het systeemvak. Selecteer dan de <guilabel
>E-mail</guilabel
>-optie. Het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
> zal dan reeds het hele e-mailbericht bevatten, uitgezonderd de afzender.</para>
</listitem>

<listitem>
<para
>Sleep, om een nieuw herinnering aan te maken die een samenvatting toont van een reeds bestaande taak, de taak vanuit &korganizer; of een andere applicatie naar het hoofdvenster van &kalarm; of naar het pictogram van &kalarm; in het systeemvak. Dit opent het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen tebewerken</link
> met de taakinhoud als herinneringstekst.</para>
</listitem>

<listitem>
<para
>U kunt eender welk stuk tekst naar het hoofdvenster van &kalarm; of naar het pictogram van &kalarm; in het systeemvak slepen, waarop het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen tebewerken</link
> geopend wordt, met als herinneringstekst dat stuk tekst.</para>
</listitem>

<listitem>
<para
>Sleep, om een herinnering aan te maken die een bestand toont, de &URL; van het tekst- of afbeeldingsbestand naar het hoofdvenster van &kalarm; of naar het pictogram van &kalarm; in het systeemvak. Dit opent het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
> en vult daar de bestandsnaam voor u in.</para>
</listitem>

<listitem>
<para
>Sleep, om een audioherinnering aan te maken, de &URL; van het audiobestand naar het hoofdvenster van &kalarm; of naar het pictogram van &kalarm; in het systeemvak. Dit open het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
> en stelt de bestandsnaam daar voor u in.</para>
</listitem>

<listitem>
<para
>U kunt automatisch herinneringen voor verjaardagen laten aanmaken voor mensen die in het &kaddressbook; staan. Instructies kunt u terugvinden in <link linkend="birthdays"
>Verjaardagen importeren uit &kaddressbook;</link
>.</para>
</listitem>

</itemizedlist>

</sect2>

<sect2 id="edit-alarm">
<title
>Een bestaande herinnering aanpassen</title>

<para
>Om een openstaande herinnering aan te passen (verstreken herinneringen kunnen niet aangepast worden), zijn er volgende mogelijkheden:</para>

<itemizedlist>
<listitem>
<para
>Dubbelklikken op de juiste regel in de herinneringslijst.</para>
</listitem>

<listitem>
<para
>De herinnering selecteren door te klikken op de regel in de herinneringslijst. Daarna op <menuchoice
><guimenu
>Bewerken</guimenu
> <guimenuitem
>Bewerken...</guimenuitem
></menuchoice
> klikken.</para>
</listitem>

<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op de juiste regel in de herinneringslijst en dan op <menuchoice
><guimenuitem
>Bewerken...</guimenuitem
> </menuchoice
> klikken in het contextmenu.</para>
</listitem>
</itemizedlist>

<para
>Dit toont het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
>.</para>

</sect2>

<sect2>
<title
>Een herinnering verwijderen/opnieuw activeren</title>

<para
>Om bestaande herinneringen te verwijderen, selecteert u één of meer herinneringen door te klikken op de juiste regels in de herinneringslijst. Dan zijn er volgende mogelijkheden:</para>

<itemizedlist>
<listitem>
<para
>Op <menuchoice
> <guimenu
>Bewerken</guimenu
><guimenuitem
>Verwijderen</guimenuitem
> </menuchoice
> klikken.</para>
</listitem>
<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op de geselecteerde rijen en op <menuchoice
><guimenuitem
>Verwijderen</guimenuitem
></menuchoice
> klikken in het contextmenu.</para>
</listitem>
<listitem>
<para
>&Shift;-<keycap
>Delete</keycap
> indrukken om ze te verwijderen zonder bevestiging.</para>
</listitem>
</itemizedlist>

<para
>Als u een actieve herinnering verwijdert, wordt deze gearchiveerd als dezereeds ten minste één maal uitgevoerd is geweest voor het verwijderen, en als ingesteld is dat verlopen alarmen gearchiveerd moeten worden. (Gebruik het<link linkend="preferences-storage"
>Configuratievenster</link
> om in te stellen of, en hoe lang gearchiveerde herinneringen bijgehouden moeten worden.) Als u een gearchiveerde of een nog niet uitgevoerde openstaande herinnering verwijderd, wordt deze permanent verwijderd.</para>

<para
>Als de herinnering nog niet verlopen is, kunt u een gearchiveerde herinnering in de herinneringslijst terug activeren. Om dit te bereiken, moet u eerst de gearchiveerde herinneringen zichtbaar maken, zoals beschreven in<link linkend="expired"
>Gearchiveerde herinneringen</link
>. Dan:</para>

<itemizedlist>
<listitem>
<para
>Een of meerdere gewenste gearchiveerde herinneringen selecteren in de herinneringslijst door erop te klikken. Dan op <menuchoice
> <guimenu
>Acties</guimenu
><guimenuitem
>Reactiveren</guimenuitem
> </menuchoice
> klikken.</para>
</listitem>
<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op de gewenste regels in de lijst met verlopen herinneringen en op <menuchoice
><guimenuitem
>Reactiveren</guimenuitem
></menuchoice
> klikken in het contextmenu.</para>
</listitem>
</itemizedlist>

</sect2>

<sect2>
<title
>Een herinnering in- of uitschakelen</title>

<para
>Zie <link linkend="enable-disable"
>Herinneringen in- of uitschakelen</link
>om te weten te komen hoe herinneringen in- of uitgeschakeld moeten worden, zowel totaal als individueel.</para>

</sect2>

<sect2>
<title
>Een herinnering bevestigen</title>

<para
>Zie <link linkend="message-window"
>Berichtvenster voor herinneringen</link
> om te weten te komen hoe een alarm bevestigd moet worden.</para>

</sect2>

<sect2 id="templates">
<title
>Herinneringssjablonen</title>

<para
>Als u regelmatig gelijkaardige herinneringen wilt instellen, kunt u een herinneringssjabloon creëren om te vermijden dat u elke keer alle details opnieuw moet intypen. Een sjabloon kan alle mogelijke details voor een herinnering bevatten, behalve de aanvangsdatum.</para>

<para
>Bijvoorbeeld: u wilt regelmatig herinnerd worden aan een televisieprogramma waarvan de tijd van week tot week varieert. Het sjabloon kan dan alle herinneringsdetails bevatten (berichttekst, of er een geluid afgespeeld moet worden, &etc;) uitgezonderd datum en tijd. Als u dan nu zo'n herinnering wilt aanmaken, opent u gewoon het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen tebewerken</link
> met het sjabloon, en vult u de datum en de tijd in.</para>

<para
>Om een herinnering te creëren die gebaseerd is op een sjabloon, opent u het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
>, met de sjabloondetails reeds ingesteld.</para>

<itemizedlist>
<listitem>
<para
>In het menu het item <menuchoice
> <guimenu
>Bestand</guimenu
> <guimenuitem
>Nieuw van sjabloon</guimenuitem
> </menuchoice
> selecteren, en dan het gewenste sjabloon selecteren.</para>
</listitem>

<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op het pictogram in het systeemvak en<menuchoice
><guimenuitem
>Nieuwe herinnering van sjabloon</guimenuitem
> </menuchoice
> selecteren in het contextmenu. Dan het gewenste sjabloon selecteren.</para>
</listitem>

<listitem>
<para
>Het <link linkend="alarm-edit-dlg"
>Dialoogvenster om herinneringen te bewerken</link
> openen op de gewone manier, en op de knop <guibutton
>Sjabloon laden...</guibutton
> klikken om een sjabloon te selecteren zodat de herinnering de gewenste gegevens bevat.</para>
</listitem>
</itemizedlist>

<sect3>
<title
>Sjablonen instellen</title>

<para
>U kunt sjablonen creëren, aanpassen of verwijderen met behulp van het dialoogvenster Herinneringssjablonen, of u kunt een nieuw herinneringssjabloon aanmaken op basis van een reeds bestaande herinnering.</para>

<para
>Om een nieuw herinneringssjabloon te maken, zijn er volgende mogelijkheden:</para>

<itemizedlist>
<listitem>
<para
>Het dialoogvenster voor herinneringssjablonen wordt getoond door in het menu <menuchoice
><guimenu
>Bestand</guimenu
> <guimenuitem
>Sjablonen...</guimenuitem
> </menuchoice
> aan te klikken; daarna klikt u op <guibutton
>Nieuw</guibutton
> en kiest u het herinneringstype uit de getoonde lijst. Hiermee opent u een dialoogvenster met een leeg sjabloon dat u kunt invullen.</para>
</listitem>

<listitem>
<para
>Het dialoogvenster voor herinneringssjablonen laten tonen door in het menu <menuchoice
> <guimenu
>Bestand</guimenu
> <guimenuitem
>Sjablonen...</guimenuitem
> </menuchoice
> aan te klikken; daarna selecteert u een reeds bestaand sjabloon uit de lijst, en klikt u op <guibutton
>Kopiëren</guibutton
>. Hierdoor wordt het dialoogvenster om herinneringssjablonen te bewerken geopend, ingevuld met de gegevens van het reeds bestaande sjabloon.</para>
</listitem>

<listitem>
<para
>Een herinnering aanduiden in de herinneringslijst en <menuchoice
> <guimenu
>Bestand</guimenu
><guimenuitem
>Nieuw sjabloon maken...</guimenuitem
></menuchoice
> selecteren. Hierdoor wordt het dialoogvenster om herinneringssjablonen te bewerken geopend, met een kopie van de gegevens van de geselecteerde herinnering.</para>
</listitem>
</itemizedlist>

<para
>Om een reeds bestaand sjabloon te bewerken, opent u het dialoogvenster herinneringssjablonen door het item <menuchoice
> <guimenu
>Bestand</guimenu
> <guimenuitem
>Sjablonen...</guimenuitem
> </menuchoice
>  in het menu te selecteren, en dan op de knop <guibutton
>Bewerken</guibutton
> te klikken. Hierdoor wordt het dialoogvenster om herinneringsjablonen te bewerken getoond, zoals hieronder beschreven.</para>

<para
>Om bestaande sjablonen te verwijderen, opent u het dialoogvenster herinneringssjablonen door op <menuchoice
> <guimenu
>Bestand</guimenu
> <guimenuitem
>Sjablonen...</guimenuitem
> </menuchoice
> te klikken, dan een of meerdere sjablo(o)n(en) te selecteren en op <guibutton
>Verwijderen</guibutton
> te klikken. Er wordt steeds een bevestiging gevraagd om te voorkomen dat sjablonen per ongeluk verwijderd worden.</para>

</sect3>

<sect3>
<title
>Dialoogvenster om sjablonen te bewerken</title>

<para
>Het dialoogvenster om sjablonen te bewerken is gelijkaardig aan het <link linkend="alarm-edit-dlg"
>Het dialoogvenster om alarmen te bewerken</link
>. De volgende punten zijn anders:</para>

<itemizedlist>
<listitem>
<para
>De naam van de sjabloon invoeren in <guilabel
>Naam sjabloon</guilabel
>. Deze naam wordt getoond in lijsten waar u sjablonen moet selecteren, dus u kunt best een naam kiezen die u herinnert aan de functie van de sjabloon. Elke sjabloonnaam moet uniek zijn.</para>
</listitem>

<listitem>
<para
>In het kader <guilabel
>Tijd</guilabel
> moet u een van volgende mogelijkheden selecteren:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Standaard tijd</guilabel
> als u geen uitvoertijd wilt specificeren.Herinneringen die dan op dit sjabloon gebaseerd worden, zullen in het begin de standaard uitvoertijd gebruiken, die ook bij nieuwe herinneringen gebruikt wordt.</para>
</listitem>

<listitem>
<para
><guilabel
>Tijd</guilabel
> selecteren om een tijd in te voeren waarop de herinnering uitgevoerd moet worden.</para>
</listitem>

<listitem>
<para
><guilabel
>Alleen datum</guilabel
> selecteren om aan te geven dat de herinnering enkel een datum zal bevatten, en geen tijd.</para>
</listitem>

<listitem>
<para
><guilabel
>Tijdsduur vanaf nu</guilabel
> om in te voeren hoe lang (in uren en minuten) het duurt, vanaf het moment dat een herinnering gecreëerd is, voordat deze uitgevoerd wordt.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>In het vak <guilabel
>Herhalingsregel</guilabel
> in de tab <guilabel
>Herhaling</guilabel
> moet er geen dag of maand gekozen worden voor respectievelijk wekelijkse of jaarlijkse herhalingen.</para>
</listitem>
</itemizedlist>

</sect3>

</sect2>

<sect2 id="calendars">
<title
>Agenda's met herinneringen</title>

<para
>Als u maar één computer gebruikt, en onafhankelijk werkt, maakt het waarschijnlijk niet uit waar de herinneringen van &kalarm; opgeslagen worden. Maar als u de herinneringen vanaf meer dan één computer moet kunnen bereiken, of op meerdere locaties op uw lokale computer, kunt u <quote
>agenda's met herinneringen</quote
> instellen om &kalarm; duidelijk te maken dat er andere agenda's met herinneringen gebruikt moeten worden in plaats van, of als toevoeging aan de standaardagenda's.</para>

<para
>U kunt agenda's bekijken en veranderen via de agendalijst, welke getoond kan worden naast de herinneringslijst in &kalarm;s hoofdvenster. Herinneringen van andere herinneringsagenda's worden samen getoond in de herinneringslijst. Als u een nieuwe herinnering opslaat, kunt u een optie instellen om te kiezen of de nieuwe herinnering opgeslagen moet worden in de standaard agenda, of dat er gevraagd moet worden in welke agenda deze nieuwe herinnering opgeslagen moet worden. Als u een reeds bestaande herinnering bewerkt, wordt deze automatisch terug opgeslagen in de agenda waar de oorspronkelijke herinnering vandaan kwam.</para>

<screenshot>
<screeninfo
>Schermafbeelding van het hoofdvenster van &kalarm;, waarin de agendalijst getoond wordt</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainwindow-calendars.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Hoofdvenster waarin de agendalijst getoond wordt</phrase>
</textobject>
</mediaobject>
</screenshot>

<sect3>
<title
>Typen agenda's en opties</title>

<para
>Herinneringsagenda's wordt ingedeeld op basis van herinneringstype en opslagtype. Ze kunnen uitgeschakeld worden, als alleen-lezen ingesteld worden, of als standaardagenda ingesteld worden voor een bepaald herinneringstype.</para>

<variablelist>
<varlistentry>
<term
>Type herinnering</term>
<listitem>
<para
>De drie typen herinneringen &ndash; actieve herinneringen, verlopen herinneringen en herinneringssjablonen &ndash; worden opgeslagen in aparteherinneringsagenda's. Daarom heeft &kalarm; standaard drie aparte agenda's, één voor elk type (zie het deel <link linkend="faq"
>Vragen en Antwoorden</link
> voor meer details), welke u kunt veranderen indien u datwenst.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
>Type opslag</term>
<listitem>
<para
>&kalarm; kent 3 manieren om herinneringsagenda's op te slaan:</para>

<itemizedlist>
<listitem
><para
>Lokaal bestand: Herinneringen worden opgeslagen in een enkel, lokaal bestand in het iCalendar-formaat. Standaard slaat &kalarm; zijn agenda's op in een lokaal bestand (zie <link linkend="faq"
>Vragen en Antwoorden</link
> voor meer details). <quote
>Lokale bestanden</quote
> kunnen gewoon op de lokale computer staan, maar ook op het lokale netwerk opgeslagen worden, zolang hun locatie maar voorgesteld kan worden als een pad beginnend met <literal
>/</literal
>.</para>
</listitem>

<listitem
><para
>Lokale map: hierbij worden herinneringen opgeslagen in een lokale map, waarbij elke herinnering in die map opgeslagen wordt als een apart iCalendar-bestand. Het voordeel hiervan is dat bij een corrupt bestand, er maar één herinnering beschadigd wordt, en niet de hele agenda.</para>
</listitem>

<listitem
><para
>Extern bestand: herinneringen worden in een enkel extern bestand opgeslagen, in het iCalendar-formaat. Hierdoor kunt u altijd toegang op afstand  toegang krijgen naar uw herinneringen, zonder dat het uitmaakt waar u zich bevindt. Dit geeft ook de mogelijkheid om andere mensen toegang te verlenen tot die herinneringen. Wanneer u externe bestanden gebruikt, werkt &kalarm; met een lokale cache van de data.</para>

<warning
><para
>Als een externe herinneringsagenda gedeeld wordt door meerdere gebruikers, kan het voorkomen dat veranderingen die gemaakt worden door één persoon niet automatisch beschikbaar zijn voor andere personen, of dat er een vertraging is voordat andere gebruikers ze zien. Het kan dus gebeuren dat een gebruiker een verandering maakt, welke daarna overschreven wordt door een andere gebruiker, zonder dat één van de gebruikers opmerkt wat er gebeurd is. De technische uitleg hiervoor: een verandering gemaakt door persoon A zal niet beschikbaar zijn voor persoon B totdat de kopie in cache bij persoon A extern opgeslagen wordt, en de kopie in cache bij persoon B bijgewerkt is met de gegevens in het externe bestand. Of en wanneer een lokale kopie bijgewerkt of extern opgeslagen wordt, hangt af van de configuratieparameters van de agenda, welke apart ingesteld worden door elke gebruiker.</para>

<para
>Om dit te vermijden, kunt u de configuratieparameters om agenda's extern op te slaan of bij te werken, aanpassen. Een andere mogelijkheid is dat er afspraken gemaakt worden met andere personen die niet de eigenaar van de agenda zijn, bijvoorbeeld dat zij die herinneringsagenda alleen openen in de modus alleen-lezen.</para
></warning>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>

<varlistentry>
<term
>Status in- of uitgeschakeld</term>
<listitem>
<para
>Een agenda uitschakelen heeft hetzelfde effect als deze te verwijderen, behalve dat deze blijft staan in de agendalijst, zodat het gemakkelijk is om deze terug te activeren. Als een agenda uitgeschakeld is, worden alle herinneringen in de agenda genegeerd, en verschijnen ze dus ook niet in de herinneringslijst of de lijst met sjablonen. Als een agenda terug ingeschakeld wordt, worden de erin aanwezige herinneringen één keer terug getoond, en, als het een actieve herinneringsagenda is, terug actief gemaakt.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
>Status alleen-lezen</term>
<listitem>
<para
>Herinneringen kunnen niet toegevoegd worden aan, of bewerkt worden in een alleen-lezen agenda. U kunt de erin aanwezig herinneringen dus niet bewerken, en er ook geen nieuwe herinneringen in opslaan. Het is eveneens niet mogelijk om herinneringen uit te stellen, aangezien de uitsteltijd dan opgeslagen moet worden in de herinnering. Als er een alarm uitgevoerd is, wordt deze niet verwijderd uit de agenda en gearchiveerd, totdat uzelf of een andere gebruiker de agenda opent in de modus lezen/schrijven.</para>

<para
>U kunt de status alleen-lezen instellen in het dialoogvenster om agenda's te configureren. Toch kunnen sommige agenda's niet beschrijfbaar gemaakt worden wegens volgende redenen:</para>

<itemizedlist>
<listitem
><para
>Als een agenda gecreëerd werd door een andere applicatie, is het niet veilig om &kalarm; toe te staan de agenda bij te werken, omdat verschillen in het formaat ervoor kunnen zorgen dat de agenda onbruikbaar wordt voor de applicatie die deze oorspronkelijk gecreëerd heeft.</para>
</listitem>

<listitem
><para
>Als de agenda gecreëerd werd door een recentere versie van &kalarm; kunnen er gegevens verloren gaan als uw versie van &kalarm; de agenda bijwerkt.</para>
</listitem>

<listitem
><para
>Als de agenda gecreëerd werd door een oudere versie van &kalarm;, kunnen er gegevens verloren gaan, of zelfs onbruikbaar worden voor de oudere versie van &kalarm; wanneer uw versie van &kalarm; de agenda bijwerkt. Er zal u gevraagd worden of het formaat omgezet moet worden om het beschrijfbaar te maken, maar houdt daarbij in gedachte dat er mogelijk compatibiliteitsproblemen ontstaan als een oudere versie van &kalarm; de gegevens terug wilt benaderen.</para>
</listitem>

<listitem
><para
>Als u geen toelating hebt om te schrijven naar het bestand of de map met de agenda.</para>
</listitem>
</itemizedlist>

<para
>Als u schrijftoegang nodig hebt naar de herinneringen in een agendabestand dat niet beschrijfbaar is, dan kunt u de herinneringen kopiëren door ze te importeren in een beschrijfbaar agendabestand met de volgende contextmenuoptie <menuchoice
><guimenuitem
>Importeren...</guimenuitem
></menuchoice
> van de agenda (zie <link linkend="import"
>Herinneringen importeren uit externe agaenda's</link
>).</para>
</listitem>
</varlistentry>

<varlistentry>
<term
>Standaard agendastatus</term>
<listitem>
<para
>Eén agenda per herinneringstype kan eventueel als standaardagenda voor dat herinneringstype gebruikt worden. Nieuwe herinneringen worden automatisch opgeslagen in de standaardagenda van dat herinneringstype, behalve wanneer u ervoor gekozen hebt een keuzevenster te laten zien voor nieuwe herinneringen en sjablonen in de <link linkend="preferences-storage"
>instellingendialoog</link
>.</para>
</listitem>
</varlistentry>
</variablelist>

</sect3>

<sect3>
<title
>Agenda's gebruiken</title>

<para
>U kunt agenda's bekijken en aanpassen m.b.v. de agendalijst, welke getoond of verborgen kan worden door <menuchoice
> <guimenu
>Beeld</guimenu
> <guimenuitem
>Agenda's tonen</guimenuitem
> </menuchoice
>. Wanneer u de agendalijst gebruikt, moet u eerst het herinneringstype selecteren m.b.v. het afrolmenu bovenaan de lijst. Daarna kunt u ofwel op één van de knoppen onderaan de lijst klikken, ofwel <mousebutton
>rechts</mousebutton
> klikken op de juiste agenda in de lijst, en een item selecteren uit het contextmenu. De beschikbare acties zijn:</para>

<variablelist>
<varlistentry>
<term
><menuchoice
><guimenuitem
>Toevoegen...</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Een agenda van het geselecteerde type toevoegen aan de lijst. Er wordt u gevraagd een opslagmethode te kiezen, waarna de instellingendialoog van een agenda wordt getoond, waarin u de lokatie van het agendabestand en zijn karakteristieken kunt invoeren. Als er geen bestaande agenda voor herinneringen is, dan wordt er een aangemaakt.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Verwijderen</guimenuitem
></menuchoice
></term>
<listitem>
<para
>De geselecteerde agenda uit de lijst verwijderen. Het agendabestand zelf wordt intact gelaten; ze wordt enkel uit de lijstweergave verwijderd en kan dus later eventueel teruggeplaatst worden in de lijst.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Bewerken...</guimenuitem
></menuchoice
></term>
<listitem>
<para
>De geselecteerde agenda bewerken. Dit toont de instellingendialoog voor de geselecteerde agenda.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Herladen</guimenuitem
></menuchoice
></term>
<listitem>
<para
>De geselecteerde agenda herladen. De agenda wordt opnieuw ingelezen vanuit de opslaglocatie, zodat er verzekerd wordt dat er geen verschillen zijn tussen wat &kalarm; toont, en wat er momenteel reëel in de agenda staat. Als de agenda gedeeld wordt door meerdere gebruikers, zullen alle veranderingen die ze hebben doorgevoerd, nu eveneens getoond worden door &kalarm;.</para>

<warning
><para
>Als u een agenda op afstand herlaadt, zullen al uw wijzigingen sinds de agenda de laatste keer werd opgeslagen verloren gaan. Ook is het mogelijk dat herinneringen die verlopen zijn sinds de laatste opslag, opnieuw uitgevoerd worden.</para
></warning>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Opslaan</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Alle veranderingen aan de geselecteerde agenda opslaan. De agenda wordt dan bijgewerkt met alle veranderingen in de herinneringen sinds de laatste keer dat de agenda opgeslagen of herladen werd. Dit is enkel nodig voor agenda's op afstand, omdat lokale agenda's direct automatisch opgeslagen worden na elke verandering. U kunt instellen wanneer en hoe vaak een agenda op afstand automatisch opgeslagen moet worden, door gebruik te maken van de instellingendialoog (met de optie <menuchoice
> <guimenuitem
>Bewerken...</guimenuitem
></menuchoice
> in het contextmenu).</para>

<warning
><para
>Als u een agenda op afstand, die gedeeld wordt met andere gebruikers, opslaat, gaan alle veranderingen die de anderen gemaakt hebben sinds u de laatste keer de agenda herlaadde (automatisch of handmatig) verloren.</para
></warning>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Importeren...</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Herinneringen importeren uit een extern agendabestand in de geselecteerde agenda. Dit wordt verder uitgelegd in <link linkend="import"
>Importeren van herinneringen uit externe agenda's</link
>. Deze mogelijkheid is niet beschikbaar voor uitgeschakelde of alleen-lezen agenda's.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Exporteren...</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Alle herinneringen in de geselecteerde agenda exporteren naar een extern agendabestand. Dit wordt verder uitgelegd in <link linkend="export"
>Exporteren van herinneringen naar externe agenda's.</link
>. Deze mogelijkheid is niet beschikbaar voor uitgeschakelde agenda's.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Details tonen</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Details tonen van de geselecteerde agenda. Dit toont de locatie van de agenda, het opslagtype en statusinformatie.  </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Als standaard gebruiken</guimenuitem
></menuchoice
></term>
<listitem>
<para
>De geselecteerde agenda als standaard instellen voor het geselecteerde agendatype. Deze mogelijkheid is niet beschikbaar voor uitgeschakelde of alleen-lezen agenda's.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Kleur instellen...</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Een achtergrondkleur selecteren voor het markeren van de herinneringen uit deze agenda in de lijst met herinneringen. Op deze manier ziet u direct bij welke agenda bepaalde herinneringen behoren.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Kleur weghalen</guimenuitem
></menuchoice
></term>
<listitem>
<para
>Clear color highlighting for this calendar's alarms in the alarm list.</para>
</listitem>
</varlistentry>
</variablelist>

</sect3>

</sect2>

<sect2 id="import">
<title
>Importeren van herinneringen uit externe agenda's</title>

<para
>U kunt herinneringen uit andere agendabestanden importeren in &kalarm;. Het importeren scant het geselecteerde agendabestand naar gebeurtenissen die herinneringen bevatten, en kopieert hen (met nieuwe unieke ID's) naar de agenda van &kalarm;. Gebeurtenissen zonder herinneringen, en agenda-items die geen gebeurtenissen zijn, worden genegeerd. U kunt herinneringen op twee manieren importeren:</para>

<itemizedlist>
<listitem>
<para
>Gebruik <menuchoice
><guimenu
>Bestand</guimenu
> <guimenuitem
>Herinneringen importeren...</guimenuitem
></menuchoice
> om herinneringen van alle types (actieve herinneringen, verlopen herinneringen en herinneringssjablonen) te importeren uit de agenda.</para>

<para
>Als u <link linkend="calendars"
>herinneringsagenda's</link
> geconfigureerd hebt, zullen herinneringen van elk type toegevoegd worden aan de juiste standaardagenda of als u ervoor gekozen hebt een keuzevenster te laten zien voor nieuwe herinneringen en sjablonen in de <link linkend="preferences-storage"
>instellingendialoog</link
>, zal u gevraagd worden welke agenda gebruikt moet worden.</para>
</listitem>

<listitem>
<para
><mousebutton
>Rechts</mousebutton
> klikken op een agenda in de agendalijst en <menuchoice
><guimenuitem
>Importeren...</guimenuitem
></menuchoice
> aanklikken in het contextmenu. Dit zal de herinneringen van het geselecteerde type importeren in die agenda. Als er bijvoorbeeld als agendatype herinneringssjablonen gekozen is, zullen de herinneringssjablonen (en niet de actieve of verlopen herinneringen) geïmporteerd worden.</para>
</listitem>
</itemizedlist>

<warning
><para
>Als u herinneringen importeert uit agendabestanden die aangemaakt werden door andere applicaties dan &kalarm;, kan het gebeuren dat herinneringen veranderd worden door het proces &ndash; zelfs herinneringstijden zouden kunnen veranderen. Dit hangt af van de afspraken over gegevensopslag in de andere toepassing en is dus onvermijdbaar als deze afspraken verschillen van die van &kalarm;. Controleer dus altijd de geïmporteerde herinneringen voor onverwachte veranderingen en pas ze eventueel aan.</para
></warning>

</sect2>

<sect2 id="export">
<title
>Exporting Alarms to External Calendars</title>

<para
>You can export alarms from &kalarm; to other calendar files, either the alarms currently selected in the alarm list, or all the alarms from an alarm calendar. The methods to do this are given below. Whichever method is used, you can either create a new calendar file or append the exported alarms to an existing calendar file. To append the alarms, check <guilabel
>Append to existing file</guilabel
> in the file selection dialog; otherwise, any existing file is overwritten.</para>

<itemizedlist>
<listitem>
<para
>To export the alarms currently selected in the alarm list, <mousebutton
>Right</mousebutton
> click on the selection and choose <menuchoice
><guimenuitem
>Export...</guimenuitem
></menuchoice
> from the context menu, or use <menuchoice
><guimenu
>File</guimenu
> <guimenuitem
>Export Selected Alarms...</guimenuitem
></menuchoice
> in the main menu.</para>
</listitem>

<listitem>
<para
>To export all the alarms from a calendar, <mousebutton
>Right</mousebutton
> click on a calendar in the calendar list, and choose <menuchoice
><guimenuitem
>Export...</guimenuitem
></menuchoice
> from the context menu.</para>
</listitem>
</itemizedlist>

</sect2>

<sect2 id="birthdays">
<title
>Importing Birthdays from &kaddressbook;</title>

<para
>You can set up display alarms for birthdays stored in &kaddressbook;, by <menuchoice
><guimenu
>File</guimenu
> <guimenuitem
>Import Birthdays...</guimenuitem
></menuchoice
>. This displays a dialog which allows you to select which birthdays to create alarms for.</para>

<itemizedlist>
<listitem>
<para
>In the <guilabel
>Alarm Text</guilabel
> group box, you can set up the text to be displayed in the birthday alarm messages. The message text is created by combining the <guilabel
>Prefix</guilabel
> text followed by the person's name followed by the <guilabel
>Suffix</guilabel
> text. No spaces are added, so remember to include any necessary trailing space in <guilabel
>Prefix</guilabel
> and leading space in <guilabel
>Suffix</guilabel
>.</para>

<note
><para
>If you change the alarm text, the birthday selection list will be re-evaluated.</para
></note>
</listitem>

<listitem>
<para
>In the <guilabel
>Select Birthdays</guilabel
> list, select the birthdays which you want to create alarms for. Note that the list shows only those entries in &kaddressbook; which contain a birthday and which do not already have a birthday alarm in the format currently defined in the <guilabel
>Alarm Text</guilabel
> group box.</para>
</listitem>

<listitem>
<para
>The remaining controls are the same as for <guilabel
>Text</guilabel
> alarms in the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>.</para>
</listitem>
</itemizedlist>

<para
>Als u <link linkend="calendars"
>herinnneringsagenda's</link
> hebt ingesteld, zullen de herinneringen toegevoegd worden aan de standaardagenda met de actieve herinneirngen, of als u in de <link linkend="preferences-storage"
>instellingendialoog</link
> geselecteerd hebt dat er gevraagd moet worden in welke agenda nieuwe herinneringen en sjablonen toegevoegd moeten worden, zal u gevraagd worden welke agenda u wilt gebruiken.gmen ucu  agend</para>

</sect2>

<sect2 id="undo">
<title
>Ongedaan maken/opnieuw</title>

<para
>You can undo and redo the most recent changes which you have made during the current session of &kalarm;. Most actions can be undone, including creation, edit and deletion of alarms and alarm templates, and reactivation of alarms. To prevent excessive resources being used by the undo history, the number of changes stored is limited to the last 12.</para>

<para
>To undo the last change, select <menuchoice
> <guimenu
>Edit</guimenu
><guimenuitem
>Undo</guimenuitem
></menuchoice
>. To redo the last change which was undone, select <menuchoice
> <guimenu
>Edit</guimenu
><guimenuitem
>Redo</guimenuitem
> </menuchoice
>.</para>

<para
>To undo a change other than the last one, click on the <guibutton
>Undo</guibutton
> button in the toolbar and hold the mouse button down. A list of actions will be displayed from which you can choose the one to undo. If you don't see the action which you are looking for, remember that you may need to undo more recent changes first, which the desired change depends on. For example, if you edited an alarm and then deleted it, you cannot undo the edit until you have first undone the deletion.</para>

<para
>Redoing a change other than the last one can be done in a similar manner, using the <guibutton
>Redo</guibutton
> toolbar button.</para>

</sect2>
</sect1>

<sect1 id="alarm-edit-dlg">
<title
>The Alarm Edit Dialog</title>

<para
>The Alarm Edit dialog enables you to view and edit an alarm. When you first use &kalarm;, a simplified form of the dialog is displayed, with only a small number of options visible. To see all options, click the <guibutton
>More Options</guibutton
> button; to revert to the simplified dialog, click the <guibutton
>Less Options</guibutton
> button. &kalarm; always remembers your last display choice whenever the Alarm Edit dialog is redisplayed.</para>

<para
>You can configure the default values of many of the settings in the Alarm Edit dialog using the <link linkend="preferences-edit"
>Configuration dialog's Edit tab</link
>.</para>

<screenshot>
<screeninfo
>Screenshot of the simplified Alarm Edit dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="editwindow-simple.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Simplified Alarm Edit dialog for a display alarm</phrase>
</textobject>
<caption
><para
>Simplified Alarm Edit dialog for a display alarm</para
></caption>
</mediaobject>
</screenshot>

<screenshot>
<screeninfo
>Screenshot of the Alarm Edit dialog showing all options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="editwindow.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>Alarm Edit dialog for a display alarm, showing all options</phrase>
</textobject>
<caption
><para
>Alarm Edit dialog for a display alarm, showing all options</para
></caption>
</mediaobject>
</screenshot>

<sect2>
<title
>Alarm Action</title>

<para
>The controls in the <guilabel
>Action</guilabel
> group box vary depending on the type of alarm being edited.</para>

<sect3>
<title
>Herinneringen tonen</title>

<para
>Display alarms display a window when the alarm triggers. Select the method used to generate the alarm window contents, using the combo box at the top:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Text message</guilabel
> in order to enter an alarm message text (which may include newlines) in the edit box.</para>
</listitem>

<listitem>
<para
><guilabel
>File contents</guilabel
> to enter the path or &URL; of a text or image file whose contents are to be displayed in the alarm message. Use the button beside the edit box to display a file selection dialog. The <guilabel
>Speak</guilabel
> option is not available for this type of alarm.</para>
</listitem>

<listitem>
<para
><guilabel
>Command output</guilabel
> to specify that the alarm message text will be generated by a command which is executed when the alarm triggers. See <link linkend="command-alarm"
>Command Alarms</link
> below for details of how to enter the command or command script to execute.</para>
</listitem>
</itemizedlist>

<para
>The controls available for display alarms are:</para>

<itemizedlist>
<listitem>
<para
>The <guilabel
>Sound</guilabel
> option allows you to select whether an audible alarm should sound when the alarm message is displayed. Choose:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>None</guilabel
> to display the alarm silently.</para>
</listitem>

<listitem>
<para
><guilabel
>Beep</guilabel
> to sound a beep.</para>
</listitem>

<listitem>
<para
><guilabel
>Speak</guilabel
> to have the alarm message spoken as well as being displayed. This option is only available if you have &jovie; (from the kdeaccessibility package) installed and configured, together with a compatible speech synthesizer, &eg; <application
>Festival</application
>.</para>
</listitem>

<listitem>
<para
><guilabel
>Sound file</guilabel
> to play an audio file. Use the button on the right to display the Sound File dialog which lets you select a file to play and set volume and repetition options. If you hover the mouse over the selector, a tooltip will display the audio file currently selected.</para>

<para
>In the Sound File dialog:</para>

<itemizedlist>
<listitem>
<para
>Enter the sound file path, or use the button beside the edit box to display a file selection dialog. You can listen to the selected file by clicking the play button to the left of the edit field. That button then changes function to allow you to stop playing when you have heard enough.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Repeat</guilabel
> to continually repeat the audio file for as long as the alarm is displayed. (The alarm message window contains a button to stop playing the sound should you need silence but still want to display the alarm.)</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Volume</guilabel
> and adjust the slider control if you want to adjust the volume at which the audio file is played.</para>
</listitem>

<listitem>
<para
>If you wish, you can fade the volume. Fading means to start playing the audio file at one volume and gradually change to the final volume, over a specified time interval. The final volume is that entered in <guilabel
>Volume</guilabel
> above. To enable fade, check <guilabel
>Fade</guilabel
>, and then enter the fade period in seconds in the <guilabel
>Fade time</guilabel
> field, and adjust the <guilabel
>Initial volume</guilabel
> slider.</para>
</listitem>
</itemizedlist>

<tip
><para
>You can use the <guibutton
>Try</guibutton
> button to test out the selected sound levels.</para
></tip>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>Use the <guibutton
>Font &amp; Color...</guibutton
> button to select a font, and foreground and background colors, for the alarm message. In the <guilabel
>Choose Alarm Font &amp; Color</guilabel
> dialog, check <guilabel
>Use default font</guilabel
> to display the message in whatever font is configured as the default at the time the message is displayed. To choose a specific font for the message, uncheck <guilabel
>Use default font</guilabel
>. (The default font and colors can be set in the <link linkend="preferences-edit"
>Configuration dialog</link
>.)</para>

<para
>The selected colors are shown in the alarm message text entry field.</para>
</listitem>

<listitem>
<para
>Use the <guibutton
>Special Actions...</guibutton
> button to specify shell commands to execute before or after displaying the alarm. In the <guilabel
>Special Alarm Actions</guilabel
> dialog:</para>

<itemizedlist>
<listitem>
<para
>In the <guilabel
>Pre-alarm action</guilabel
> field, enter a shell command to execute before the alarm is displayed. Note that &kalarm; will wait for the command to complete before displaying the alarm.</para>

<para
>A pre-alarm action is only executed once when the alarm message is initially displayed, including when a reminder message is replaced by the actual alarm message. It is <emphasis
>not</emphasis
> executed in any of the following circumstances:</para>

<itemizedlist>
<listitem
><para
>When a reminder message is displayed.</para
></listitem>
<listitem
><para
>When the message is redisplayed after deferring the alarm.</para
></listitem>
<listitem
><para
>When the message was displaying at the time you logged off and is then restored when you log back in.</para
></listitem>
<listitem
><para
>When a recurring alarm triggers but the alarm message (or a deferred alarm message) from a previous occurrence of the alarm is still visible; in other words, when the previous occurrence of the alarm has not yet been acknowledged.</para
></listitem>
</itemizedlist>

<para
>The pre-alarm action can be used to control whether to display the alarm message:</para>

<itemizedlist>
<listitem
><para
>Check <guilabel
>Cancel alarm on error</guilabel
> to cancel the alarm if the pre-alarm command returns an error status. This will prevent the alarm message from being displayed, and any post-alarm action from being executed.</para
></listitem>

<listitem
><para
>Normally, if the pre-alarm command returns an error, an error message is displayed and an error indication is shown in the alarm list. These error notifications can be prevented by checking <guilabel
>Do not notify errors</guilabel
>.</para
></listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>In the <guilabel
>Post-alarm action</guilabel
> field, enter a shell command to execute when the alarm is acknowledged (whether by clicking <guibutton
>Close</guibutton
> or by using the close button in the window's titlebar). It is <emphasis
>not</emphasis
> executed in any of the following circumstances:</para>

<itemizedlist>
<listitem
><para
>When a reminder message is closed.</para
></listitem>
<listitem
><para
>When you defer the alarm, except when the deferred alarm is finally acknowledged.</para
></listitem>
<listitem
><para
>When the alarm message is closed due to logging out.</para
></listitem>
</itemizedlist>
</listitem>
</itemizedlist>

<para
>See <link linkend="command-alarm"
>Command Alarms</link
> below for details of how shell commands are executed.</para>

</listitem>
</itemizedlist>
</sect3>

<sect3 id="command-alarm">
<title
>Herinneringen met shell-commando</title>

<para
>Command alarms execute a command without displaying any alarm message.</para>

<note
><para
>This alarm type is not available if &kde; is running in kiosk mode.</para
></note>

<para
>When the command is executed, the environment variable <envar
>KALARM_UID</envar
> contains the event UID for the alarm. Note that when the command is executed from the Alarm Edit dialog's <guibutton
>Try</guibutton
> button, <envar
>KALARM_UID</envar
> will be blank if it is a new alarm, or if the alarm has been modified in the dialog, because the alarm only acquires a UID when it is saved in the alarm calendar.</para>

<para
>The controls available for command alarms are:</para>

<itemizedlist>
<listitem>
<para
>The <guilabel
>Enter a script</guilabel
> check box lets you choose whether to enter a shell command line or a script.</para>

<para
>If this option is unchecked, you can enter a shell command line to execute. The command is passed straight to the default shell (defined by the <envar
>SHELL</envar
> environment variable), and may include whatever options, parameters, piped commands, &etc; are permitted by the shell in a single line command.</para>

<para
>If this option is checked, you can enter the text of a script to execute. Remember to include a first line such as <literal
>#!/bin/bash</literal
> to ensure that the correct command interpreter is invoked.</para>
</listitem>

<listitem>
<para
>Use the <guilabel
>Command Output</guilabel
> group box to specify what you want to be done with any terminal output which the command produces when it executes.</para>

<itemizedlist>
<listitem>
<para
>Check <guilabel
>Execute in terminal window</guilabel
> to cause the command to be executed in a terminal window. You can choose which type of terminal window should be used in the <link linkend="preferences-general"
>Configuration dialog</link
>.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Log to file</guilabel
> to save the command's output in a file. The output, prefixed by a heading showing the time at which the command was scheduled to run, will be appended to any existing contents of the file. Enter the file name in the edit box, or use the button beside the edit box to display a file selection dialog.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Discard</guilabel
> to throw away the command's output.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect3>

<sect3>
<title
>Herinneringen via e-mail</title>

<para
>Email alarms send an email without displaying any alarm message.</para>

<para
>Fill in the recipients' addresses, the email subject line and the message body in the three edit fields. Use the button beside the addressee edit box to display your &kde; address book from which you can select email recipients. Attachments may be added using the <guibutton
>Add...</guibutton
> button. Note that attached files must still exist when the alarm is triggered; no copy is stored at the time the alarm is configured. To remove an attachment, highlight it in the drop-down list and click the <guibutton
>Remove</guibutton
> button.</para>

<para
>Set the following options:</para>

<itemizedlist>
<listitem>
<para
>The <guilabel
>From</guilabel
> combo box allows you to select which &kmail; identity to use as your email address for sending the email. This option only appears if your <guilabel
>From</guilabel
> email address in the <link linkend="preferences-email"
>Configuration dialog</link
> is set to <guilabel
>Use &kmail; identities</guilabel
>. Otherwise your email address is preset in the <link linkend="preferences-email"
>Configuration dialog</link
>, rendering this option inapplicable.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Copy email to self</guilabel
> to send a blind copy of the email to yourself when the alarm is triggered. The email address to which the copy will be sent may be set in the <link linkend="preferences-email"
>Configuration dialog</link
>, the default being your email address set in the &kde; System Settings.</para>
</listitem>
</itemizedlist>

</sect3>

<sect3>
<title
>Audio Alarms</title>

<para
>Audio alarms play an audio file without displaying any alarm message.</para>

<para
>Set the following options:</para>

<itemizedlist>
<listitem>
<para
>Enter the sound file path, or use the button beside the edit box to display a file selection dialog.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Repeat</guilabel
> to continually repeat the audio file until the <guilabel
>Stop Play</guilabel
> option is selected. To stop playing the file, select the <menuchoice
><guimenu
>Actions</guimenu
> <guimenuitem
>Stop Play</guimenuitem
></menuchoice
> menu option, or <mousebutton
>Right</mousebutton
> click on the system tray icon and choose <menuchoice
><guimenuitem
>Stop Play</guimenuitem
></menuchoice
> from the context menu. If you wish, you can set up a global shortcut key for this action.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Volume</guilabel
> and adjust the slider control if you want to adjust the volume at which the audio file is played.</para>
</listitem>

<listitem>
<para
>If you wish, you can fade the volume. Fading means to start playing the audio file at one volume and gradually change to the final volume, over a specified time interval. The final volume is that entered in <guilabel
>Volume</guilabel
> above. To enable fade, check <guilabel
>Fade</guilabel
>, and then enter the fade period in seconds in the <guilabel
>Fade time</guilabel
> field, and adjust the <guilabel
>Initial volume</guilabel
> slider.</para>
</listitem>
</itemizedlist>
</sect3>
</sect2>

<sect2>
<title
>Deferral</title>

<para
>If the alarm is a recurring alarm and it was deferred after it was last displayed, the <guilabel
>Deferred Alarm</guilabel
> group box shows the time the alarm was deferred to. <guibutton
>Change...</guibutton
> displays a dialog which allows you to change the deferred time or to cancel the deferral.</para>

</sect2>

<sect2>
<title
>Tijd</title>

<para
>In the <guilabel
>Time</guilabel
> group box, select either</para>

<itemizedlist>
<listitem>
<para
><guilabel
>At date/time</guilabel
> to enter the date and time when the alarm is to be triggered. Check <guilabel
>Any time</guilabel
> if you want to specify only a date for the alarm: in this case the alarm will be displayed at the first opportunity on or after the configured start-of-day time, on the specified date. (<link linkend="preferences-time"
>Configuring &kalarm;</link
> describes how to set the start-of-day time.)</para>

<para
>For a non-recurring alarm, the date/time which you enter must be in the future, or if you enter only a date it must be today or later. For a recurring alarm, there are no such restrictions since the start date/time will be automatically adjusted to the first recurrence due after the current time.</para>
</listitem>

<listitem>
<para
><guilabel
>Time from now</guilabel
> to enter how long after now (in hours and minutes) the alarm should be triggered.</para>
</listitem>
</itemizedlist>

<para
>If desired, choose a time zone to apply to the alarm. This time zone is used for all dates and times relating to this alarm, including recurrence and exception dates and times. Normally, you should leave the time zone controls unchanged unless you have a good reason to change them.</para>

<para
>The time zone controls are displayed only when the selected time zone is different from the default time zone set in the <link linkend="preferences-time"
>Configuration dialog</link
>, or if you click the <guibutton
>Time Zone...</guibutton
> button.</para>

<itemizedlist>
<listitem>
<para
>In the combo box, choose the time zone which this alarm is to use. When creating a new alarm, this is initially set to the time zone selected in the <link linkend="preferences-time"
>Configuration dialog</link
>, which will be your computer's time zone unless you have changed it.</para>
</listitem>

<listitem>
<para
>Check <guilabel
>Ignore time zone</guilabel
> if you want to use the local computer time (on whichever computer &kalarm; happens to be running on at the time), ignoring time zones.</para>

<warning
><para
>You are recommended not to select this option if the alarm has a recurrence specified in hours and minutes; if you do, the alarm may occur at unexpected times after daylight saving time shifts.</para
></warning>
</listitem>
</itemizedlist>

</sect2>

<sect2>
<title
>Herinnering</title>

<para
>For a display alarm, check <guilabel
>Reminder</guilabel
> if you want to display a reminder in advance of the main alarm and of each of its recurrences (if any). Enter how long in advance using the edit controls beside the check box.</para>

<note
><para
>Reminders are not displayed for sub-repetitions within a recurrence. Reminders are only shown before each main recurrence of the alarm.</para
></note>

<para
>If the alarm recurs, check <guilabel
>Reminder for first recurrence only</guilabel
> if you only want a reminder before the alarm's first recurrence. If this is not checked, the reminder period is limited to being less than the recurrence interval.</para>

</sect2>

<sect2>
<title
>Afbreking</title>

<para
>The late-cancelation options determine how an alarm is treated after its scheduled time:</para>

<itemizedlist>
<listitem>
<para
>The <guilabel
>Cancel if late</guilabel
> check box determines what happens if the alarm cannot be triggered at its scheduled time.</para>

<para
>Check this box to cancel the alarm if it cannot be triggered within a specified time period after the right time. The time period is selected using controls which appear when you check the box. For example, if you enter a time period of 1 hour, the alarm will be triggered at the first opportunity up to an hour after it is due, but if it cannot be triggered within an hour its activation will be canceled.</para>

<note
><para
>The lateness of date-only alarms, &ie; ones for which the <guilabel
>Any time</guilabel
> option is selected, is calculated from the start-of-day time on the alarm's scheduled date.</para
></note>

<para
>Leave the box unchecked to trigger the alarm at the first opportunity starting at the scheduled time, regardless of how late it is.</para>

<note
><para
>An alarm can only be triggered while you are logged in, and while both X and &kalarm; are running.</para
></note>
</listitem>

<listitem>
<para
>Check <guilabel
>Auto-close window after this time</guilabel
> if you want the alarm window to be automatically closed if it is still showing at the expiry of the late-cancelation time.</para>
</listitem>
</itemizedlist>

</sect2>

<sect2>
<title
>Herhaling</title>

<para
>Specify whether or how the alarm should be repeated using the <guilabel
>Recurrence</guilabel
> tab.</para>

<note
><para
>The alarm's basic repetition characteristics are displayed for convenience in the title of the <guilabel
>Recurrence</guilabel
> tab. The recurrence interval is shown first, followed by any sub-repetition interval set up using the <guibutton
>Sub-Repetition</guibutton
> button.</para
></note>

<para
>In the <guilabel
>Recurrence Rule</guilabel
> group box, set the recurrence type or time period as follows:</para>

<itemizedlist>
<listitem
><para
>To trigger the alarm once only, select <guilabel
>No recurrence</guilabel
>.</para
></listitem>

<listitem
><para
>Select <guilabel
>At login</guilabel
> to trigger the alarm whenever you log in, until its scheduled end time. Then, at its scheduled end time it will finally be triggered one last time. (Note that an alarm repeated at login will also be triggered any time you restart &kalarm;.)</para
></listitem>

<listitem>
<para
>To make the alarm recur at regular intervals, select one of the time period types and then enter in the <guilabel
>Recur every</guilabel
> box how many time periods should elapse between recurrences. For example, to repeat every fortnight, you could select <guilabel
>Daily</guilabel
> and enter a value of 14, or select <guilabel
>Weekly</guilabel
> and enter a value of 2. Depending on the time period type selected, you may have further options:</para>

<itemizedlist>
<listitem>
<para
>For a weekly recurrence, check each day in the week on which you wish to trigger the alarm.</para>
</listitem>

<listitem>
<para
>For a monthly recurrence, you may select either a fixed date, or a position (&eg; the second Tuesday).</para>
</listitem>

<listitem>
<para
>For a yearly recurrence, you may select either a fixed day in the month, or a position in a month (&eg; the last Saturday in May). Check each month of the year in which you wish to trigger the alarm.</para>

<para
>If you set up a yearly recurrence for February 29th, you can specify how it is to be handled in non-leap years by selecting the appropriate <guilabel
>February 29th alarm in non-leap years</guilabel
> option:</para>

<itemizedlist>
<listitem
><para
><guilabel
>None</guilabel
>: the alarm will occur on February 29th in leap years, but will be suppressed in non-leap years.</para>
</listitem>

<listitem
><para
><guilabel
>28 Feb</guilabel
>: the alarm will occur on February 29th in leap years, and on February 28th in non-leap years.</para>
</listitem>

<listitem
><para
><guilabel
>1 Mar</guilabel
>: the alarm will occur on February 29th in leap years, and on March 1st in non-leap years.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>

<tip
><para
>To set a daily alarm to occur only on weekdays, use a weekly recurrence and check each weekday.</para
></tip>

</listitem>
</itemizedlist>

<para
>In the <guilabel
>Recurrence End</guilabel
> group box, set the overall recurrence time span as follows:</para>

<itemizedlist>
<listitem
><para
>Select <guilabel
>No end</guilabel
> to continue the repetitions indefinitely.</para
></listitem>

<listitem
><para
>Select <guilabel
>End after</guilabel
> to specify the total number of occurrences of the alarm.</para
></listitem>

<listitem
><para
>Select <guilabel
>End by</guilabel
> to specify the date/time until which the alarm will be repeated. Note that this uses the same time zone as the alarm's start time.</para>

<note
><para
>The end date/time determines when the last main recurrence will be, but does not limit sub-repetitions. If sub-repetitions are configured, they will trigger as normal after the last main recurrence, regardless of the end date/time.</para
></note>
</listitem>
</itemizedlist>

<para
>The <guilabel
>Exceptions</guilabel
> group box allows you to exclude certain date/times from the recurrence which you have set up. Note that these controls are not shown in the simplified form of the Alarm Edit dialog: to see them, click <guibutton
>More Options</guibutton
>.</para>

<itemizedlist>
<listitem>
<para
>The list of exceptions (&ie; excluded date/times) is shown on the left. To add a new exception, enter a date on the right and press <guibutton
>Add</guibutton
>. To change an exception, highlight it in the list, enter the new date on the right and press <guibutton
>Change</guibutton
>. To delete an exception, highlight it in the list and press <guibutton
>Delete</guibutton
>.</para>
</listitem>

<listitem>
<para
>You can restrict an alarm not to occur on holidays by checking <guilabel
>Exclude holidays</guilabel
>. This does not change the way the alarm is scheduled; it simply suppresses the alarm whenever it happens to trigger on a holiday. You can select your holiday country or region in the <link linkend="preferences-time"
>Configuration dialog</link
>.</para>
</listitem>

<listitem>
<para
>You can restrict an alarm to occur only during working time by checking <guilabel
>Only during working hours</guilabel
>. This does not change the way the alarm is scheduled; it simply suppresses the alarm whenever it happens to trigger outside working hours. Work days and working hours are set in the <link linkend="preferences-time"
>Configuration dialog</link
>.</para>
</listitem>
</itemizedlist>

<sect3>
<title
>Deelherhaling</title>

<para
>You can use the <guibutton
>Sub-Repetition</guibutton
> button to set up a repetition within a repetition. In this case, each time the alarm is due as specified in the main recurrence, instead of being triggered just once it is triggered repeatedly in accordance with your sub-repetition specification. For example, to set up an alarm which repeats every hour from noon to 6 pm each Thursday, you would set up a weekly recurrence on Thursday at 12:00, and use the Sub-Repetition dialog to specify an interval of 1 hour and either a count of 6 or a duration of 6 hours.</para>

<para
>In the Sub-Repetition dialog which is displayed when you click the <guibutton
>Sub-Repetition</guibutton
> button, check <guilabel
>Repeat every</guilabel
> to set up a repetition, or uncheck it to remove the repetition. If <guilabel
>Repeat every</guilabel
> is checked, set up the repetition as follows:</para>

<itemizedlist>
<listitem
><para
>Enter the time interval between repetitions in the controls beside <guilabel
>Repeat every</guilabel
>. Select the desired time units (&eg; <guilabel
>days</guilabel
>) and then enter the number of units.</para>
</listitem>

<listitem
><para
>Specify either the repetition count or its duration:</para>

<itemizedlist>
<listitem
><para
>Select <guilabel
>Number of times</guilabel
> to enter how many times the alarm should be triggered after the main recurrence. So, for example, to make the alarm occur 4 times at each main recurrence, &ie; 3 additional times, you should enter 3 here.</para>
</listitem>

<listitem
><para
>Select <guilabel
>Duration</guilabel
> to enter the total time period during which the alarm should be repeated. This need not be an exact multiple of the repetition interval; it will automatically be rounded down when you click <guibutton
>OK</guibutton
>.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>

<note
><para
>To prevent overlapping sub-repetitions for the same alarm, a sub-repetition's duration is restricted to be less than the longest interval between main recurrences. Each time the alarm recurs as specified in the main recurrence, any still active sub-repetition which started at the previous recurrence is automatically cancelled.</para
></note>

</sect3>
</sect2>

<sect2>
<title
>Other Controls</title>

<para
>For display alarms, the <guilabel
>Confirm acknowledgment</guilabel
> check box lets you specify whether you will be prompted for confirmation when you close the alarm message window. This may be used as a safeguard against accidental acknowledgment of alarms.</para>

<para
>Select <guilabel
>Show in &korganizer;</guilabel
> to add the alarm to &korganizer;'s active calendar, where it will appear as an event without an alarm. This option allows you to track alarms in &korganizer; while still making use of &kalarm;'s functions.</para>

<note
><para
>If you later modify or delete the alarm in &kalarm;, the &korganizer; event will be modified or deleted correspondingly. But if you change the event in &korganizer;, the alarm in &kalarm; will not be affected.</para
></note>

<para
>Press the <guibutton
>Load Template</guibutton
> button to select a template to preset the dialog with, as described in <link linkend="create-edit"
>Creating and Manipulating Alarms</link
>. </para>

<para
>Press the <guibutton
>Try</guibutton
> button to test the alarm and check whether it works correctly. The alarm is executed just as if it had been scheduled in the normal way.</para>

<para
>Press the <guibutton
>OK</guibutton
> button when all details are correct, to add the alarm to the scheduled list. Note that when editing an existing alarm, the <guibutton
>OK</guibutton
> button is disabled while no changes have been made.</para>

</sect2>
</sect1>

<sect1 id="message-window">
<title
>Alarm Message Window</title>

<para
>When an alarm message is due, it is displayed on each &kde; desktop and cannot be covered by ordinary windows, to ensure that you see it. The message window shows the time for which the alarm was scheduled, so that you can see when it popped up if you were away from the computer at the time. If the alarm's scheduled time is in a different time zone from your local computer's setting, its time zone will also be displayed. (For reminder messages, the date/time shown is that for the main alarm or its recurrence, not the reminder message time, and the window title is <quote
>Reminder</quote
>.)</para>

<para
>Alarm message windows remain visible until you acknowledge them, unless <guilabel
>Auto-close window after late-cancelation time</guilabel
> was checked in the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>. In the case of a recurring alarm, if an unacknowledged message window remains from a previous occurrence of the alarm, the existing window is simply popped up when the alarm recurs. This avoids having to acknowledge multiple copies of the same message should you not wish, or be unable, to acknowledge a message at the time it appears.</para>

<para
>The alarm message window provides whichever of the following options are applicable to the displayed alarm:</para>

<itemizedlist>
<listitem>
<para
>Acknowledge the alarm by clicking the <guibutton
>Close</guibutton
> button. This closes the window (after a prompt for confirmation, if you selected <guilabel
>Confirm acknowledgment</guilabel
>).</para>
</listitem>

<listitem>
<para
>Edit the alarm by clicking the <guibutton
>Edit...</guibutton
> button. This displays the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>.</para>
</listitem>

<listitem>
<para
>Display options to defer the alarm until later by clicking the <guibutton
>Defer...</guibutton
> button. Then select <guilabel
>Defer to date/time</guilabel
> to enter the date and time when the message is to be redisplayed, or select <guilabel
>Defer for time interval</guilabel
> to enter how long after now (in hours and minutes) the message should be redisplayed. Then click <guibutton
>OK</guibutton
> to defer the alarm message and close its window.</para>

<note
><para
>The time the alarm is deferred to must be earlier than its next scheduled occurrence or next reminder. For this reason, the <guibutton
>Defer...</guibutton
> button in the alarm message window and the <guibutton
>OK</guibutton
> button in the Deferral dialog are disabled one minute before the next occurrence or reminder.</para
></note>

<note
><para
>The <guibutton
>Defer...</guibutton
> button is not available for alarms which are displayed at login due to the <guilabel
>Repeat at login</guilabel
> option having been selected.</para
></note>
</listitem>

<listitem>
<para
>Stop playing the alarm's sound file by clicking the button showing the <quote
>stop playing</quote
> symbol.</para>
</listitem>

<listitem>
<para
>If the alarm message was created by dragging an email from &kmail;, you can directly access the email in &kmail; by clicking the button showing the &kmail; icon. This will select and highlight the email in &kmail;'s folder list.</para>

<warning
><para
>If &kmail;'s indexes are regenerated, the link to the email in &kmail; will be lost.</para
></warning>
</listitem>

<listitem>
<para
>The button showing the <guiicon
>&kalarm;</guiicon
> icon provides a convenient way to activate &kalarm;.</para>
</listitem>
</itemizedlist>

<para
>You can choose in the <link linkend="preferences-view"
>Configuration dialog</link
> which of two different modes should be used to display alarm message windows:</para>

<itemizedlist>
<listitem>
<para
>As a normal window. In this mode, the keyboard focus is taken by the alarm message window when it appears, so if you are typing at the time your keystrokes will be diverted to it rather than your original application.</para>
</listitem>

<listitem>
<para
>As a non-modal window. In this mode, the keyboard focus is unaffected when the alarm message window appears, so it will not interfere with your typing. However in this mode the window has no titlebar or frame, so you cannot move it or resize it.</para>
</listitem>
</itemizedlist>

<note
><para
>When an alarm is displayed on top of a full screen application, it is shown as a non-modal window regardless of this configuration setting. This is due to a limitation of the window system.</para
></note>

<sect2>
<title
>Positioning of Message Windows</title>

<para
>You can choose in the <link linkend="preferences-view"
>Configuration dialog</link
> which of two schemes should be used to position alarm message windows:</para>

<itemizedlist>
<listitem>
<para
>The windows are displayed as far away from the current mouse cursor as possible. This minimizes disruption to your work flow and minimizes the possibility of accidentally acknowledging the alarm.</para>
</listitem>

<listitem>
<para
>The windows are displayed in the center of the screen. To reduce the chance of accidentally acknowledging the alarm, the buttons on the window are initially disabled, becoming active only after a configurable delay.</para>
</listitem>
</itemizedlist>

<para
>If you have several alarm message windows, or error messages, displayed, you can spread the windows out across the screen to make them all visible, or group them all together again in the top left corner of the screen, by means of the <menuchoice
> <guimenu
>View</guimenu
><guimenuitem
>Spread Windows</guimenuitem
> </menuchoice
> menu option. If you wish, you can set up a global shortcut key for this action.</para>

</sect2>
</sect1>

<sect1 id="system-tray">
<title
>System Tray Operation</title>

<para
>&kalarm; by default displays an icon in the system tray. The icon provides both control and an alarm monitoring status indication. A normal &kalarm; icon indicates that alarms are being monitored, while a gray icon indicates that alarms are not being monitored. If some individual alarms are disabled, a small cross is overlaid on the icon.</para>

<para
>If you hover the mouse cursor over the system tray icon, a summary of the first few message alarms due in the next 24 hours are displayed as a tooltip. You can switch this feature off, or configure the number of alarms to display and their format, in the <link linkend="preferences-view"
>Configuration dialog</link
>.</para>

<para
><mousebutton
>Left</mousebutton
> click on the system tray icon to toggle between displaying and hiding the &kalarm; main window.</para>

<para
><mousebutton
>Right</mousebutton
> click on the system tray icon to display its context menu:</para>

<variablelist>
<varlistentry>
<term
><menuchoice
><guimenuitem
>Herinneringen inschakelen</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Enables or disables monitoring of alarms.</action
></para>
<para
>See <link linkend="enable-disable"
>Enabling and Disabling Alarms</link
> for details.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Nieuwe herinnering</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>After you select the alarm type from the list which appears, opens the Alarm Edit dialog to create a new alarm.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Nieuwe herinnering van sjabloon</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Displays the list of alarm templates in a menu. When you select one, the Alarm Edit dialog is opened, preset with that template's details.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Afspelen stoppen</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Halts playback of the audio file currently playing.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Verspreid vensters</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Spreads alarm and error message windows across the screen, or groups them together again.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Configure &kalarm;...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Displays the &kalarm; Configuration dialog.</action
></para>
<para
>The Configuration dialog is described in <link linkend="preferences"
>Configuring &kalarm;</link
>. It includes options relating to the &kalarm; system tray icon.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Restore / Minimize</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Restores or minimizes the main &kalarm; window.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenuitem
>Afsluiten</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Closes the &kalarm; system tray icon and main windows.</action
></para>
<para
>Quits &kalarm; if no alarm message windows are displayed.</para>
</listitem>
</varlistentry>
</variablelist>

<sect2>
<title
>Displaying &kalarm; in the System Tray</title>

<para
>You must be running the &kde; desktop or another suitable window manager in order to display &kalarm; in the system tray.</para>

<para
>To display &kalarm; in the system tray, select <menuchoice
> <guimenu
>View</guimenu
><guimenuitem
>Show in System Tray</guimenuitem
> </menuchoice
>.</para>

<para
>To remove &kalarm; from the system tray, deselect <menuchoice
><guimenu
>View</guimenu
> <guimenuitem
>Show in System Tray</guimenuitem
></menuchoice
>.</para>

<para
>To choose whether or not &kalarm; will be shown at startup in the system tray, use the <link linkend="preferences-view"
>View</link
> tab of the Configuration dialog.</para>
</sect2>
</sect1>

<sect1 id="refreshing">
<title
>Refreshing Alarms</title>

<para
>If in the unlikely event that any alarm was not triggered when it should have been, you can refresh the alarm list and trigger any missed alarms by selecting <menuchoice
> <guimenu
>Actions</guimenu
><guimenuitem
>Refresh Alarms</guimenuitem
> </menuchoice
>. This causes &kalarm; to reload all alarm calendars.</para>

<para
>You can reload an individual calendar and refresh its alarms in the alarm list by <mousebutton
>Right</mousebutton
> clicking the calendar in the calendars list and selecting the <menuchoice
><guimenuitem
>Reload</guimenuitem
></menuchoice
> menu option. See <link linkend="calendars"
>Alarm Calendars</link
> for details.</para>

</sect1>

<sect1 id="enable-disable">
<title
>Enabling and Disabling Alarms</title>

<para
>Alarms may be enabled and disabled either as a whole or individually:</para>

<itemizedlist>
<listitem>
<para
><quote
>Alarm monitoring</quote
> applies to alarms as a whole. While alarm monitoring is disabled, no alarms are triggered at all. While alarm monitoring is enabled (the normal situation), all alarms which are not individually disabled will trigger at the appropriate times.</para>

<para
>When alarm monitoring is re-enabled, alarms which would have triggered while it was disabled are now triggered (unless any late-cancel option prevents this). In other words, disabling alarm monitoring has the same effect as stopping &kalarm; &ndash; alarms are postponed until it is re-enabled.</para>
</listitem>

<listitem>
<para
>Alarms may be individually enabled and disabled, independently of the alarm monitoring status. So the enabled/disabled status of individual alarms will be unchanged by disabling and then re-enabling alarm monitoring. Unlike alarm monitoring which could potentially be disabled due to &kalarm; not running, individual alarms can only be disabled if you use menu commands to do so.</para>

<para
>When an alarm is individually re-enabled, it is not now triggered if it became due while disabled. In other words, disabling an individual alarm cancels all its occurrences until it is re-enabled.</para>

<para
>An alarm's individual enabled/disabled status is indicated by its color in the alarm list (the color being configurable in the <link linkend="preferences-view"
>View</link
> tab of the Configuration dialog).</para>
</listitem>
</itemizedlist>

<para
>For an alarm to trigger, it must be individually enabled as well as alarm monitoring being enabled.</para>

<sect2>
<title
>Enabling Alarm Monitoring</title>

<para
>For alarm monitoring to occur, &kalarm; must be running. Once you run &kalarm;, it will from then on start automatically whenever you log in unless you later disable it in the <link linkend="preferences-general"
>General</link
> tab of the Configuration dialog.</para>

<para
>If alarm monitoring is currently disabled, do one of the following to enable alarms:</para>

<itemizedlist>
<listitem>
<para
>Select <menuchoice
><guimenu
>Actions</guimenu
> <guimenuitem
>Enable Alarms</guimenuitem
></menuchoice
>.</para>
</listitem>

<listitem>
<para
><mousebutton
>Right</mousebutton
> click on the system tray icon and choose <menuchoice
><guimenuitem
>Enable Alarms</guimenuitem
></menuchoice
> from the context menu.</para>
</listitem>
</itemizedlist>

</sect2>

<sect2>
<title
>Disabling Alarm Monitoring</title>

<para
>You can temporarily disable alarm monitoring, which prevents &kalarm; from checking any alarms either until you re-enable alarms, or &ndash; assuming that &kalarm; is configured to start at login &ndash; until the next time you log in.</para>

<itemizedlist>
<listitem>
<para
>Unselect <menuchoice
><guimenu
>Actions</guimenu
> <guimenuitem
>Enable Alarms</guimenuitem
></menuchoice
>.</para>
</listitem>

<listitem>
<para
><mousebutton
>Right</mousebutton
> click on the system tray icon and uncheck <menuchoice
><guimenuitem
>Enable Alarms</guimenuitem
></menuchoice
> from the context menu.</para>
</listitem>

<listitem>
<para
>Stop &kalarm; as described in <link linkend="quitting"
>Quitting &kalarm;</link
>.</para>
</listitem>
</itemizedlist>

<para
>Alarms may be permanently disabled by preventing &kalarm; from being started at login using the <link linkend="preferences-general"
>General</link
> tab of the Configuration dialog.</para>

</sect2>

<sect2>
<title
>Enabling and Disabling Individual Alarms</title>

<para
>To enable individual alarms which are currently disabled, do one of the following:</para>

<itemizedlist>
<listitem>
<para
>Select one or more alarms by clicking on their entries in the alarm list. Then choose <menuchoice
> <guimenu
>Actions</guimenu
><guimenuitem
>Enable</guimenuitem
> </menuchoice
>.</para>
</listitem>

<listitem>
<para
><mousebutton
>Right</mousebutton
> click on the desired entries in the alarm list and choose <menuchoice
><guimenuitem
>Enable</guimenuitem
></menuchoice
> from the context menu.</para>
</listitem>
</itemizedlist>

<para
>To disable individual alarms which are currently enabled, do one of the following:</para>

<itemizedlist>
<listitem>
<para
>Select one or more alarms by clicking on their entries in the alarm list. Then choose <menuchoice
> <guimenu
>Actions</guimenu
><guimenuitem
>Disable</guimenuitem
> </menuchoice
>.</para>
</listitem>

<listitem>
<para
><mousebutton
>Right</mousebutton
> click on the desired entries in the alarm list and choose <menuchoice
><guimenuitem
>Disable</guimenuitem
></menuchoice
> from the context menu.</para>
</listitem>
</itemizedlist>

</sect2>
</sect1>

<sect1 id="quitting">
<title
>&kalarm; afsluiten</title>

<para
>Quit &kalarm; by selecting <menuchoice
> <guimenu
>File</guimenu
><guimenuitem
>Quit</guimenuitem
></menuchoice
>, or <menuchoice
><guimenuitem
>Quit</guimenuitem
></menuchoice
> in the system tray icon context menu. Alternatively, if the system tray icon is not visible, close all &kalarm;'s windows.</para>

</sect1>
</chapter>

<chapter id="preferences">
<title
>&kalarm; instellen</title>

<para
>To configure &kalarm;'s operation to suit your system and your personal preferences, select <menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Configure &kalarm;...</guimenuitem
></menuchoice
>. This displays the Configuration dialog.</para>

<sect1 id="preferences-general">
<title
>Algemeen</title>

<para
>The <guilabel
>General</guilabel
> section lets you control &kalarm;'s overall behavior:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Start at login</guilabel
>: &kalarm; will be started automatically at &kde; session login, ensuring that &kalarm; runs at all times unless you manually quit.</para>

<warning
><para
>This option should always be checked unless you intend to discontinue use of &kalarm;.</para
></warning>

<note
><para
>This option is automatically reselected whenever &kalarm; is run. So if you have unchecked this option and want to continue to prevent &kalarm; from running at login, you need to uncheck this option again each time you run &kalarm;.</para
></note>
</listitem>

<listitem>
<para
><guilabel
>Warn before quitting</guilabel
>: When alarms are disabled while &kalarm; is not running, selecting this option prompts you for confirmation if you attempt to terminate &kalarm; using the system tray icon's <menuchoice
><guimenu
>Quit</guimenu
></menuchoice
> option. This prevents accidental disabling of alarms. For safety, this option is automatically re-enabled by default whenever you change run mode.</para>
</listitem>

<listitem
><para
><guilabel
>Confirm alarm deletions</guilabel
>: Specify whether you should be prompted for confirmation each time you delete an alarm.</para>
</listitem>

<listitem
><para
><guilabel
>Default defer time interval</guilabel
>: Enter the default time interval, in hours and minutes, to show initially when the Defer Alarm dialog is displayed. Note that if an alarm has been deferred previously, the interval shown initially in the Defer Alarm dialog will be equal to the deferral interval used the last time that alarm was deferred.</para>
</listitem>

<listitem
><para
><guilabel
>Terminal for Command Alarms</guilabel
>: Here, you can select which type of terminal window should be used for command alarms which are executed in a terminal window. Some of the most common terminal window applications are preconfigured, &eg; <application
>xterm</application
>, &konsole;, although only those which are installed on your system will be shown here. You can view the actual command options used for each application by displaying the context help for its radio button.</para>

<para
>If you want to use another application, or want to use one of those listed but with different command options, select <guilabel
>Other</guilabel
> and enter the command to invoke the terminal window. By default, the alarm's command string will be appended to what you specify. Alternatively, you may specify where the alarm's command string should be inserted, by use of the following codes:</para>

<variablelist>
<varlistentry>
<term
>%c</term>
<listitem>
<para
>The alarm's command string will be substituted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term
>%w</term>
<listitem>
<para
>The alarm's command string will be substituted, with a <literal
>sleep</literal
> appended.</para>
</listitem>
</varlistentry>
<varlistentry>
<term
>%C</term>
<listitem>
<para
>A temporary command file containing the alarm's command string will be created, and the command to execute the file will be substituted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term
>%W</term>
<listitem>
<para
>A temporary command file containing the alarm's command string will be created with a <literal
>sleep</literal
> appended, and the command to execute the file will be substituted.</para>
</listitem>
</varlistentry>
</variablelist>

<para
>When the command alarm is triggered, its command string will be quoted before being inserted into the terminal window command.</para>
</listitem>

</itemizedlist>
</sect1>

<sect1 id="preferences-time">
<title
>Datum en tijd</title>

<para
>The <guilabel
>Time and Date</guilabel
> section lets you set options relating to time and date:</para>

<itemizedlist>
<listitem
><para
><guilabel
>Time zone</guilabel
>: Select your time zone. &kalarm; uses this time zone throughout, except when you override it for individual alarms.</para>
</listitem>

<listitem
><para
><guilabel
>Holiday region</guilabel
>: Select which country's or region's holidays to use. This affects recurring alarms for which the option to exclude holidays is selected.</para>
</listitem>

<listitem
><para
><guilabel
>Start of day for date-only alarms</guilabel
>: Set the start-of-day time for the purposes of triggering date-only alarms, &ie; ones for which the <guilabel
>Any time</guilabel
> option was selected. On the date when they are due, such alarms will be output at the earliest opportunity during the 24 hours starting from the start-of-day time.</para>
</listitem>

<listitem
><para
><guilabel
>Working Hours</guilabel
> group box: These options let you define your working hours, needed when the <guilabel
>Only during working hours</guilabel
> option is selected for a recurrence in the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>.</para>

<itemizedlist>
<listitem
><para
>Check each day which is a working day.</para>
</listitem>

<listitem
><para
><guilabel
>Daily start time</guilabel
>: enter the time at which you start work each day.</para>
</listitem>

<listitem
><para
><guilabel
>Daily end time</guilabel
>: enter the time at which you finish work each day.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem
><para
><guilabel
>KOrganizer event duration</guilabel
>: Enter the event duration to set in &korganizer; for alarms which are copied to &korganizer;. The default duration is zero.</para>
</listitem>

</itemizedlist>
</sect1>

<sect1 id="preferences-storage">
<title
>Opslag</title>

<para
>The <guilabel
>Storage</guilabel
> section lets you choose options for saving and archiving alarms:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>New Alarms &amp; Templates</guilabel
>: Specify which calendar to store new alarms and alarm templates in when using multiple alarm calendars:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Store in default calendar</guilabel
>: New alarms and alarm templates are automatically added to the default alarm calendar without prompting for confirmation.</para>
</listitem>

<listitem>
<para
><guilabel
>Prompt for which calendar to store in</guilabel
>: When you create a new alarm or alarm template and there is more than one writeable alarm calendar, you will be prompted to choose which calendar to save it in. Note that when alarms are saved on expiry, they are always stored in the default archived alarm calendar without prompting.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem
><para
><guilabel
>Archived Alarms</guilabel
> group box: These options control the storage of archived alarms in the default archived alarm calendar.</para>

<itemizedlist>
<listitem
><para
><guilabel
>Keep alarms after expiry</guilabel
>: Select this option to archive expired and deleted alarms. Deselect it to keep no record of alarms once they cease to be active. Note that deleted alarms are only archived if they have previously been triggered. If you delete an alarm before it ever triggers, it is discarded.</para>
</listitem>

<listitem
><para
><guilabel
>Discard archived alarms after</guilabel
>: Set the number of days to store expired and deleted alarms in the archive, after which they are permanently deleted.</para>
</listitem>

<listitem
><para
><guibutton
>Clear archived alarms</guibutton
>: This button discards all currently archived alarms from the default archived alarm calendar. (Other archived alarm calendars are left unchanged in case they are shared with other people.) This has no effect on alarms which subsequently expire or are deleted; they will continue to be archived according to the selected options.</para>
</listitem>
</itemizedlist>
</listitem>

</itemizedlist>
</sect1>

<sect1 id="preferences-email">
<title
>E-mail</title>

<para
>The <guilabel
>Email</guilabel
> section lets you choose options for sending and addressing email alarms:</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Email client</guilabel
>: Specify the email client to be used to send email alarms:</para>

<itemizedlist>
<listitem
><para
><guilabel
>KMail</guilabel
>: When an email alarm is triggered, the email is sent using &kmail; (which is started first if necessary) as follows:</para>

<itemizedlist>
<listitem
><para
>If &kmail; is version 1.7 or later, the email is sent automatically.</para>
</listitem>

<listitem
><para
>If &kmail; is an older version, the email is added to &kmail;'s <filename
>outbox</filename
> folder for later transmission.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem
><para
><guilabel
>Sendmail</guilabel
>: When an email alarm is triggered, the email is sent automatically using &Sendmail;. This option will only work if your system is configured to use &Sendmail;, or a &Sendmail; compatible mail transport agent such as <application
>postfix</application
> or <application
>qmail</application
>.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
><guilabel
>Copy sent emails into &kmail;'s sent-items folder</guilabel
>: Select this option if, every time an email alarm is triggered, you want a copy of the transmitted email to be stored in &kmail;'s <filename
>sent-items</filename
> folder.</para>

<note
><para
>This option is not available when &kmail; is selected as the email client, since &kmail; automatically does this.</para
></note>
</listitem>

<listitem>
<para
><guilabel
>Notify when remote emails are queued</guilabel
>: Select this option to display a notification whenever an email alarm queues an email for sending to a remote system. This may be useful if, for example, you have a dial-up connection, or email is queued in &kmail;'s <filename
>outbox</filename
> folder, so that you can ensure that you do whatever is needed to actually transmit the email.</para>
</listitem>

<listitem>
<para
>Select your email address to be used as the sender's address in email alarms:</para>

<itemizedlist>
<listitem
><para
>Select <guilabel
>From</guilabel
> to enter an email address.</para>
</listitem>

<listitem
><para
>Select <guilabel
>Use address from System Settings</guilabel
> to use the email address which is configured in the &kde; System Settings.</para>
</listitem>

<listitem
><para
>Select <guilabel
>Use &kmail; identities</guilabel
> to be able to choose at the time you configure an email alarm which of &kmail;'s email identities to use. &kmail;'s default identity will be used for alarms which were already configured before you selected this option.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>Select your email address to be used for sending blind copies of email alarms to yourself when the <guilabel
>Copy email to self</guilabel
> option is selected:</para>

<itemizedlist>
<listitem
><para
>Select <guilabel
>Bcc</guilabel
> to enter an email address. If blind copies are to be sent to your account on the computer which &kalarm; runs on, you could simply enter your user login name here.</para>
</listitem>

<listitem
><para
>Select <guilabel
>Use address from System Settings</guilabel
> to use the email address which is configured in the &kde; System Settings.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect1>

<sect1 id="preferences-view">
<title
>Beeld</title>

<para
>The <guilabel
>View</guilabel
> section lets you control some aspects of &kalarm;'s appearance. In the <guilabel
>General</guilabel
> tab:</para>
<itemizedlist>

<listitem>
<para
><guilabel
>Show in system tray</guilabel
>: When selected, the system tray icon is displayed while &kalarm; is running. In this mode, closing the system tray icon closes all &kalarm; main windows, and if no message windows are visible, quits the application.</para>
</listitem>

<listitem>
<para
><guilabel
>System Tray Tooltip</guilabel
> group box: These options control what information is shown in the tooltip which appears when the mouse cursor hovers over &kalarm;'s system tray icon.</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Show next 24 hours' alarms</guilabel
>: When selected, a summary of the first few alarms due in the next 24 hours is displayed.</para>
</listitem>

<listitem>
<para
><guilabel
>Maximum number of alarms to show</guilabel
>: Deselect this option to display all of the next 24 hours' alarms. Select it to set the maximum number of alarms which will be displayed.</para>
</listitem>

<listitem>
<para
><guilabel
>Show alarm time</guilabel
>: Select this option to show the time at which each alarm is scheduled.</para>
</listitem>

<listitem>
<para
><guilabel
>Show time until alarm</guilabel
>: Select this option to show the length of time remaining before each alarm's next scheduled occurrence. The length of time is shown in hours and minutes.</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Prefix</guilabel
>: Specify a symbol or text to show in front of the length of time until the alarm, to distinguish it from the time at which the alarm is scheduled.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>The <guilabel
>Alarm List</guilabel
> group box allows the selection of the colors used in the alarm list in &kalarm;'s main window, to show disabled and archived alarms.</para>
</listitem>
</itemizedlist>

<para
>The <guilabel
>Alarm Windows</guilabel
> tab contains options to control the appearance of alarm message windows.</para>

<itemizedlist>
<listitem>
<para
><guilabel
>Position windows far from mouse cursor</guilabel
>: Select this option to display alarm message windows as far away from the current mouse cursor position as possible. This minimizes the chance of accidentally acknowledging an alarm by unintentionally clicking on a button just as the message window appears.</para>
</listitem>

<listitem>
<para
><guilabel
>Center windows, delay activating window buttons</guilabel
>: Select this option to display alarm message windows in the center of the screen. To reduce the chance of accidentally acknowledging the alarm, the window's buttons are initially disabled. The delay in seconds before they become active is set in <guilabel
>Button activation delay (seconds)</guilabel
>.</para>
</listitem>

<listitem>
<para
><guilabel
>Message windows have a titlebar and take keyboard focus</guilabel
>: This option controls whether alarm message windows are modal or not, &ie; whether they grab the keyboard focus when they appear. See the <link linkend="message-window"
>Alarm Message Window</link
> section for details.</para>
</listitem>
</itemizedlist>
</sect1>

<sect1 id="preferences-edit">
<title
>Bewerken</title>

<para
>The <guilabel
>Edit</guilabel
> section lets you choose default values for the options in the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>:</para>

<itemizedlist>
<listitem
><para
>The <guilabel
>General</guilabel
> tab contains options which apply to all alarm types.</para>

<itemizedlist>
<listitem
><para
>Set the default states for the <guilabel
>Show in KOrganizer</guilabel
> and <guilabel
>Cancel if late</guilabel
> check boxes.</para>
</listitem>

<listitem
><para
>Set the default recurrence type.</para>
</listitem>

<listitem
><para
>Select the default handling in non-leap years of yearly recurrences scheduled for February 29th.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem
><para
>The <guilabel
>Alarm Types</guilabel
> tab contains options which apply to specific types of alarm.</para>

<itemizedlist>
<listitem>
<para
>For display alarms:</para>

<itemizedlist>
<listitem
><para
>Set the default states for the <guilabel
>Auto-close window after this time</guilabel
> and <guilabel
>Confirm acknowledgment</guilabel
> check boxes.</para>
</listitem>

<listitem
><para
>Set the default reminder period units.</para>
</listitem>

<listitem
><para
>Set the default special display alarm actions.</para>
</listitem>

<listitem
><para
>Set the default sound options. Note that a default sound file may be specified even if the sound type is not set to <guilabel
>Sound file</guilabel
>.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>For command alarms:</para>

<itemizedlist>
<listitem
><para
>Set the default states for the <guilabel
>Enter a script</guilabel
> and <guilabel
>Execute in terminal window</guilabel
> check boxes.</para>
</listitem>
</itemizedlist>
</listitem>

<listitem>
<para
>For email alarms:</para>

<itemizedlist>
<listitem
><para
>Set the default state for the <guilabel
>Copy email to self</guilabel
> check box.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>

<listitem
><para
>The <guilabel
>Font &amp; Color</guilabel
> tab lets you set the default appearance of alarm messages. Select their default font, and foreground and background colors.</para>
</listitem>
</itemizedlist>
</sect1>

</chapter>

<chapter id="cmdline-operation">
<title
>Command Line Operation</title>

<para
>When command line parameters are supplied, &kalarm; does not display the list of scheduled alarms as described in <link linkend="using-kalarm"
>Using &kalarm;</link
> above. Command line options specific to &kalarm; may be used to perform the following operations:</para>

<itemizedlist>
<listitem
><para
>schedule a new alarm</para>
</listitem>
<listitem
><para
>control &kalarm;'s display mode</para>
</listitem>
<listitem
><para
>obtain help</para>
</listitem>
</itemizedlist>

<para
>Additional command line options are provided primarily to enable other programs to interface to &kalarm;. They are described in the chapter <link linkend="cmdline-interface"
>Developer's Guide to &kalarm;</link
>.</para>

<para
>The command line must only contain options applicable to one &kalarm; operation. If you want to perform multiple operations, you must invoke &kalarm; multiple times with a single set of options each time.</para>

<sect1 id="cmdline-schedule">
<title
>Schedule a New Alarm</title>

<para
>The following options are used to schedule a new alarm:</para>

<informaltable>
<tgroup cols="2">
<thead>
<row>
  <entry
>Optie</entry>
  <entry
>Beschrijving</entry>
</row>
</thead>
<tbody>
<row>
  <entry
><option
>-a</option
>, <option
>--ack-confirm</option
></entry>
  <entry
>Prompt for confirmation when the alarm message is acknowledged.</entry>
</row>
<row>
  <entry
><option
>-A</option
>, <option
>--attach <replaceable
>URL</replaceable
></option
></entry>
  <entry
>Specify the path or &URL; of a file which is to be attached to the email. This option may be repeated as necessary. <option
>--mail</option
> must be specified with this option.</entry>
</row>
<row>
  <entry
><option
>--auto-close</option
></entry>
  <entry
>Automatically close the alarm window after the expiry of the <option
>--late-cancel</option
> period. <option
>--late-cancel</option
> must be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-b</option
>, <option
>--beep</option
></entry>
  <entry
>Make an audible beep when the message is displayed. <option
>--speak</option
>, <option
>--play</option
> and <option
>--play-repeat</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>--bcc</option
></entry>
  <entry
>Blind copy the email to yourself. <option
>--mail</option
> must be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-c</option
>, <option
>--color</option
>, <option
>--colour <replaceable
>color</replaceable
></option
></entry>
  <entry
>Set the message background color to the specified &Qt; color name or hex code 0xRRGGBB.</entry>
</row>
<row>
  <entry
><option
>-C</option
>, <option
>--colorfg</option
>, <option
>--colourfg <replaceable
>color</replaceable
></option
></entry>
  <entry
>Set the message foreground color to the specified &Qt; color name or hex code 0xRRGGBB.</entry>
</row>
<row>
  <entry
><option
>-d</option
>, <option
>--disable</option
></entry>
  <entry
>Disable the alarm. It will not trigger until it has been manually enabled.</entry>
</row>
<row>
  <entry
><option
>-e</option
>, <option
>--exec <replaceable
>commandline</replaceable
></option
></entry>
  <entry
>Specify a shell command to execute. If specified, this option must be the last &kalarm; option in &kalarm;'s command line. All subsequent command parameters and options are interpreted as forming the command line to execute. <option
>--file</option
> and <option
>--exec-display</option
> and <option
>--mail</option
> cannot be specified with this option. <option
>--ack-confirm</option
>, <option
>--beep</option
>, <option
>--color</option
> and <option
>--colorfg</option
> are ignored with this option.</entry>
</row>
<row>
  <entry
><option
>-E</option
>, <option
>--exec-display <replaceable
>commandline</replaceable
></option
></entry>
  <entry
>Specify a shell command to execute to generate the alarm message text. If specified, this option must be the last &kalarm; option in &kalarm;'s command line. All subsequent command parameters and options are interpreted as forming the command line to execute. <option
>--exec</option
>, <option
>--file</option
> and <option
>--mail</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-f</option
>, <option
>--file <replaceable
>URL</replaceable
></option
></entry>
  <entry
>Specify the path or &URL; of a text or image file whose contents are to form the alarm message. <option
>--exec</option
>, <option
>--exec-display</option
> and <option
>--mail</option
> cannot be specified, and <replaceable
>message</replaceable
> must not be present with this option.</entry>
</row>
<row>
  <entry
><option
>-F</option
>, <option
>--from-id <replaceable
>ID</replaceable
></option
></entry>
  <entry
>Use the specified &kmail; identity as the sender of the email. <option
>--mail</option
> must be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-i</option
>, <option
>--interval <replaceable
>period</replaceable
></option
></entry>
  <entry
>Set the interval between repetitions of the alarm. Hours/minutes are specified in the format <replaceable
>nHnM</replaceable
>, where <replaceable
>n</replaceable
> is a number, &eg; 3H30M. Other time periods are specified in the format <replaceable
>nX</replaceable
>, where <replaceable
>n</replaceable
> is a number and <replaceable
>X</replaceable
> is one of the following letters: Y (years), M (months), W (weeks), D (days). If <option
>--recurrence</option
> is also specified, Y (years) and M (months) are not allowed. Mandatory if <option
>--repeat</option
> or <option
>--until</option
> is specified.</entry>
</row>
<row>
  <entry
><option
>-k</option
>, <option
>--korganizer</option
></entry>
  <entry
>Show the alarm as an event in &korganizer;'s active calendar.</entry>
</row>
<row>
  <entry
><option
>-l</option
>, <option
>--late-cancel <replaceable
>period</replaceable
></option
></entry>
  <entry
>Cancel the alarm if it cannot be triggered within the specified <replaceable
>period</replaceable
> after the correct time. The <replaceable
>period</replaceable
> is specified in the same format as described for <option
>--reminder</option
>. The default value of <replaceable
>period</replaceable
> is 1 minute.</entry>
</row>
<row>
  <entry
><option
>-L</option
>, <option
>--login</option
></entry>
  <entry
>Trigger the alarm every time you log in. <option
>--interval</option
>, <option
>--repeat</option
> and <option
>--until</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-m</option
>, <option
>--mail <replaceable
>address</replaceable
></option
></entry>
  <entry
>Send an email to the specified address. This option may be repeated as necessary. <option
>--exec</option
>, <option
>--exec-display</option
> and <option
>--file</option
> cannot be specified with this option. <option
>--ack-confirm</option
>, <option
>--beep</option
>, <option
>--color</option
> and <option
>--colorfg</option
> are ignored with this option.</entry>
</row>
<row>
  <entry
><option
>-p</option
>, <option
>--play <replaceable
>URL</replaceable
></option
></entry>
  <entry
>Specify the path or &URL; of an audio file to be played once, either as an audio alarm or when the alarm message is displayed. <option
>--play-repeat</option
>, <option
>--beep</option
> and <option
>--speak</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-P</option
>, <option
>--play-repeat <replaceable
>URL</replaceable
></option
></entry>
  <entry
>Specify the path or &URL; of an audio file to be played repeatedly, either until <guilabel
>Stop Play</guilabel
> is used, or for as long as the alarm message is displayed. <option
>--play</option
>, <option
>--beep</option
> and <option
>--speak</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>--recurrence <replaceable
>spec</replaceable
></option
></entry>
  <entry
>Set the alarm to recur. Specify the recurrence using iCalendar syntax (defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>), &eg; <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
>. <option
>--until</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-r</option
>, <option
>--repeat <replaceable
>count</replaceable
></option
></entry>
  <entry
>Set the number of times the alarm should be triggered, or if a recurrence is specified with <option
>--recurrence</option
>, the number of times the alarm should be triggered each time <option
>--recurrence</option
> activates it (&ie; a repetition within a recurrence). If <option
>--recurrence</option
> is not present, specify -1 to repeat the alarm indefinitely. <option
>--interval</option
> must be, and <option
>--until</option
> cannot be, specified with this option.</entry>
</row>
<row>
  <entry
><option
>-R</option
>, <option
>--reminder <replaceable
>period</replaceable
></option
></entry>
  <entry
>Output a reminder alarm the specified length of time before the main alarm and each of its recurrences (if any). Hours/minutes are specified in the format <replaceable
>nHnM</replaceable
>, where <replaceable
>n</replaceable
> is a number, &eg; 3H30M. Other time periods are specified in the format <replaceable
>nX</replaceable
>, where <replaceable
>n</replaceable
> is a number and <replaceable
>X</replaceable
> is one of the following letters: W (weeks), D (days). This option cannot be specified with <option
>--exec</option
>, <option
>--mail</option
> or <option
>--reminder-once</option
>.</entry>
</row>
<row>
  <entry
><option
>--reminder-once <replaceable
>period</replaceable
></option
></entry>
  <entry
>Output a reminder alarm once, the specified length of time before the first recurrence of the alarm. No reminder will be displayed before subsequent recurrences (if any). This option cannot be specified with <option
>--exec</option
>, <option
>--mail</option
> or <option
>--reminder</option
>.</entry>
</row>
<row>
  <entry
><option
>-s</option
>, <option
>--speak</option
></entry>
  <entry
>Speak the message when it is displayed. This option requires &jovie; to be installed and configured, together with a compatible speech synthesizer. <option
>--beep</option
>, <option
>--play</option
> and <option
>--play-repeat</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-S</option
>, <option
>--subject <replaceable
>subject</replaceable
></option
></entry>
  <entry
>The subject line of the email. <option
>--mail</option
> must be specified with this option.</entry>
</row>
<row>
  <entry
><option
>-t</option
>, <option
>--time <replaceable
>date/time</replaceable
></option
></entry>
  <entry
>Trigger alarm on the date or at the date/time specified. Specify a date without a time in the format <replaceable
>yyyy-mm-dd [TZ]</replaceable
>; specify a date and time by <replaceable
>[[[yyyy-]mm-]dd-]hh:mm [TZ]</replaceable
> (where omitted, date fields default to the values for today). If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</entry>
</row>
<row>
  <entry
><option
>-v</option
>, <option
>--volume <replaceable
>percentage</replaceable
></option
></entry>
  <entry
>Set the audio volume for playing the audio file. This option can only be used when <option
>--play</option
> or <option
>--play-repeat</option
> is specified.</entry>
</row>
<row>
  <entry
><option
>-u</option
>, <option
>--until <replaceable
>date/time</replaceable
></option
></entry>
  <entry
>Repeat the alarm until the date or date/time specified. Specify the date or date/time using the same syntax as for <option
>--time</option
>. Note that if <option
>--time</option
> is specified, the time zone will be taken from its value and no time zone may be included in the <option
>--until</option
> value. <option
>--interval</option
> must be, and <option
>--repeat</option
> and <option
>--recurrence</option
> cannot be, specified with this option.</entry>
</row>
<row>
  <entry
><replaceable
>bericht</replaceable
></entry>
  <entry
>Message text to display or, if <option
>--mail</option
> is specified, the body of the email message.</entry>
</row>
</tbody>
</tgroup>
</informaltable>

<para
>Either a message text, <option
>--file</option
>, <option
>--exec</option
>, <option
>--exec-display</option
>, <option
>--play</option
> or <option
>--play-repeat</option
> must be specified; except as noted above, all the options are optional.</para>

<para
>Two alternative examples which display a multi-line message with a red background at 10 p.m. on the 27th of this month are:</para>

<informalexample
><screen
><prompt>%</prompt> <userinput><command>kalarm</command> <option>-c <replaceable>red</replaceable></option> <option>-t <replaceable>27-22:00</replaceable></option> <option><replaceable>"Remember to\nSTOP"</replaceable></option></userinput>
<prompt>%</prompt> <userinput><command>kalarm</command> <option>-c <replaceable>0xFF0000</replaceable></option> <option>-t <replaceable>27-22:00</replaceable></option> <option><replaceable>"Remember to\nSTOP"</replaceable></option></userinput>
</screen>
</informalexample>

</sect1>

<sect1 id="cmdline-other">
<title
>Andere opties</title>

<para
>The following options are used to display the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
>, or to control &kalarm;'s display mode.</para>

<informaltable>
<tgroup cols="2">
<thead>
<row>
  <entry
>Optie</entry>
  <entry
>Beschrijving</entry>
</row>
</thead>
<tbody>
<row>
  <entry
><option
>--edit <replaceable
>eventID</replaceable
></option
></entry>
  <entry
>Display the Alarm Edit dialog to edit the alarm with the specified event ID.</entry>
</row>
<row>
  <entry
><option
>--edit-new-audio</option
></entry>
  <entry
>Display the Alarm Edit dialog, in order to edit a new audio alarm.</entry>
</row>
<row>
  <entry
><option
>--edit-new-command</option
></entry>
  <entry
>De dialoog om alarmen te bewerken tonen, om een nieuwe commando-herinnering te maken.</entry>
</row>
<row>
  <entry
><option
>--edit-new-display</option
></entry>
  <entry
>Display the Alarm Edit dialog, in order to edit a new display alarm.</entry>
</row>
<row>
  <entry
><option
>--edit-new-email</option
></entry>
  <entry
>Display the Alarm Edit dialog, in order to edit a new email alarm.</entry>
</row>
<row>
  <entry
><option
>--edit-new-preset <replaceable
>sjabloonnaam</replaceable
></option
></entry>
  <entry
>Display the Alarm Edit dialog, preset with the alarm template of the specified name, in order to edit a new alarm.</entry>
</row>
<row>
  <entry
><option
>--tray</option
></entry>
  <entry
>&kalarm; als een pictogram tonen in het systeemvak.</entry>
</row>
</tbody>
</tgroup>
</informaltable>

</sect1>

<sect1 id="cmdline-help">
<title
>Help-opties</title>

<para
>De volgende help-opties gelden voor alle &kde;-programma's:</para>

<informaltable>
<tgroup cols="2">
<thead>
<row>
  <entry
>Optie</entry>
  <entry
>Beschrijving</entry>
</row>
</thead>
<tbody>
<row>
  <entry
><option
>--help</option
></entry>
  <entry
>Een korte helptekst met opties tonen.</entry>
</row>
<row>
  <entry
><option
>--help-qt</option
></entry>
  <entry
>Shows numerous generic &Qt;-specific options.</entry>
</row>
<row>
  <entry
><option
>--help-kde</option
></entry>
  <entry
>Shows numerous generic &kde;-specific options.</entry>
</row>
<row>
  <entry
><option
>--help-all</option
></entry>
  <entry
>Alle opties tonen.</entry>
</row>
<row>
  <entry
><option
>--author</option
></entry>
  <entry
>De namen en e-mailadressen van de &kalarm;-auteurs tonen.</entry>
</row>
<row>
  <entry
><option
>-v</option
>, <option
>--version</option
></entry>
  <entry
>De huidige versies van de &Qt;-bibliotheek, &kde; en &kalarm; tonen.</entry>
</row>
<row>
  <entry
><option
>--license</option
></entry>
  <entry
>Licentie-informatie tonen.</entry>
</row>
</tbody>
</tgroup>
</informaltable>

</sect1>
</chapter>

<chapter id="developers">
<title
>Developer's Guide to &kalarm;</title>

<para
>&kalarm; provides an interface to allow other applications to request the following functions:</para>

<itemizedlist>
<listitem
><para
>schedule a new alarm</para
></listitem>
<listitem
><para
>een reeds geplande herinnering annuleren</para
></listitem>
<listitem
><para
>een reeds geplande herinnering activeren</para
></listitem>
<listitem
><para
>de dialoog om alarmen te bewerken tonen</para
></listitem>
</itemizedlist>

<para
>Each of the above functions is implemented both by a &DBus; call and by the command line. &DBus; calls should be used in preference if &kalarm; is already running.</para>

<sect1 id="dbus-interface">
<title
>&DBus;-interface</title>

<para
>The &DBus; calls described in this document are all implemented in &kalarm;'s <constant
>/kalarm</constant
> &DBus; object path. The interface is defined in the files <filename
>org.kde.kalarm.kalarm.xml</filename
> and <filename
>kalarmiface.h</filename
>.</para>

<refentry id="cancelEvent">
<refmeta>
<refentrytitle
>cancelEvent</refentrytitle>
</refmeta>
<refnamediv>
<refname
>cancelEvent</refname>
<refpurpose
>Annuleer een reeds geplande herinnering.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>void cancelEvent(const QString&amp; <replaceable
>eventID</replaceable
>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>eventID</parameter
></term>
<listitem>
<para
>Specificeert de unieke ID van de te annuleren gebeurtenis.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>

<para
><function
>cancelEvent()</function
> is een &DBus;-aanroep om de gespecificeerde herinnering te annuleren. &kalarm; verwijdert de herinnering uit de agenda zonder het te tonen of uit te voeren.</para>

</refsect1>
</refentry>

<refentry id="triggerEvent">
<refmeta>
<refentrytitle
>triggerEvent</refentrytitle>
</refmeta>
<refnamediv>
<refname
>triggerEvent</refname>
<refpurpose
>activeert een reeds geplande herinnering.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>void triggerEvent(const QString&amp; <replaceable
>eventID</replaceable
>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>eventID</parameter
></term>
<listitem>
<para
>Specificeert de unieke ID van de te activeren gebeurtenis.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>

<para
><function
>triggerEvent()</function
> is een &DBus;-aanroep om het onmiddelijk tonen of uitvoeren van de gespecificeerde herinnering te activeren (onafhankelijk van welke tijd het was gepland). &kalarm; haalt de herinnering uit de agenda en toont het of voert het uit.</para>

<para
>If the alarm is already due, &kalarm; then deletes all scheduled occurrences of the alarm up to the current time, and if no repetitions of the alarm still remain, the alarm is deleted from the calendar. If the alarm is not due yet, its scheduled occurrences are left unchanged.</para>

</refsect1>
</refentry>

<refentry id="scheduleMessage">
<refmeta>
<refentrytitle
>scheduleMessage</refentrytitle>
</refmeta>
<refnamediv>
<refname
>scheduleMessage</refname>
<refpurpose
>plan een nieuw herinneringsbericht.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool scheduleMessage(const QString&amp; <replaceable
>message</replaceable
>,
                     const QString&amp; <replaceable
>startDateTime</replaceable
>,
                     int <replaceable
>lateCancel</replaceable
>,
                     unsigned <replaceable
>flags</replaceable
>, 
                     const QString&amp; <replaceable
>bgColor</replaceable
>, 
                     const QString&amp; <replaceable
>fgColor</replaceable
>, 
                     const QString&amp; <replaceable
>font</replaceable
>, 
                     const QString&amp; <replaceable
>audioURL</replaceable
>, 
                     int <replaceable
>reminderMins</replaceable
>, 
                     const QString&amp; <replaceable
>recurrence</replaceable
>,
                     int <replaceable
>subRepeatInterval</replaceable
>, 
                     int <replaceable
>subRepeatCount</replaceable
>)
</synopsis>
<synopsis
>bool scheduleMessage(const QString&amp; <replaceable
>message</replaceable
>, 
                     const QString&amp; <replaceable
>startDateTime</replaceable
>, 
                     int <replaceable
>lateCancel</replaceable
>,
                     unsigned <replaceable
>flags</replaceable
>, 
                     const QString&amp; <replaceable
>bgColor</replaceable
>, 
                     const QString&amp; <replaceable
>fgColor</replaceable
>, 
                     const QString&amp; <replaceable
>font</replaceable
>, 
                     const QString&amp; <replaceable
>audioURL</replaceable
>, 
                     int <replaceable
>reminderMins</replaceable
>, 
                     int <replaceable
>recurType</replaceable
>, 
                     int <replaceable
>recurInterval</replaceable
>, 
                     int <replaceable
>recurCount</replaceable
>)
</synopsis>
<synopsis
>bool scheduleMessage(const QString&amp; <replaceable
>message</replaceable
>, 
                     const QString&amp; <replaceable
>startDateTime</replaceable
>, 
                     int <replaceable
>lateCancel</replaceable
>, 
                     unsigned <replaceable
>flags</replaceable
>, 
                     const QString&amp; <replaceable
>bgColor</replaceable
>, 
                     const QString&amp; <replaceable
>fgColor</replaceable
>, 
                     const QString&amp; <replaceable
>font</replaceable
>, 
                     const QString&amp; <replaceable
>audioURL</replaceable
>, 
                     int <replaceable
>reminderMins</replaceable
>, 
                     int <replaceable
>recurType</replaceable
>, 
                     int <replaceable
>recurInterval</replaceable
>, 
                     const QString&amp; <replaceable
>endDateTime</replaceable
>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>bericht</parameter
></term>
<listitem>
<para
>Specifies the text of the message to be scheduled, or if <parameter
>flags</parameter
> has the <userinput
>DISPLAY_COMMAND</userinput
> bit set, specifies the command line to execute to generate the message text.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>startDateTime</parameter
></term>
<listitem>
<para
>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <replaceable
>YYYY-MM-DD [TZ]</replaceable
> (as returned by <methodname
>QDate::toString(Qt::ISODate)</methodname
>). For an alarm with a date and time, the string should be in the format <replaceable
>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable
> (as returned by <methodname
>QDateTime::toString(Qt::ISODate)</methodname
>) or <replaceable
>HH:MM[:SS] [Clock]</replaceable
> (as returned by <methodname
>QTime::toString(Qt::ISODate)</methodname
>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para>

<para
>If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lateCancel</parameter
></term>
<listitem>
<para
>Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>flags</parameter
></term>
<listitem>
<para
>Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Note that not all flag bits are applicable to message alarms.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>bgColor</parameter
></term>
<listitem>
<para
>Specifies the background color for displaying the message. The string may be in the format <quote
>#RRGGBB</quote
> (as returned by <methodname
>QColor::name()</methodname
>) where RR, GG and BB are two-digit hexadecimal values for red, green and blue. Alternatively the string may be in any of the other formats accepted by <methodname
>QColor::setNamedColor()</methodname
>, such as a name from the X color database (&eg; <quote
>red</quote
> or <quote
>steelblue</quote
>). Set the string to null to specify the current default background color.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>fgColor</parameter
></term>
<listitem>
<para
>Specifies the foreground color for displaying the message. The format of the string is the same as for <parameter
>bgColor</parameter
>, or alternatively set the string to null to specify the current default foreground color.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lettertype</parameter
></term>
<listitem>
<para
>Specifies the font for displaying the message. The format of the string is that output by <methodname
>QFont::toString()</methodname
>. Set the string to null to use the default message font current at the time the message is displayed.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>audioURL</parameter
></term>
<listitem>
<para
>Specifies the audio file which is to be played when the message is displayed. Set the value to null if no audio file is to be played.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>reminderMins</parameter
></term>
<listitem>
<para
>Specifies the number of minutes in advance of the main alarm and of each of its recurrences (if any) at which a reminder alarm should be displayed. Specify 0 if no reminder is required.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>herhaling</parameter
></term>
<listitem>
<para
>Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>. For example, <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
> would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurType</parameter
></term>
<listitem>
<para
>Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the <parameter
>startDateTime</parameter
> parameter.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurInterval</parameter
></term>
<listitem>
<para
>Specifies the number of periods (minutes/days/weeks/months/years as specified by <parameter
>recurType</parameter
>) between recurrences of the alarm.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurCount</parameter
></term>
<listitem>
<para
>Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>endDateTime</parameter
></term>
<listitem>
<para
>Specifies the end date, or date and time, for recurrences of the alarm. If <parameter
>startDateTime</parameter
> includes a time, this parameter must also include a time; if <parameter
>startDateTime</parameter
> contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for <parameter
>startDateTime</parameter
> is used to interpret this parameter's value.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatInterval</parameter
></term>
<listitem>
<para
>Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatCount</parameter
></term>
<listitem>
<para
>Specifies the number of sub-repetitions of the alarm, including the initial occurrence.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1 id="scheduleMessage-descrip">
<title
>Beschrijving</title>
<para
><function
>scheduleMessage()</function
> is a &DBus; call to schedule the specified alarm message for display at the specified date and time. It has three forms. The most general form allows an arbitrary recurrence to be specified &ndash; use this also for non-repeating alarms. The other forms provide convenient access to a restricted set of alarm recurrence types, one specifying a repetition count and the other an end time.</para>

<para
>If the scheduled time (including any repetitions) has already passed, &kalarm; immediately displays the message (unless the <parameter
>lateCancel</parameter
> value indicates that it is now too late to display the alarm, in which case &kalarm; ignores the request). If the scheduled time (or a repetition) is in the future, &kalarm; adds the alarm message to the default active alarm calendar for later display.</para>
</refsect1>
</refentry>

<refentry id="scheduleFile">
<refmeta>
<refentrytitle
>scheduleFile</refentrytitle>
</refmeta>
<refnamediv>
<refname
>scheduleFile</refname>
<refpurpose
>schedule a new alarm which displays the contents of a text or image file.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool scheduleFile(const QString&amp; <replaceable>URL</replaceable>,
                  const QString&amp; <replaceable>startDateTime</replaceable>,
                  int <replaceable>lateCancel</replaceable>,
                  unsigned <replaceable>flags</replaceable>,
                  const QString&amp; <replaceable>bgColor</replaceable>,
                  const QString&amp; <replaceable>audioURL</replaceable>,
                  int <replaceable>reminderMins</replaceable>,
                  const QString&amp; <replaceable>recurrence</replaceable>,
                  int <replaceable>subRepeatInterval</replaceable>, 
                  int <replaceable>subRepeatCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleFile(const QString&amp; <replaceable>URL</replaceable>,
                  const QString&amp; <replaceable>startDateTime</replaceable>,
                  int <replaceable>lateCancel</replaceable>,
                  unsigned <replaceable>flags</replaceable>,
                  const QString&amp; <replaceable>bgColor</replaceable>,
                  const QString&amp; <replaceable>audioURL</replaceable>,
                  int <replaceable>reminderMins</replaceable>,
                  int <replaceable>recurType</replaceable>,
                  int <replaceable>recurInterval</replaceable>,
                  int <replaceable>recurCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleFile(const QString&amp; <replaceable>URL</replaceable>,
                  const QString&amp; <replaceable>startDateTime</replaceable>,
                  int <replaceable>lateCancel</replaceable>,
                  unsigned <replaceable>flags</replaceable>,
                  const QString&amp; <replaceable>bgColor</replaceable>,
                  const QString&amp; <replaceable>audioURL</replaceable>,
                  int <replaceable>reminderMins</replaceable>,
                  int <replaceable>recurType</replaceable>,
                  int <replaceable>recurInterval</replaceable>,
                  const QString&amp; <replaceable>endDateTime</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>URL-adres</parameter
></term>
<listitem>
<para
>Specifies the text or image file whose contents are to be displayed in the message to be scheduled.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>startDateTime</parameter
></term>
<listitem>
<para
>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <replaceable
>YYYY-MM-DD [TZ]</replaceable
> (as returned by <methodname
>QDate::toString(Qt::ISODate)</methodname
>). For an alarm with a date and time, the string should be in the format <replaceable
>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable
> (as returned by <methodname
>QDateTime::toString(Qt::ISODate)</methodname
>) or <replaceable
>HH:MM[:SS] [Clock]</replaceable
> (as returned by <methodname
>QTime::toString(Qt::ISODate)</methodname
>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para>

<para
>If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lateCancel</parameter
></term>
<listitem>
<para
>Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>flags</parameter
></term>
<listitem>
<para
>Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Note that not all flag bits are applicable to file alarms.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>bgColor</parameter
></term>
<listitem>
<para
>Specifies the background color for displaying the file. The string may be in the format <quote
>#RRGGBB</quote
> (as returned by <methodname
>QColor::name()</methodname
>) where RR, GG and BB are two-digit hexadecimal values for red, green and blue. Alternatively the string may be in any of the other formats accepted by <methodname
>QColor::setNamedColor()</methodname
>, such as a name from the X color database (&eg; <quote
>red</quote
> or <quote
>steelblue</quote
>). Set the string to null to specify the current default background color.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>audioURL</parameter
></term>
<listitem>
<para
>Specifies the audio file which is to be played when the message is displayed. Set the value to null if no audio file is to be played.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>reminderMins</parameter
></term>
<listitem>
<para
>Specifies the number of minutes in advance of the main alarm and of each of its recurrences (if any) at which a reminder alarm should be displayed. Specify 0 if no reminder is required.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>herhaling</parameter
></term>
<listitem>
<para
>Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>. For example, <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
> would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurType</parameter
></term>
<listitem>
<para
>Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the <parameter
>startDateTime</parameter
> parameter.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurInterval</parameter
></term>
<listitem>
<para
>Specifies the number of periods (minutes/days/weeks/months/years as specified by <parameter
>recurType</parameter
>) between recurrences of the alarm.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurCount</parameter
></term>
<listitem>
<para
>Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>endDateTime</parameter
></term>
<listitem>
<para
>Specifies the end date, or date and time, for recurrences of the alarm. If <parameter
>startDateTime</parameter
> includes a time, this parameter must also include a time; if <parameter
>startDateTime</parameter
> contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for <parameter
>startDateTime</parameter
> is used to interpret this parameter's value.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatInterval</parameter
></term>
<listitem>
<para
>Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatCount</parameter
></term>
<listitem>
<para
>Specifies the number of sub-repetitions of the alarm, including the initial occurrence.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>
<para
><function
>scheduleFile()</function
> is a &DBus; call to schedule the specified text or image file for display at the specified date and time. Apart from specifying a file path or &URL; and omitting the foreground color and font, its usage is identical to <link linkend="scheduleMessage-descrip"
><function
>scheduleMessage</function
></link
> - see the description of that function for further details.</para>
</refsect1>
</refentry>


<refentry id="scheduleCommand">
<refmeta>
<refentrytitle
>scheduleCommand</refentrytitle>
</refmeta>
<refnamediv>
<refname
>scheduleCommand</refname>
<refpurpose
>een nieuwe herinnering plannen die een shellcommando uitvoert.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool scheduleCommand(const QString&amp; <replaceable>commandLine</replaceable>,
                     const QString&amp; <replaceable>startDateTime</replaceable>,
                     int <replaceable>lateCancel</replaceable>,
                     unsigned <replaceable>flags</replaceable>,
                     const QString&amp; <replaceable>recurrence</replaceable>,
                     int <replaceable>subRepeatInterval</replaceable>, 
                     int <replaceable>subRepeatCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleCommand(const QString&amp; <replaceable>commandLine</replaceable>,
                     const QString&amp; <replaceable>startDateTime</replaceable>,
                     int <replaceable>lateCancel</replaceable>,
                     unsigned <replaceable>flags</replaceable>,
                     int <replaceable>recurType</replaceable>,
                     int <replaceable>recurInterval</replaceable>,
                     int <replaceable>recurCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleCommand(const QString&amp; <replaceable>commandLine</replaceable>,
                     const QString&amp; <replaceable>startDateTime</replaceable>,
                     int <replaceable>lateCancel</replaceable>,
                     unsigned <replaceable>flags</replaceable>,
                     int <replaceable>recurType</replaceable>,
                     int <replaceable>recurInterval</replaceable>,
                     const QString&amp; <replaceable>endDateTime</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>commandLine</parameter
></term>
<listitem>
<para
>Specificeert het commando waarvan de uitvoering moet worden gepland. De parameter <parameter
>flags</parameter
> geeft aan of deze parameter een shell-commandoregel bevat of een commandoscript.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>startDateTime</parameter
></term>
<listitem>
<para
>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <replaceable
>YYYY-MM-DD [TZ]</replaceable
> (as returned by <methodname
>QDate::toString(Qt::ISODate)</methodname
>). For an alarm with a date and time, the string should be in the format <replaceable
>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable
> (as returned by <methodname
>QDateTime::toString(Qt::ISODate)</methodname
>) or <replaceable
>HH:MM[:SS] [Clock]</replaceable
> (as returned by <methodname
>QTime::toString(Qt::ISODate)</methodname
>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para>

<para
>If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lateCancel</parameter
></term>
<listitem>
<para
>Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>flags</parameter
></term>
<listitem>
<para
>Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Note that not all flag bits are applicable to command alarms.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>herhaling</parameter
></term>
<listitem>
<para
>Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>. For example, <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
> would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurType</parameter
></term>
<listitem>
<para
>Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the <parameter
>startDateTime</parameter
> parameter.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurInterval</parameter
></term>
<listitem>
<para
>Specifies the number of periods (minutes/days/weeks/months/years as specified by <parameter
>recurType</parameter
>) between recurrences of the alarm.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurCount</parameter
></term>
<listitem>
<para
>Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>endDateTime</parameter
></term>
<listitem>
<para
>Specifies the end date, or date and time, for recurrences of the alarm. If <parameter
>startDateTime</parameter
> includes a time, this parameter must also include a time; if <parameter
>startDateTime</parameter
> contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for <parameter
>startDateTime</parameter
> is used to interpret this parameter's value.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatInterval</parameter
></term>
<listitem>
<para
>Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatCount</parameter
></term>
<listitem>
<para
>Specifies the number of sub-repetitions of the alarm, including the initial occurrence.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>
<para
><function
>scheduleCommand()</function
> is a &DBus; call to schedule the specified shell command line, or command script, for execution at the specified date and time. Apart from specifying a command and omitting the message color, font and audio file parameters, its usage is identical to <link linkend="scheduleMessage-descrip"
><function
>scheduleMessage</function
></link
> - see the description of that function for further details.</para>
</refsect1>
</refentry>


<refentry id="scheduleEmail">
<refmeta>
<refentrytitle
>scheduleEmail</refentrytitle>
</refmeta>
<refnamediv>
<refname
>scheduleEmail</refname>
<refpurpose
>een nieuwe herinnering plannen die een e-mail stuurt.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool scheduleEmail(const QString&amp; <replaceable>fromID</replaceable>,
                   const QString&amp; <replaceable>addresses</replaceable>,
                   const QString&amp; <replaceable>subject</replaceable>,
                   const QString&amp; <replaceable>message</replaceable>,
                   const QString&amp; <replaceable>attachments</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>,
                   unsigned <replaceable>flags</replaceable>,
                   const QString&amp; <replaceable>recurrence</replaceable>,
                   int <replaceable>subRepeatInterval</replaceable>, 
                   int <replaceable>subRepeatCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleEmail(const QString&amp; <replaceable>fromID</replaceable>,
                   const QString&amp; <replaceable>addresses</replaceable>,
                   const QString&amp; <replaceable>subject</replaceable>,
                   const QString&amp; <replaceable>message</replaceable>,
                   const QString&amp; <replaceable>attachments</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>,
                   unsigned <replaceable>flags</replaceable>,
                   int <replaceable>recurType</replaceable>,
                   int <replaceable>recurInterval</replaceable>,
                   int <replaceable>recurCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleEmail(const QString&amp; <replaceable>fromID</replaceable>,
                   const QString&amp; <replaceable>addresses</replaceable>,
                   const QString&amp; <replaceable>subject</replaceable>,
                   const QString&amp; <replaceable>message</replaceable>,
                   const QString&amp; <replaceable>attachments</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>, 
                   unsigned <replaceable>flags</replaceable>,
                   int <replaceable>recurType</replaceable>,
                   int <replaceable>recurInterval</replaceable>,
                   const QString&amp; <replaceable>endTime</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>fromID</parameter
></term>
<listitem>
<para
>De te gebruiken identiteit van &kmail; als de afzender van de e-mail. Indien leeg, zal het e-mailadres van de afzender dat in de <link linkend="preferences-email"
>E-mailvoorkeuren</link
> in &kalarm; is ingesteld worden gebruikt.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>adressen</parameter
></term>
<listitem>
<para
>Een door kommagescheiden lijst met e-mailadressen van ontvangers.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>onderwerp</parameter
></term>
<listitem>
<para
>Specificeert de regel met het onderwerp van de e-mail.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>bericht</parameter
></term>
<listitem>
<para
>Specifies the email message body.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>bijlagen</parameter
></term>
<listitem>
<para
>A comma-separated list of paths or &URL;s of files to send as email attachments.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>startDateTime</parameter
></term>
<listitem>
<para
>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <replaceable
>YYYY-MM-DD [TZ]</replaceable
> (as returned by <methodname
>QDate::toString(Qt::ISODate)</methodname
>). For an alarm with a date and time, the string should be in the format <replaceable
>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable
> (as returned by <methodname
>QDateTime::toString(Qt::ISODate)</methodname
>) or <replaceable
>HH:MM[:SS] [Clock]</replaceable
> (as returned by <methodname
>QTime::toString(Qt::ISODate)</methodname
>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para>

<para
>If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lateCancel</parameter
></term>
<listitem>
<para
>Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>flags</parameter
></term>
<listitem>
<para
>Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Note that not all flag bits are applicable to email alarms.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>herhaling</parameter
></term>
<listitem>
<para
>Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>. For example, <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
> would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurType</parameter
></term>
<listitem>
<para
>Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the <parameter
>startDateTime</parameter
> parameter.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurInterval</parameter
></term>
<listitem>
<para
>Specifies the number of periods (minutes/days/weeks/months/years as specified by <parameter
>recurType</parameter
>) between recurrences of the alarm.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurCount</parameter
></term>
<listitem>
<para
>Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>endDateTime</parameter
></term>
<listitem>
<para
>Specifies the end date, or date and time, for recurrences of the alarm. If <parameter
>startDateTime</parameter
> includes a time, this parameter must also include a time; if <parameter
>startDateTime</parameter
> contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for <parameter
>startDateTime</parameter
> is used to interpret this parameter's value.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatInterval</parameter
></term>
<listitem>
<para
>Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatCount</parameter
></term>
<listitem>
<para
>Specifies the number of sub-repetitions of the alarm, including the initial occurrence.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>
<para
><function
>scheduleEmail()</function
> is a &DBus; call to schedule the specified email for sending at the specified date and time. Apart from specifying the email header and contents and omitting the message color, font and audio file parameters, its usage is identical to <link linkend="scheduleMessage-descrip"
><function
>scheduleMessage</function
></link
> - see the description of that function for further details.</para>
</refsect1>
</refentry>


<refentry id="scheduleAudio">
<refmeta>
<refentrytitle
>scheduleAudio</refentrytitle>
</refmeta>
<refnamediv>
<refname
>scheduleAudio</refname>
<refpurpose
>een nieuwe herinnering plannen die een shellcommando uitvoert.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
                   int <replaceable>volumePercent</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>,
                   unsigned <replaceable>flags</replaceable>,
                   const QString&amp; <replaceable>recurrence</replaceable>,
                   int <replaceable>subRepeatInterval</replaceable>, 
                   int <replaceable>subRepeatCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
                   int <replaceable>volumePercent</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>,
                   unsigned <replaceable>flags</replaceable>,
                   int <replaceable>recurType</replaceable>,
                   int <replaceable>recurInterval</replaceable>,
                   int <replaceable>recurCount</replaceable>)
</synopsis>
<synopsis
>bool scheduleAudio(const QString&amp; <replaceable>audioURL</replaceable>,
                   int <replaceable>volumePercent</replaceable>,
                   const QString&amp; <replaceable>startDateTime</replaceable>,
                   int <replaceable>lateCancel</replaceable>,
                   unsigned <replaceable>flags</replaceable>,
                   int <replaceable>recurType</replaceable>,
                   int <replaceable>recurInterval</replaceable>,
                   const QString&amp; <replaceable>endDateTime</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>audioURL</parameter
></term>
<listitem>
<para
>Specificeert het geluidsbestand dat afgespeeld moet worden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>volumePercent</parameter
></term>
<listitem>
<para
>Specifies the volume level to use, as a percentage of full volume. Specify -1 to use the default volume.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>startDateTime</parameter
></term>
<listitem>
<para
>Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format <replaceable
>YYYY-MM-DD [TZ]</replaceable
> (as returned by <methodname
>QDate::toString(Qt::ISODate)</methodname
>). For an alarm with a date and time, the string should be in the format <replaceable
>YYYY-MM-DDTHH:MM[:SS] [TZ]</replaceable
> (as returned by <methodname
>QDateTime::toString(Qt::ISODate)</methodname
>) or <replaceable
>HH:MM[:SS] [Clock]</replaceable
> (as returned by <methodname
>QTime::toString(Qt::ISODate)</methodname
>). If no date is specified, today's date is used. Note that any seconds value is ignored.</para>

<para
>If no time zone is specified, the local system time zone is assumed. If a time zone specifier <replaceable
>TZ</replaceable
> is present, it may be the name of a system time zone (&eg; <userinput
>Europe/London</userinput
>), <userinput
>UTC</userinput
> representing the UTC time zone, or <userinput
>Clock</userinput
> to use the local computer clock and ignore time zones.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>lateCancel</parameter
></term>
<listitem>
<para
>Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>flags</parameter
></term>
<listitem>
<para
>Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Note that not all flag bits are applicable to command alarms.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>herhaling</parameter
></term>
<listitem>
<para
>Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445</ulink
>. For example, <quote
>FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO</quote
> would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurType</parameter
></term>
<listitem>
<para
>Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from the <parameter
>startDateTime</parameter
> parameter.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurInterval</parameter
></term>
<listitem>
<para
>Specifies the number of periods (minutes/days/weeks/months/years as specified by <parameter
>recurType</parameter
>) between recurrences of the alarm.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>recurCount</parameter
></term>
<listitem>
<para
>Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>endDateTime</parameter
></term>
<listitem>
<para
>Specifies the end date, or date and time, for recurrences of the alarm. If <parameter
>startDateTime</parameter
> includes a time, this parameter must also include a time; if <parameter
>startDateTime</parameter
> contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as for <parameter
>startDateTime</parameter
> is used to interpret this parameter's value.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatInterval</parameter
></term>
<listitem>
<para
>Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>subRepeatCount</parameter
></term>
<listitem>
<para
>Specifies the number of sub-repetitions of the alarm, including the initial occurrence.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>
<para
><function
>scheduleAudio()</function
> is a &DBus; call to schedule the specified audio file to be played at the specified date and time. Apart from specifying a volume and omitting the message color and font parameters, its usage is identical to <link linkend="scheduleMessage-descrip"
><function
>scheduleMessage</function
></link
> - see the description of that function for further details.</para>
</refsect1>
</refentry>

<refentry id="dbus_edit">
<refmeta>
<refentrytitle
>bewerken</refentrytitle>
</refmeta>
<refnamediv>
<refname
>bewerken</refname>
<refpurpose
>Display the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
> to edit an alarm.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool edit(const QString&amp; <replaceable>eventID</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>eventID</parameter
></term>
<listitem>
<para
>Specifies the unique ID of the event to be edited.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>

<refsect2>
<title
>Teruggegeven waarde</title>
<para
><returnvalue
>onwaar</returnvalue
> als de gespecificeerde herinnering niet gevonden kon worden of alleen-lezen is, anders <returnvalue
>waar</returnvalue
>.</para>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>

<para
><function
>edit()</function
> is a &DBus; call to display the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
> to edit the specified alarm.</para>

</refsect1>
</refentry>

<refentry id="dbus_editnew">
<refmeta>
<refentrytitle
>editNew</refentrytitle>
</refmeta>
<refnamediv>
<refname
>editNew</refname>
<refpurpose
>Display the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
> to edit a new alarm.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis
>bool editNew(int <replaceable>type</replaceable>)
</synopsis>
<synopsis
>bool editNew(const QString&amp; <replaceable>templateName</replaceable>)
</synopsis>

<refsect2>
<title
>Parameters</title>
<variablelist>
<varlistentry>
<term
><parameter
>type</parameter
></term>
<listitem>
<para
>Specifies the alarm type. The permissible values are DISPLAY, COMMAND, EMAIL, AUDIO. These are defined in class <classname
>KAlarmIface</classname
> in <filename
>kalarmiface.h</filename
>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><parameter
>templateName</parameter
></term>
<listitem>
<para
>Specifies the name of an alarm template to base the new alarm on.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>

<refsect2>
<title
>Teruggegeven waarde</title>
<para
><returnvalue
>false</returnvalue
> if <parameter
>type</parameter
> has an invalid value, or if no template with the name <parameter
>templateName</parameter
> can be found; <returnvalue
>true</returnvalue
> otherwise.</para>
</refsect2>
</refsynopsisdiv>

<refsect1>
<title
>Beschrijving</title>

<para
><function
>editNew()</function
> is a &DBus; call to display the <link linkend="alarm-edit-dlg"
>Alarm Edit dialog</link
> to edit a new alarm. If an alarm type is specified as a parameter, a blank dialog is displayed. Alternatively, if an alarm template name is specified as a parameter, the dialog is preset with details from the template.</para>

</refsect1>
</refentry>

</sect1>

<sect1 id="cmdline-interface">
<title
>Command Line Interface</title>

<para
>Command line options are provided to enable other programs to start up &kalarm; if it is not already running, in order to trigger or cancel scheduled alarms, or schedule new alarms. The reason for using command line options for this purpose is that if &kalarm; were started without any command line parameters and then sent &DBus; requests, it would start in its default graphical mode, which is clearly undesirable for an inter-program request.</para>

<note
><para
>Programs should first check whether &kalarm; is already running; if it is, they should instead use &DBus; calls to request these operations.</para
></note>

<para
>The command line options for scheduling a new alarm are as described in the chapter <link linkend="cmdline-operation"
>Command Line Operation</link
>. The options for triggering and canceling scheduled alarms are as follows:</para>

<note
><para
>Normal users may also if they wish use these command line options (assuming that they can supply the necessary parameter information).</para
></note>

<informaltable>
<tgroup cols="2">
<thead>
<row>
  <entry
>Optie</entry>
  <entry
>Beschrijving</entry>
</row>
</thead>
<tbody>
<row>
  <entry
><option
>--cancelEvent <replaceable
>eventID</replaceable
></option
></entry>
  <entry
>Cancel the alarm with the specified event ID. <option
>--triggerEvent</option
> cannot be specified with this option.</entry>
</row>
<row>
  <entry
><option
>--triggerEvent <replaceable
>eventID</replaceable
></option
></entry>
  <entry
>Trigger the alarm with the specified event ID. The action taken is the same as for the <link linkend="triggerEvent"
>triggerEvent()</link
> &DBus; call. <option
>--cancelEvent</option
> cannot be specified with this option.</entry>
</row>
</tbody>
</tgroup>
</informaltable>

<para
>Voorbeelden zijn:</para>

<informalexample
><screen
><prompt>%</prompt> <userinput><command>kalarm</command> <option>--triggerEvent <replaceable>&kalarm;-387486299.702</replaceable></option></userinput>
<prompt>%</prompt> <userinput><command>kalarm</command> <option>--cancelEvent <replaceable>&kalarm;-388886299.793</replaceable></option></userinput>
</screen>
</informalexample>

</sect1>
</chapter>


<chapter id="faq">
<title
>Vragen en antwoorden</title>
&reporting.bugs; &updating.documentation; <qandaset id="faqlist">
<qandaentry>
<question>
<para
>Welke instellingenbestanden gebruikt &kalarm;?</para>
</question>
<answer>
<para
><filename
>$KDEHOME/share/config/kalarmrc</filename
> holds your &kalarm; preferences.</para>
<para
><filename
>$KDEHOME/share/config/kresources/alarms/stdrc</filename
> holds your alarm calendar configuration.</para>

<para
>($<envar
>KDEHOME</envar
> is usually <filename class="directory"
>~/.kde</filename
> or similar.)</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para
>Waar worden de herinneringen van &kalarm; opgeslagen?</para>
</question>
<answer>

<para
>De namen van de agendabestanden die &kalarm; de eerste keer dat het wordt uitgevoerd aanmaakt zijn als volgt (maar kunnen overschreven worden door items in de sectie <parameter
>General</parameter
> van het voorkeursbestand van &kalarm;):</para>

<itemizedlist>
<listitem>
<para
><filename
>$KDEHOME/share/apps/kalarm/calendar.ics</filename
> bevat de actieve herinneringen (overschrijfbaar door het item <parameter
>Calendar</parameter
>).</para>
</listitem>

<listitem>
<para
><filename
>$KDEHOME/share/apps/kalarm/expired.ics</filename
> bevat verlopen herinneringen (overschrijfbaar door het item <parameter
>ExpiredCalendar</parameter
>).</para>
</listitem>

<listitem>
<para
><filename
>$KDEHOME/share/apps/kalarm/template.ics</filename
> bevat de herinneringssjablonen (overschrijfbaar door het item <parameter
>TemplateCalendar</parameter
>).</para>
</listitem>
</itemizedlist>

<para
>You can find out which calendar files are currently in use by viewing each calendar's details in the alarm calendars list. The file names are stored in the alarm calendar configuration file.</para>

<para
>Details of alarms currently being displayed are stored in the calendar file <filename
>$KDEHOME/share/apps/kalarm/displaying.ics</filename
>.</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para
>In welk formaat worden herinneringen opgeslagen?</para>
</question>
<answer>
<para
>The calendar files in which &kalarm; stores its alarms are text files whose format is defined by the document <ulink url="http://www.w3.org/2002/12/cal/rfc2445.html"
>RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)</ulink
>. This is the standard format used by all kdepim applications. &kalarm; uses certain non-standard properties, in conformance with RFC2445. In the VEVENT component: <literal
>X-KDE-KALARM-FLAGS</literal
>, <literal
>X-KDE-KALARM-NEXTRECUR</literal
>, <literal
>X-KDE-KALARM-REPEAT</literal
>, <literal
>X-KDE-KALARM-ARCHIVE</literal
>, <literal
>X-KDE-KALARM-LOG</literal
>, and in the VALARM component: <literal
>X-KDE-KALARM-TYPE</literal
>, <literal
>X-KDE-KALARM-NEXTREPEAT</literal
>, <literal
>X-KDE-KALARM-FONTCOLOR</literal
>, <literal
>X-KDE-KALARM-VOLUME</literal
>, <literal
>X-KDE-KALARM-SPEAK</literal
>, <literal
>X-KDE-KALARM-EMAILID</literal
>.</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para
>What is the program <application
>kalarmautostart</application
>?</para>
</question>
<answer>
<para
><application
>kalarmautostart</application
> is a little helper program whose function is to autostart &kalarm; at login.</para>

<para
>&kalarm; is usually restored by the session manager at login (to redisplay its windows in the same state as they were when you logged off). But if it was not running when you logged off, it would not be started by the session manager and therefore needs to be autostarted. The problem is that when an application is both session managed and autostarted, there is no guarantee as to which will occur first. If autostart gets in first, it will prevent the session manager from restoring the application's state.</para>

<para
>To avoid this problem, <application
>kalarmautostart</application
> is autostarted at login instead of &kalarm;. All it does is wait for a short time (to ensure that the session manager has time to do its job) before starting &kalarm;, at which point it terminates.</para>
</answer>
</qandaentry>

</qandaset>
</chapter>


<chapter id="credits">

<title
>Dankbetuigingen en licentie</title>

<para
>&kalarm; </para>
<para
>Programma copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 &David.Jarvie; &David.Jarvie.mail; </para>

<para
>Documentatie copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 &David.Jarvie; &David.Jarvie.mail; </para>

&meld.fouten;&vertaling.niels;&vertaling.freek; 
&underFDL; &underGPL; <para
>Dank aan de auteur van de &kde; 1 KAlarm applicatie, Stefan Nikolaus <email
>stefan.nikolaus@stuco.uni-oldenburg.de</email
>, die vriendelijk toestemming gaf om de naam &kalarm; voor deze applicatie te gebruiken, die beschikbaar is vanaf &kde; 2. </para>

</chapter>

<appendix id="installation">
<title
>Installatie</title>

<sect1 id="getting-kalarm">
<title
>Hoe &kalarm; te verkrijgen</title>
&install.intro.documentation; <para
>&kalarm; is beschikbaar voor &kde; 2 en als standalone pakketten voor &kde; 3 en &kde; 4 van <ulink url="http://www.astrojar.org.uk/kalarm"
>http://www.astrojar.org.uk/kalarm</ulink
> </para>

</sect1>

<sect1 id="requirements">
<title
>Benodigdheden</title>

<para
>&kalarm; requires the standard &kde; libraries to be installed (the <filename
>kdelibs</filename
> and <filename
>kdepimlibs</filename
> packages), plus the <filename
>kdebase/runtime</filename
> package. To compile from source, you also need the relevant library development packages, and the &Qt; development package.</para>

<para
>De volgende optionele pakketten, als ze zijn geïnstalleerd, vergroten het nut van &kalarm;:</para>

<itemizedlist>
<listitem
><para
>&jovie; (from kdeaccessibility package): if installed and configured, together with a compatible speech synthesizer package, it allows &kalarm; to speak alarm messages when they are displayed.</para>
</listitem>
</itemizedlist>

<para
>&kalarm; vereist ongeveer 12 MB aan werkgeheugen, maar dit kan variëren, afhankelijk van uw platform (type computer) en configuratie.</para>

<para
>You can find a list of changes in the <filename
>Changelog</filename
> file, or at <ulink url="http://www.astrojar.org.uk/kalarm"
>http://www.astrojar.org.uk/kalarm</ulink
>.</para>
</sect1>

<sect1 id="compilation">
<title
>Compilatie en installatie</title>

<para
>If you cannot obtain a suitable precompiled binary package, you need to compile &kalarm; yourself from source files. Get the source package file <filename
>kdepim-x.x.tar.bz2</filename
> or <filename
>kalarm-x.x.tar.bz2</filename
> (or similar), depending on whether you want to install &package; or just &kalarm;. Unpack it in a new folder using a command similar to <userinput
><command
>tar</command
> <option
>xvfj <replaceable
>package.tar.bz2</replaceable
></option
></userinput
>, and change to the folder which has been created.</para>
&install.compile.documentation; <note
><para
>If you have more than one version of &kde; installed (e.g. &kde; 2 and &kde; 3), this may possibly install &kalarm; into the wrong &kde; folder. If necessary, you can give the &kde; folder as a parameter to <userinput
><command
>./configure</command
></userinput
> . For example, if your &kde; is installed in <filename
>/opt/kde2</filename
>:</para>

<para
><userinput
><command
>./configure</command
> --prefix=<replaceable
>/opt/kde2</replaceable
></userinput
></para>
</note>

<warning
><para
>If you install &kalarm; into a folder different from where &kde; is installed, it will not run correctly unless you make its location known to &kde;. To do this, you must prefix the <envar
>KDEDIRS</envar
> environment variable with &kalarm;'s location, each time before you start &kde;.</para>

<para
>For example, if &kde; is installed in <literal
>/opt/kde</literal
>, <envar
>KDEDIRS</envar
> might normally be set to <literal
>/etc/opt/kde:/opt/kde</literal
>. If you install &kalarm; into <literal
>/usr/local</literal
>, you would need to set <envar
>KDEDIRS</envar
> to <literal
>/usr/local:/etc/opt/kde:/opt/kde</literal
> before starting &kde;.</para
></warning>

<para
>The standalone version of &kalarm; has a special configuration option which allows you to select which languages documentation is to be installed for by specifying a language code, or a list of language codes, as a parameter to <command
>./configure</command
>. By default, documentation in all available languages is installed. A list of documentation languages included in the package, together with their codes, is in the <filename
>DOC-LANGUAGES</filename
> file. For example, to install only French and British English documentation:</para>

<para
><userinput
><command
>./configure</command
> --enable-doc-language=<replaceable
>"fr en_GB"</replaceable
></userinput
></para>

<para
>Opmerking: deze optie heeft geen effect op de geïnstalleerde vertalingen van de (grafische) gebruikersinterface.</para>

</sect1>

<sect1 id="configuration">
<title
>Configuratie</title>

<para
>Er is geen speciale configuratie nodig om &kalarm; uit te voeren in een &kde;-omgeving. Vanaf dat u &kalarm; de eerste keer opstart, zal deze elke keer dat u zich aanmeldt opstarten, opdat geplande alarmen in het oog gehouden kunnen worden.</para>

<para
>Om &kalarm; uit te voeren in een niet-&kde; omgeving, moet u controleren dat &kalarm; automatisch wordt opgestart wanneer u zichzelf aanmeldt. Gedetailleerde instructies vindt u in het <filename
>INSTALL</filename
>-bestand, dat meegeleverd wordt met &kalarm;.</para>

</sect1>

</appendix>

&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->