commit 473b0067aa5f1c593a43e795e0cd512e3d3d9a9c
parent 3d7508efc2c9522ebf7a0e735e151aacd3a28542
Author: Andreas Gruhler <andreas.gruhler@adfinis.com>
Date: Sun, 16 Jun 2024 15:24:02 +0200
doc(caldav): use caldav_calendar
Diffstat:
3 files changed, 96 insertions(+), 27 deletions(-)
diff --git a/man1/diary.1 b/man1/diary.1
@@ -294,13 +294,20 @@ fmt_cmd =
#no_mouse = false
# Editor to open journal files with
editor =
-# Google calendar name for CalDAV sync
-#google_calendar =
+# CalDAV server URI
+# For example, Google calendar URI: "https://apidata\&.googleusercontent\&.com/caldav/v2"
+#caldav_server =
+# Calendar name for CalDAV sync
+#caldav_calendar =
# Google OAuth2 clientid and secretid
#google_clientid =
#google_secretid =
# Google OAuth2 tokenfile
#google_tokenfile = ~/\&.diary-token
+# CalDAV server username
+#caldav_username =
+# CalDAV server password
+#caldav_password =
EOF
.fi
.RE
@@ -332,6 +339,8 @@ 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
l lx lx lx lx.
T{
\fBCommand Line Option\fR
@@ -435,20 +444,20 @@ T}
T{
n/a
T} T{
-google_calendar
+caldav_calendar
T} T{
diary
T} T{
(empty)
T} T{
-Displayname of Google Calendar for \fBCALDAV SYNC\fR
+Calendar name for \fBCALDAV SYNC\fR
T}
T{
n/a
T} T{
google_clientid
T} T{
-123.\&com
+
T} T{
built-in at build time (see \fBGOOGLE CALENDAR OAUTH2\fR) or empty
T} T{
@@ -459,7 +468,7 @@ n/a
T} T{
google_secretid
T} T{
-321
+
T} T{
built-in at build time (see \fBGOOGLE CALENDAR OAUTH2\fR) or empty
T} T{
@@ -476,6 +485,28 @@ T} T{
T} T{
\fBGOOGLE CALENDAR OAUTH2\fR API token file location
T}
+T{
+n/a
+T} T{
+caldav_username
+T} T{
+
+T} T{
+(empty)
+T} T{
+CalDAV server username for \fBCALDAV SYNC\fR
+T}
+T{
+n/a
+T} T{
+caldav_password
+T} T{
+
+T} T{
+(empty)
+T} T{
+CalDAV server password for \fBCALDAV SYNC\fR
+T}
.TE
.sp 1
.SH CUSTOM FORMATTING
@@ -522,7 +553,7 @@ takes quite some time for large batches.\&
Currently, only the Google Calendar is supported as remote provider.\&
.PP
The calender for synchronization can be defined with the configuration key
-"google_calendar", see \fBCONFIGURATION FILE\fR.\& This key is empty by default.\&
+"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
@@ -549,11 +580,11 @@ The application requires two OAuth2 scopes
.IP \(bu 4
"https://www.\&googleapis.\&com/auth/calendar": read/share access to Calendars,
required to discover the unique hyperlink/URI for the calendar specified by
-config key "google_calendar"
+config key "caldav_calendar"
.IP \(bu 4
"https://www.\&googleapis.\&com/auth/calendar.\&events": read/write access to
Events owned by the user, allows diary to create/read/update/delete events in
-"google_calendar"
+"caldav_calendar"
.PD
.PP
The user is asked for consent during the first CALDAV SYNC.\&
diff --git a/man1/diary.1.html b/man1/diary.1.html
@@ -236,13 +236,20 @@ fmt_cmd =
#no_mouse = false
# Editor to open journal files with
editor =
-# Google calendar name for CalDAV sync
-#google_calendar =
+# CalDAV server URI
+# For example, Google calendar URI: "https://apidata.googleusercontent.com/caldav/v2"
+#caldav_server =
+# Calendar name for CalDAV sync
+#caldav_calendar =
# Google OAuth2 clientid and secretid
#google_clientid =
#google_secretid =
# Google OAuth2 tokenfile
#google_tokenfile = ~/.diary-token
+# CalDAV server username
+#caldav_username =
+# CalDAV server password
+#caldav_password =
EOF</pre>
</div>
<p class="Pp">To copy the sample file from the source repository:</p>
@@ -348,22 +355,22 @@ EOF</pre>
</tr>
<tr>
<td>n/a</td>
- <td>google_calendar </td>
+ <td>caldav_calendar</td>
<td>diary </td>
<td>(empty)</td>
- <td>Displayname of Google Calendar for <b>CALDAV SYNC</b></td>
+ <td>Calendar name for <b>CALDAV SYNC</b></td>
</tr>
<tr>
<td>n/a</td>
<td>google_clientid</td>
- <td>123.com</td>
+ <td></td>
<td>built-in at build time (see <b>GOOGLE CALENDAR OAUTH2</b>) or empty</td>
<td>Google Calendar for <b>GOOGLE CALENDAR OAUTH2</b> clientid</td>
</tr>
<tr>
<td>n/a</td>
<td>google_secretid</td>
- <td>321</td>
+ <td></td>
<td>built-in at build time (see <b>GOOGLE CALENDAR OAUTH2</b>) or empty</td>
<td>Google Calendar for <b>GOOGLE CALENDAR OAUTH2</b> secretid</td>
</tr>
@@ -374,6 +381,20 @@ EOF</pre>
<td>~/.diary-token</td>
<td><b>GOOGLE CALENDAR OAUTH2</b> API token file location</td>
</tr>
+ <tr>
+ <td>n/a</td>
+ <td>caldav_username</td>
+ <td></td>
+ <td>(empty)</td>
+ <td>CalDAV server username for <b>CALDAV SYNC</b></td>
+ </tr>
+ <tr>
+ <td>n/a</td>
+ <td>caldav_password</td>
+ <td></td>
+ <td>(empty)</td>
+ <td>CalDAV server password for <b>CALDAV SYNC</b></td>
+ </tr>
</table>
<p class="Pp"></p>
</section>
@@ -429,7 +450,7 @@ EOF</pre>
<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 "google_calendar", see <b>CONFIGURATION
+ 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>
@@ -457,10 +478,10 @@ EOF</pre>
<ul class="Bl-bullet">
<li>"https://www.googleapis.com/auth/calendar": read/share access to
Calendars, required to discover the unique hyperlink/URI for the calendar
- specified by config key "google_calendar"</li>
+ specified by config key "caldav_calendar"</li>
<li>"https://www.googleapis.com/auth/calendar.events": read/write
access to Events owned by the user, allows diary to
- create/read/update/delete events in "google_calendar"</li>
+ create/read/update/delete events in "caldav_calendar"</li>
</ul>
<p class="Pp">The user is asked for consent during the first CALDAV SYNC.</p>
</section>
diff --git a/man1/diary.1.scd b/man1/diary.1.scd
@@ -176,13 +176,20 @@ fmt_cmd =
#no_mouse = false
# Editor to open journal files with
editor =
-# Google calendar name for CalDAV sync
-#google_calendar =
+# CalDAV server URI
+# For example, Google calendar URI: "https://apidata.googleusercontent.com/caldav/v2"
+#caldav_server =
+# Calendar name for CalDAV sync
+#caldav_calendar =
# Google OAuth2 clientid and secretid
#google_clientid =
#google_secretid =
# Google OAuth2 tokenfile
#google_tokenfile = ~/.diary-token
+# CalDAV server username
+#caldav_username =
+# CalDAV server password
+#caldav_password =
EOF
```
@@ -265,18 +272,18 @@ The following configuration keys are currently supported:
the first weekday defaults to 1 (Monday), unless specified otherwise with this
option.
| n/a
-: google_calendar
+: caldav_calendar
: diary
: (empty)
-: Displayname of Google Calendar for *CALDAV SYNC*
+: Calendar name for *CALDAV SYNC*
| n/a
: google_clientid
-: 123.com
+:
: built-in at build time (see *GOOGLE CALENDAR OAUTH2*) or empty
: Google Calendar for *GOOGLE CALENDAR OAUTH2* clientid
| n/a
: google_secretid
-: 321
+:
: built-in at build time (see *GOOGLE CALENDAR OAUTH2*) or empty
: Google Calendar for *GOOGLE CALENDAR OAUTH2* secretid
| n/a
@@ -284,6 +291,16 @@ The following configuration keys are currently supported:
: ~/.diary-token
: ~/.diary-token
: *GOOGLE CALENDAR OAUTH2* API token file location
+| n/a
+: caldav_username
+:
+: (empty)
+: CalDAV server username for *CALDAV SYNC*
+| n/a
+: caldav_password
+:
+: (empty)
+: CalDAV server password for *CALDAV SYNC*
# CUSTOM FORMATTING
The preview of the journal entries can be processed with a custom *--fmt-cmd*.
@@ -329,7 +346,7 @@ 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
-"google_calendar", see *CONFIGURATION FILE*. This key is empty by default.
+"caldav_calendar", see *CONFIGURATION FILE*. This key is empty by default.
Read GOOGLE CALENDAR OAUTH2 to setup authorization with the Google server.
@@ -354,10 +371,10 @@ The application requires two OAuth2 scopes
- "https://www.googleapis.com/auth/calendar": read/share access to Calendars,
required to discover the unique hyperlink/URI for the calendar specified by
- config key "google_calendar"
+ config key "caldav_calendar"
- "https://www.googleapis.com/auth/calendar.events": read/write access to
Events owned by the user, allows diary to create/read/update/delete events in
- "google_calendar"
+ "caldav_calendar"
The user is asked for consent during the first CALDAV SYNC.
