Command line interface
Prev
Next

Command line interface

Command line options are provided to enable other programs (such as the alarm daemon) 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 DCOP requests, it would start in its default graphical mode, which is clearly undesirable for an inter-program request.

Note

Programs should first check whether KAlarm is already running; if it is, they should instead use DCOP calls to request these operations.

The command line options for scheduling a new alarm are as described in the chapter Command line operation. The options for triggering and canceling scheduled alarms are as follows:

Note

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

OptionDescription
--calendarURL urlUse the calendar file with the specified URL. This option is only used for integrity checking: if the URL doesn't specify KAlarm's current default calendar file, the request will be ignored.
--cancelEvent eventIDCancel the alarm with the specified event ID.
--triggerEvent eventIDTrigger the alarm with the specified event ID. The action taken is the same as for the triggerEvent() DCOP call.
--handleEvent eventIDTrigger or cancel the alarm with the specified event ID. KAlarm determines which action to take in the same way as for the handleEvent() DCOP call.

--cancelEvent, --triggerEvent and --handleEvent are mutually exclusive. --calendarURL is optional, but can only be used with one of the other three options.

Examples are:

% kalarm --triggerEvent KAlarm-387486299.702 --calendarURL file:/home/zaphod/hydra.ics
% kalarm --cancelEvent KAlarm-388886299.793
Prev
Next
Home


Would you like to comment or contribute an update to this page?
Send feedback to the TDE Development Team