Глава 4. Работа с командной строкой

Если указаны параметры командной строки, KAlarm не отображает список запланированных напоминаний, описание которого приведено выше в разделе Использование KAlarm. Параметры командной строки KAlarm используются для следующих операций:

  • планирование нового напоминания

  • управление режимом отображения KAlarm

  • получение помощи

Дополнительные параметры командной строки предназначены главным образом для предоставления другим программам интерфейса к KAlarm. Их описание приводится в разделе Руководство разработчика KAlarm.

Командная строка должна содержать параметры, соответствующие одной операции KAlarm. Если требуется выполнить несколько операций, следует вызвать KAlarm несколько раз, каждый раз используя набор параметров для отдельной операции.

Планирование нового напоминания

Для планирования нового напоминания используются следующие параметры:

ПараметрОписание
-a, --ack-confirm Запрашивать подтверждения прочтения при закрытии окна напоминания.
-A, --attach URLУказать путь или URL-адрес файла, который должен быть вложен в письмо. Этот параметр можно использовать несколько раз. Указание параметра --mail обязательно.
--auto-closeАвтоматически закрывать окно напоминания по истечении интервала --late-cancel. Указание параметра --late-cancel обязательно.
-b, --beep Издавать звуковой сигнал при показе сообщения. Указание параметров --speak, --play и --play-repeat запрещено.
--bcc Направить скрытую копию письма самому себе. Указание параметра --mail обязательно.
-c, --color, --colour цветУстановить цвет фона сообщения, указав имя цвета Qt™ или его шестнадцатеричный код 0xRRGGBB.
-C, --colorfg, --colourfg цветУстановить цвет текста сообщения, указав имя цвета Qt™ или его шестнадцатеричный код 0xRRGGBB.
-d, --disableОтключить напоминание. Оно не сработает до тех пор, пока не будет включено вручную.
--disable-allОтключить отслеживание напоминаний. Это предотвращает срабатывание всех напоминаний до повторного включения отслеживания напоминаний или перезапуска KAlarm пользователем (например, при следующем входе в систему). Указание параметра --triggerEvent запрещено.
-e, --exec commandlineУказать команду оболочки для выполнения. Если команда указана, этот параметр должен быть последним в командной строке KAlarm. Все последующие параметры команды и опции интерпретируются как часть команды для выполнения. Указание параметров --file, --exec-display и --mail запрещено, а параметры --ack-confirm, --beep, --color и --colorfg будут проигнорированы.
-E, --exec-display commandlineУказать команду оболочки для создания текста напоминания. Если команда указана, этот параметр должен быть последним в командной строке KAlarm Все последующие параметры команды и опции интерпретируются как часть команды для выполнения. Указание параметров --exec, --file и --mail запрещено.
-f, --file URLУказать путь или URL-адрес текстового файла или файла изображения, содержимое которого будет формировать напоминание. Указание параметров --exec, --exec-display и --mail запрещено, как и указание сообщения.
-F, --from-id IDИспользовать данные указанного профиля KMail в качестве реквизитов отправителя письма. Указание параметра --mail обязательно.
-i, --interval периодИнтервал между (простыми) повторениями напоминания. Часы/минуты указываются в формате nHnM, где n — это число, например, 3H30M. Другие интервалы указываются в формате nX, где n — это число, а X — одна из следующих букв: Y (годы), M (месяцы), W (недели), D (дни). Если также указывается параметр --recurrence, указание Y и M запрещено. Является обязательным, если указан параметр --repeat или --until.
-k, --korganizerПоказывать напоминание как событие в активном календаре KOrganizer.
-l, --late-cancel периодОтменить напоминание, если оно не сработает в течение указанного периода после наступления запланированного времени. Часы/минуты указываются в формате nHnM, где n — это число, например, 3H30M. Другие интервалы указываются в формате nX, где n — это число, а X — одна из следующих букв: W (недели), D (дни). По умолчанию период равен 1 минуте.
-L, --loginВызывать напоминание при каждом входе в систему. Указание параметров --interval, --repeat и --until запрещено.
-m, --mail адресНаправить письмо по указанному адресу. При необходимости этот параметр возможно указать несколько раз. Указание параметров --exec, --exec-display и --file запрещено, а параметры --ack-confirm, --beep, --color и --colorfg будут проигнорированы.
-n, --nameУказать название для облегчения идентификации напоминания.
-N, --notifyПоказывать напоминание как системное уведомление, а не в окне. Указание параметров --color, --colorfg, --play, --ack-confirm и --auto-close запрещено.
-p, --play URLУказать путь или URL-адрес звукового файла, который будет однократно воспроизведён при срабатывании звукового напоминания или показе сообщения напоминания. Указание параметров --play-repeat, --beep и --speak запрещено.
-P, --play-repeat URLУказать путь или URL-адрес звукового файла, который будет повторяться вплоть до использования функции Остановить воспроизведение или закрытия окна напоминания. Указание параметров --play, --beep и --speak запрещено.
--recurrence specУстановить напоминание как многоразовое. Алгоритм повторения указывается с использованием синтаксиса iCalendar (определён в RFC2445), например: «FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO». Указание параметра --until запрещено.
-r, --repeat количествоУказать количество срабатываний напоминания или, если с помощью параметра --recurrence задано повторение, срабатываний напоминания при каждом повторении (то есть повторение внутри повторения). Если параметр --recurrence отсутствует, укажите -1 to для повторения напоминания в течение неограниченного периода времени. Указание параметра --interval обязательно, а указание параметра --until — запрещено.
-R, --reminder периодВывод дополнительного напоминания за указанное время до или после основного напоминания и каждого из его повторений (если они имеются). Период указывается в том же формате, что и для параметра --late-cancel. По умолчанию дополнительное напоминание срабатывает до основного напоминания. Чтобы задать срабатывание дополнительное напоминание после основного, добавьте перед периодом символ +, например: +3D. Указание параметров --exec, --mail и --reminder-once запрещено.
--reminder-once периодОднократный вывод дополнительного напоминания за указанное время до или после первого повторения основного напоминания. Дополнительное напоминание не будет показано до или после остальных повторений основного напоминания (если они имеются). Период указывается в том же формате, что и для параметра --reminder. Указание параметров --exec, --mail и --reminder запрещено.
-s, --speakОзвучить сообщение при его показе. Для работы этого параметра необходимо включить поддержку речи при сборке KAlarm, а также установить модуль речи Qt™. Указание параметров --beep, --play и --play-repeat запрещено.
-S, --subject темаТема письма. Указание параметра --mail обязательно.
-t, --time дата/времяВызвать напоминание в указанную дату или дату и время. Дата без времени указывается в формате гггг-мм-дд[ часовой пояс]; дата и время указываются в формате [[[гггг-]мм-]дд-]чч:мм[ часовой пояс] (если не указано, значением даты по умолчанию является текущая дата). Если часовой пояс не указан, используется часовой пояс локальной системы. Часовой пояс может быть системным часовым поясом (например, Европа/Лондон) или значением UTC, представляющим соответствующий часовой пояс UTC.
-v, --volume процентыГромкость звука при воспроизведении звукового файла. Указание параметра --play или --play-repeat обязательно.
-u, --until дата/времяПовторять напоминание до указанной даты или даты и времени. Дата без времени или дата и время указываются с использованием того же синтаксиса, что и для параметра --time. Обратите внимание: если параметр --time указан, будет использовано заданное им значение часового пояса, а в параметр --until нельзя включить часовой пояс. Указание параметра --interval обязательно, а параметров --repeat и --recurrence — запрещено.
сообщениеТекст сообщения для отображения или — если указан параметр --mail — тело письма.

Необходимо указать одно из следующих: текст сообщения, параметры --file, --exec, --exec-display, --play или --play-repeat; все остальные параметры являются необязательными.

Два альтернативных примера, отображающие сообщение из нескольких строк на красном фоне в 10 часов утра 27 числа текущего месяца:

% kalarm -c red -t 27-22:00 "Напоминание\nОСТАНОВИТЬСЯ"
% kalarm -c 0xFF0000 -t 27-22:00 "Напоминание\nОСТАНОВИТЬСЯ"