aboutsummaryrefslogtreecommitdiffstats
path: root/doc/google-calendar-rsvp.1.txt
blob: 117207c8e080e3568ac72dfdd8e386aba2a44440 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
google-calendar-rsvp(1)
=======================

NAME
----
google-calendar-rsvp - RSVP to a Google Calendar event

SYNOPSIS
--------
'google-calendar-rsvp' [options] [-y | -n | -m] [--email] [event_ids...]

DESCRIPTION
-----------
RSVP to a Google Calendar event. Events are specified by their ID or by their
EID.

An event ID looks like:

	1g4j1h67ndq7kddrb2bptp2cua

EIDs are more common, found in invitation emails and event URLs:

	MWc0ajFoNjduZHE3a2RkcmIyYnB0cDJjdWEgcm9yeS5tZXJjdXJ5QGV4YW1wbGUuY28K

An EID is a base64-encoded pair of values consisting of the event ID and most
or all of the organiser's email address.

Both event IDs and EIDs can be passed as command line arguments to RSVP to
those events. EIDs can also be read from an email given on standard input if
the '--email' flag is present. This allows an invitation email to be sent
directly to the program to avoid having to extract the EID separately.

To RSVP to an event, use the '--yes', '--no', or '--maybe' flags. The flag
applies to all events passed to the program. If more than one RSVP flag is
present, the rightmost one is used.

AUTHENTICATION
--------------
Authentication is required to make requests to the Google Calendar API. Before
the program can be used, users must create a Google project, and an OAuth 2
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

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
point, the program will have the required authentication and authorisation
prerequisites to operate.

OPTIONS
-------
-y, --yes::
	Accept the event invitation.

-n, --no::
	Decline the event invitation.

-m, --maybe::
	Tentatively accept the event invitation.

--email::
	Read a Google Calendar invitation email from standard input and extract
	the event ID from the email instead of having to provide it as a command
	line argument.

-v, --verbose::
	Enable verbose output.

-h, --help::
	Print usage help.

-V, --version::
	Print the program version.

FILES
-----
TODO

$HOME/.local/share/google-calendar-rsvp/token.json
$HOME/.local/share/google-calendar-rsvp/oauth-secret.json