commit 2338a22b274c44264b5c2472d60778f716e76b44
parent 50d584e3a022a017c8437b164a22ab09b3f827e7
Author: Andreas Gruhler <andreas.gruhler@adfinis.com>
Date: Sat, 22 Jun 2024 21:46:10 +0200
doc: update caldav_server docs
Diffstat:
4 files changed, 41 insertions(+), 21 deletions(-)
diff --git a/config/diary.cfg b/config/diary.cfg
@@ -15,7 +15,6 @@ fmt_cmd =
# Editor to open journal files with
editor =
# CalDAV server URI
-# For example, Google calendar URI: "https://apidata.googleusercontent.com/caldav/v2"
#caldav_server =
# Calendar name for CalDAV sync
#caldav_calendar =
diff --git a/man1/diary.1 b/man1/diary.1
@@ -295,7 +295,6 @@ fmt_cmd =
# Editor to open journal files with
editor =
# CalDAV server URI
-# For example, Google calendar URI: "https://apidata\&.googleusercontent\&.com/caldav/v2"
#caldav_server =
# Calendar name for CalDAV sync
#caldav_calendar =
@@ -341,6 +340,7 @@ l lx lx lx lx
l lx lx lx lx
l lx lx lx lx
l lx lx lx lx
+l lx lx lx lx
l lx lx lx lx.
T{
\fBCommand Line Option\fR
@@ -444,6 +444,17 @@ T}
T{
n/a
T} T{
+caldav_server
+T} T{
+Google calendar "https://apidata.\&googleusercontent.\&com/caldav/v2", Yahoo calendar "https://caldav.\&calendar.\&yahoo.\&com", GMX "https://caldav.\&gmx.\&net" or other CalDAV compatible provider
+T} T{
+(empty)
+T} T{
+CalDAV server for \fBCALDAV SYNC\fR
+T}
+T{
+n/a
+T} T{
caldav_calendar
T} T{
diary
@@ -550,17 +561,15 @@ The diary creates a full-day calendar entry.\& It'\&s advised to use a separate
calendar for syncing purposes and not to have multiple events for a day on the
remote calendar.\& The diary only considers the first event of a given day.\&
.PP
-Use the EXPORT/IMPORT functionality for more batch oriented processing.\& Making
-a network request and deciding the most recently modified entry (local/remote)
-takes quite some time for large batches.\&
-.PP
-Currently, only the Google Calendar is supported as remote provider.\&
-.PP
The calender for synchronization can be defined with the configuration key
"caldav_calendar", see \fBCONFIGURATION FILE\fR.\& This key is empty by default.\&
.PP
Read GOOGLE CALENDAR OAUTH2 to setup authorization with the Google server.\&
.PP
+Use the EXPORT/IMPORT functionality for more batch oriented processing.\& Making
+a network request and deciding the most recently modified entry (local/remote)
+takes quite some time for large batches.\&
+.PP
.SH GOOGLE CALENDAR OAUTH2
To synchronize with the Google calendar, it is required to setup a project in
the cloud console and enable the CalDAV API (not the Google Calendar API):
diff --git a/man1/diary.1.html b/man1/diary.1.html
@@ -237,7 +237,6 @@ fmt_cmd =
# Editor to open journal files with
editor =
# CalDAV server URI
-# For example, Google calendar URI: "https://apidata.googleusercontent.com/caldav/v2"
#caldav_server =
# Calendar name for CalDAV sync
#caldav_calendar =
@@ -355,6 +354,17 @@ EOF</pre>
</tr>
<tr>
<td>n/a</td>
+ <td>caldav_server</td>
+ <td>Google calendar
+ "https://apidata.googleusercontent.com/caldav/v2", Yahoo
+ calendar "https://caldav.calendar.yahoo.com", GMX
+ "https://caldav.gmx.net" or other CalDAV compatible
+ provider</td>
+ <td>(empty)</td>
+ <td>CalDAV server for <b>CALDAV SYNC</b></td>
+ </tr>
+ <tr>
+ <td>n/a</td>
<td>caldav_calendar</td>
<td>diary </td>
<td>(empty)</td>
@@ -448,16 +458,14 @@ EOF</pre>
separate calendar for syncing purposes and not to have multiple events for a
day on the remote calendar. The diary only considers the first event of a
given day.</p>
-<p class="Pp">Use the EXPORT/IMPORT functionality for more batch oriented
- processing. Making a network request and deciding the most recently modified
- entry (local/remote) takes quite some time for large batches.</p>
-<p class="Pp">Currently, only the Google Calendar is supported as remote
- provider.</p>
<p class="Pp">The calender for synchronization can be defined with the
configuration key "caldav_calendar", see <b>CONFIGURATION
FILE</b>. This key is empty by default.</p>
<p class="Pp">Read GOOGLE CALENDAR OAUTH2 to setup authorization with the Google
server.</p>
+<p class="Pp">Use the EXPORT/IMPORT functionality for more batch oriented
+ processing. Making a network request and deciding the most recently modified
+ entry (local/remote) takes quite some time for large batches.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="GOOGLE_CALENDAR_OAUTH2"><a class="permalink" href="#GOOGLE_CALENDAR_OAUTH2">GOOGLE
diff --git a/man1/diary.1.scd b/man1/diary.1.scd
@@ -177,7 +177,6 @@ fmt_cmd =
# Editor to open journal files with
editor =
# CalDAV server URI
-# For example, Google calendar URI: "https://apidata.googleusercontent.com/caldav/v2"
#caldav_server =
# Calendar name for CalDAV sync
#caldav_calendar =
@@ -272,6 +271,13 @@ The following configuration keys are currently supported:
the first weekday defaults to 1 (Monday), unless specified otherwise with this
option.
| n/a
+: caldav_server
+: Google calendar "https://apidata.googleusercontent.com/caldav/v2", Yahoo
+ calendar "https://caldav.calendar.yahoo.com", GMX "https://caldav.gmx.net" or
+ other CalDAV compatible provider
+: (empty)
+: CalDAV server for *CALDAV SYNC*
+| n/a
: caldav_calendar
: diary
: (empty)
@@ -343,17 +349,15 @@ The diary creates a full-day calendar entry. It's advised to use a separate
calendar for syncing purposes and not to have multiple events for a day on the
remote calendar. The diary only considers the first event of a given day.
-Use the EXPORT/IMPORT functionality for more batch oriented processing. Making
-a network request and deciding the most recently modified entry (local/remote)
-takes quite some time for large batches.
-
-Currently, only the Google Calendar is supported as remote provider.
-
The calender for synchronization can be defined with the configuration key
"caldav_calendar", see *CONFIGURATION FILE*. This key is empty by default.
Read GOOGLE CALENDAR OAUTH2 to setup authorization with the Google server.
+Use the EXPORT/IMPORT functionality for more batch oriented processing. Making
+a network request and deciding the most recently modified entry (local/remote)
+takes quite some time for large batches.
+
# GOOGLE CALENDAR OAUTH2
To synchronize with the Google calendar, it is required to setup a project in
the cloud console and enable the CalDAV API (not the Google Calendar API):