aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2021-05-23 01:11:28 +0200
committerTeddy Wing2021-05-23 01:11:28 +0200
commit090e330fc133743e144ffe5ebc70bd25e7bd6e39 (patch)
tree5e1bd9ed2d12cccc674f225a051f811b79baa297
parent3732063b7f4cc8796f2ad26a929560d08fd418ed (diff)
downloadgoogle-calendar-rsvp-090e330fc133743e144ffe5ebc70bd25e7bd6e39.tar.bz2
Start writing man page
-rw-r--r--Makefile8
-rw-r--r--doc/google-calendar-rsvp.1122
-rw-r--r--doc/google-calendar-rsvp.1.txt51
3 files changed, 181 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..57b6a07
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,8 @@
+MAN_PAGE := doc/google-calendar-rsvp.1
+
+
+.PHONY: doc
+doc: $(MAN_PAGE)
+
+$(MAN_PAGE): $(MAN_PAGE).txt
+ a2x --no-xmllint --format manpage $<
diff --git a/doc/google-calendar-rsvp.1 b/doc/google-calendar-rsvp.1
new file mode 100644
index 0000000..d4f7b41
--- /dev/null
+++ b/doc/google-calendar-rsvp.1
@@ -0,0 +1,122 @@
+'\" t
+.\" Title: google-calendar-rsvp
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 05/23/2021
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "GOOGLE\-CALENDAR\-RS" "1" "05/23/2021" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+google-calendar-rsvp \- RSVP to a Google Calendar event
+.SH "SYNOPSIS"
+.sp
+\fIgoogle\-calendar\-rsvp\fR [options] [\-y | \-n | \-m] [\-\-email] [event_ids\&...]
+.SH "DESCRIPTION"
+.sp
+TODO
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+eid vs event ID
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+RSVP command line options
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Email option
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Authentication
+.RE
+.SH "OPTIONS"
+.PP
+\-y, \-\-yes
+.RS 4
+rsvp with "yes"
+.RE
+.PP
+\-n, \-\-no
+.RS 4
+rsvp with "no"
+.RE
+.PP
+\-m, \-\-maybe
+.RS 4
+rsvp with "maybe"
+.RE
+.PP
+\-\-email
+.RS 4
+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\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Enable verbose output\&.
+.RE
+.PP
+\-h, \-\-help
+.RS 4
+Print usage help\&.
+.RE
+.PP
+\-V, \-\-version
+.RS 4
+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
diff --git a/doc/google-calendar-rsvp.1.txt b/doc/google-calendar-rsvp.1.txt
new file mode 100644
index 0000000..ab1ce25
--- /dev/null
+++ b/doc/google-calendar-rsvp.1.txt
@@ -0,0 +1,51 @@
+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
+-----------
+TODO
+
+* eid vs event ID
+* RSVP command line options
+* Email option
+* Authentication
+
+OPTIONS
+-------
+-y, --yes::
+ rsvp with "yes"
+
+-n, --no::
+ rsvp with "no"
+
+-m, --maybe::
+ rsvp with "maybe"
+
+--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