docs: fix yearly recurrence format and clarify sort/limitations

- Fix `REM Mon DD` → `REM MMM DD` in yearly recurrence table
- Clarify `--sort original` preserves processing order in CLI reference
- Update `RELATED=END` trigger behaviour (treated as `RELATED=START`)
- Remove unsupported EXDATE/RDATE+override limitation (now handled)
- Fix `--sort none` → `--sort original` in CLI help text
- Remove EXDATE/RDATE/override guard from `simple_recurrence`
This commit is contained in:
2026-05-24 18:15:38 +02:00
parent 828800d47e
commit 4f03bfa0fa
3 changed files with 28 additions and 34 deletions

View File

@@ -14,7 +14,7 @@ Full RFC 5545 coverage is intentionally out of scope — see [Limitations](#limi
| All-day single | `REM YYYY-MM-DD MSG …` |
| All-day multi-day | `REM date THROUGH date MSG …` |
| Timed event (UTC, local, TZID) | `REM date AT HH:MM DURATION HH:MM MSG …` |
| Yearly recurrence (`FREQ=YEARLY`) | `REM Mon DD MSG …` |
| Yearly recurrence (`FREQ=YEARLY`) | `REM MMM DD MSG …` |
| Weekly recurrence (`FREQ=WEEKLY`) | `REM Mon Wed FROM … UNTIL … MSG …` |
| Daily recurrence (`FREQ=DAILY`) | `REM date *N UNTIL … MSG …` |
| Monthly by day-of-month (`BYMONTHDAY`) | `REM N FROM … UNTIL … MSG …` |
@@ -115,7 +115,7 @@ ical2rem --verbose personal.ics > personal.rem
|---|---|
| `FILE…` | One or more `.ics` files to convert |
| `-z`, `--timezone TZ` | Target timezone for output (default: local) |
| `--sort asc\|desc\|original` | Sort order by date (default: `desc`) |
| `--sort asc\|desc\|original` | Sort order by date (default: `desc`); `original` preserves processing order (sorted by UID within each file, last file first) |
| `--source NAME` | Override calendar name (single file only) |
| `-v`, `--verbose` | Print diagnostic messages on stderr |
| `--no-uuid` | Omit `INFO "UID: …"` lines |
@@ -184,14 +184,13 @@ REM \
- `BYSETPOS`: **not supported**.
- `FREQ=YEARLY` with `BYMONTH`/`BYDAY` variants: **not supported**, only simple yearly (same day every year).
- `RDATE` (additional isolated dates): **not supported**, warning emitted.
- Recurring events that have both EXDATE/RDATE and override occurrences (`RECURRENCE-ID`): **not supported**, event skipped with warning.
### Alarms (`VALARM`)
- `ACTION:EMAIL`: ignored silently.
- `TRIGGER;VALUE=DATE-TIME` (absolute datetime trigger): ignored silently.
- Positive triggers (after the event): ignored silently.
- `RELATED=END` triggers: **not implemented**.
- `RELATED=END` triggers: the offset is applied as if it were `RELATED=START` (no warning emitted).
- `REPEAT`/`DURATION` (repeating alarms) on all-day events: ignored.
### Other