diff options
| author | Teddy Wing | 2021-05-23 18:44:03 +0200 |
|---|---|---|
| committer | Teddy Wing | 2021-05-23 18:44:03 +0200 |
| commit | 4e6a183f92f88564ee73de31ee333044e6c27b48 (patch) | |
| tree | 3b5b15d82dd8b989a7b900337de69b62378e0e1f | |
| parent | 672cbd0f8329416fdc7f989f38eeb38a3ed55c3d (diff) | |
| download | google-calendar-rsvp-4e6a183f92f88564ee73de31ee333044e6c27b48.tar.bz2 | |
doc/google-calendar-rsvp.1.txt: Add Files section
Describe the files used for authentication.
Change the file paths to use `$XDG_DATA_HOME` instead of writing the
path explicitly, as that environment variable may have been changed to
refer to a different directory.
| -rw-r--r-- | doc/google-calendar-rsvp.1 | 16 | ||||
| -rw-r--r-- | doc/google-calendar-rsvp.1.txt | 14 |
2 files changed, 20 insertions, 10 deletions
diff --git a/doc/google-calendar-rsvp.1 b/doc/google-calendar-rsvp.1 index 0155b70..8b7369a 100644 --- a/doc/google-calendar-rsvp.1 +++ b/doc/google-calendar-rsvp.1 @@ -75,7 +75,7 @@ The OAuth client ID should be downloaded as a JSON file to: .RS 4 .\} .nf -$HOME/\&.local/share/google\-calendar\-rsvp/oauth\-secret\&.json +$XDG_DATA_HOME/google\-calendar\-rsvp/oauth\-secret\&.json .fi .if n \{\ .RE @@ -119,7 +119,13 @@ Print usage help\&. Print the program version\&. .RE .SH "FILES" -.sp -TODO -.sp -$HOME/\&.local/share/google\-calendar\-rsvp/token\&.json $HOME/\&.local/share/google\-calendar\-rsvp/oauth\-secret\&.json +.PP +$XDG_DATA_HOME/google\-calendar\-rsvp/oauth\-secret\&.json +.RS 4 +Google OAuth 2 client secret file\&. This file can be downloded from the Google Developer console\&. You must create this file manually before being able to use the program\&. +.RE +.PP +$XDG_DATA_HOME/google\-calendar\-rsvp/token\&.json +.RS 4 +The Google authentication refresh token, created automatically by the program\&. +.RE diff --git a/doc/google-calendar-rsvp.1.txt b/doc/google-calendar-rsvp.1.txt index 117207c..f15ed11 100644 --- a/doc/google-calendar-rsvp.1.txt +++ b/doc/google-calendar-rsvp.1.txt @@ -42,7 +42,7 @@ client ID. The Google project must enable the Google Calendar API. The OAuth client ID should be downloaded as a JSON file to: - $HOME/.local/share/google-calendar-rsvp/oauth-secret.json + $XDG_DATA_HOME/google-calendar-rsvp/oauth-secret.json On the first run of the program, you will be asked to visit a Google URL to create a token and authorise scopes for the Google Calendar API. At this @@ -76,7 +76,11 @@ OPTIONS FILES ----- -TODO - -$HOME/.local/share/google-calendar-rsvp/token.json -$HOME/.local/share/google-calendar-rsvp/oauth-secret.json +$XDG_DATA_HOME/google-calendar-rsvp/oauth-secret.json:: + Google OAuth 2 client secret file. This file can be downloded from the + Google Developer console. You must create this file manually before being + able to use the program. + +$XDG_DATA_HOME/google-calendar-rsvp/token.json:: + The Google authentication refresh token, created automatically by the + program. |