From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 13A6ABE92 for ; Mon, 2 May 2022 12:23:23 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 09E4A26417 for ; Mon, 2 May 2022 12:23:23 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 7368A2640E for ; Mon, 2 May 2022 12:23:22 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 4256741BEF for ; Mon, 2 May 2022 12:23:22 +0200 (CEST) From: Dominik Csapak To: pve-devel@lists.proxmox.com Date: Mon, 2 May 2022 12:23:21 +0200 Message-Id: <20220502102321.1898477-1-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.278 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_ASCII_DIVIDERS 0.8 Spam that uses ascii formatting tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH docs] calendar-events: update format and add more examples X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 02 May 2022 10:23:23 -0000 to indicate date support. also add the special values we support Signed-off-by: Dominik Csapak --- calendar-events.adoc | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/calendar-events.adoc b/calendar-events.adoc index 24a1dc6..2cfc115 100644 --- a/calendar-events.adoc +++ b/calendar-events.adoc @@ -10,7 +10,7 @@ single expression. Such a calendar event uses the following format: ---- -[day(s)] [[start-time(s)][/repetition-time(s)]] +[WEEKDAY] [[YEARS-]MONTHS-DAYS] [HOURS:MINUTES[:SECONDS]] ---- This format allows you to configure a set of days on which the job should run. @@ -39,7 +39,7 @@ xref:pvesr_schedule_format_examples[more Examples below]. Detailed Specification ---------------------- -days:: Days are specified with an abbreviated English version: `sun, mon, +weekdays:: Days are specified with an abbreviated English version: `sun, mon, tue, wed, thu, fri and sat`. You may use multiple days as a comma-separated list. A range of days can also be set by specifying the start and end day separated by ``..'', for example `mon..fri`. These formats can be mixed. @@ -56,6 +56,22 @@ The valid range for values is `0-23` for hours and `0-59` for minutes. Examples: ~~~~~~~~~ +There are some special values that have a specific meaning: + +.Special Values +[width="100%",options="header"] +|================================================================ +|Value |Syntax +|`minutely` |`*-*-* *:*:00` +|`hourly` |`*-*-* *:00:00` +|`daily` |`*-*-* 00:00:00` +|`weekly` |`mon *-*-* 00:00:00` +|`monthly` |`*-*-01 00:00:00` +|`yearly` or `annually` | `*-01-01 00:00:00` +|`quarterly` |`*-01,04,07,10-01 00:00:00` +|`semiannually` or `semi-annually` |`*-01,07-01 00:00:00` +|================================================================ + .Schedule Examples [width="100%",options="header"] |============================================================================== @@ -70,4 +86,7 @@ Examples: |fri 12..13:5/20 |fri 12,13:5/20 |Friday at 12:05, 12:25, 12:45, 13:05, 13:25 and 13:45 |12,14,16,18,20,22:5 |12/2:5 |Every day starting at 12:05 until 22:05, every 2 hours |* |*/1 |Every minute (minimum interval) +|*-05 |-- |On the 5th day of every Month +|Sat *-1..7 15:00 |-- |First Saturday each Month at 15:00 +|2015-10-21 |-- |21st October 2015 at 00:00 |============================================================================== -- 2.30.2