When command line parameters are supplied, KAlarm does not display the list of scheduled alarms as described in Using KAlarm above. Command line options specific to KAlarm may be used to perform the following operations:
schedule a new alarm
control KAlarm's display mode
Additional command line options are provided primarily to enable other programs to interface to KAlarm. They are described in the chapter Developer's Guide to KAlarm.
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.
The following options are used to schedule a new alarm:
|Prompt for confirmation when the alarm message is acknowledged.|
|Specify the path or URL of a file which is to be attached
to the email. This option may be repeated as necessary.
|Automatically close the alarm window after the expiry of the
|Make an audible beep when the message is displayed.
|Blind copy the email to yourself.
|Set the message background color to the specified Qt™ color name or hex code 0xRRGGBB.|
|Set the message foreground color to the specified Qt™ color name or hex code 0xRRGGBB.|
|Disable the alarm. It will not trigger until it has been manually enabled.|
|Disable alarm monitoring. This prevents any alarms from
being triggered until you re-enable alarms or restart KAlarm, e.g.
at next login.
|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. |
|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.
|Specify the path or URL of a text or image file whose
contents are to form the alarm message. |
|Use the specified KMail identity as the sender of the
|Set the interval between repetitions of the alarm.
Hours/minutes are specified in the format
|Show the alarm as an event in KOrganizer's active calendar.|
|Cancel the alarm if it cannot be triggered within the
|Trigger the alarm every time you log in.
|Send an email to the specified address. This option may be
repeated as necessary. |
|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.
|Specify the path or URL of an audio file to be played
repeatedly, either until Stop Play is used, or
for as long as the alarm message is displayed.
|Set the alarm to recur. Specify the recurrence using iCalendar
syntax (defined in
|Set the number of times the alarm should be triggered, or if
a recurrence is specified with |
|Output a reminder alarm the specified length of time before
or after the main alarm and each of its recurrences (if any).
|Output a reminder alarm once, the specified length of time
before or after the first recurrence of the alarm. No reminder will
be displayed before or after subsequent recurrences (if any). The
|Speak the message when it is displayed. This option requires
Jovie to be installed and configured, together with a compatible
speech synthesizer. |
|The subject line of the email. |
|Trigger alarm on the date or at the date/time specified.
Specify a date without a time in the format
|Trigger alarm with the specified event ID.|
|Set the audio volume for playing the audio file. This option
can only be used when |
|Repeat the alarm until the date or date/time specified.
Specify the date or date/time using the same syntax as for
|Message text to display or, if |
Either a message text,
--play-repeat must be
specified; except as noted above, all the options are optional.
Two alternative examples which display a multi-line message with a red background at 10 p.m. on the 27th of this month are: