.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH GCALCLI "1" "September 2016" "gcalcli v3.4.0 (Eric Davis, Brian Hartvigsen)" "User Commands"
.SH NAME
gcalcli \- Google Calendar Command Line Interface
.SH SYNOPSIS
gcalcli [options] command [command args or options]
.SH DESCRIPTION
gcalcli is a Python application that allows you to access your Google
Calendar from a command line. It's easy to get your agenda, search for
events, and quickly add new events. Additionally gcalcli can be used
as a reminder service to execute any application you want.
.PP
.IP
.SH COMMANDS
.TP
list
list all calendars
.TP
search <text> [start] [end]
search for events within an optional time period
\- case insensitive search terms to find events that
.TP
match these terms in any field, like traditional
Google search with quotes, exclusion, etc.
.TP
\- for example to get just games: "soccer \fB\-practice\fR"
\- [start] and [end] use the same formats as agenda
.TP
agenda [start] [end]
get an agenda for a time period
\- start time default is 12am today
\- end time default is 5 days from start
\- example time strings:
.TP
\&'9/24/2007'
\&'24/09/2007'
\&'24/9/07'
\&'Sep 24 2007 3:30pm'
\&'2007\-09\-24T15:30'
\&'2007\-09\-24T15:30\-8:00'
\&'20070924T15'
\&'8am'
.TP
calw <weeks> [start]
get a week based agenda in a nice calendar format
\- weeks is the number of weeks to display
\- start time default is beginning of this week
\- note that all events for the week(s) are displayed
.TP
calm [start]
get a month agenda in a nice calendar format
\- start time default is the beginning of this month
\- note that all events for the month are displayed
.IP
and only one month will be displayed
.TP
quick <text>
quick add an event to a calendar
\- a single \fB\-\-calendar\fR must specified
\- the "\-\-details url" option will show the event link
\- example text:
.TP
\&'Dinner with Eric 7pm tomorrow'
\&'5pm 10/31 Trick or Treat'
.TP
add
add a detailed event to a calendar
\- a single \fB\-\-calendar\fR must specified
\- the "\-\-details url" option will show the event link
\- example:
.TP
gcalcli \fB\-\-calendar\fR 'Eric Davis'
\fB\-\-title\fR 'Analysis of Algorithms Final'
\fB\-\-where\fR UCI
\fB\-\-when\fR '12/14/2012 10:00'
\fB\-\-who\fR 'foo@bar.com'
\fB\-\-who\fR 'baz@bar.com'
\fB\-\-duration\fR 60
\fB\-\-description\fR 'It is going to be hard!'
\fB\-\-reminder\fR 30
add
.TP
delete <text> [start] [end]
delete event(s) within the optional time period
\- case insensitive search terms to find and delete
.TP
events, just like the 'search' command
\- deleting is interactive
.TP
use the \fB\-\-iamaexpert\fR option to auto delete
THINK YOU'RE AN EXPERT? USE AT YOUR OWN RISK!!!
.TP
\- use the \fB\-\-details\fR options to show event details
\- [start] and [end] use the same formats as agenda
.TP
edit <text>
edit event(s)
\- case insensitive search terms to find and edit
.TP
events, just like the 'search' command
\- editing is interactive
.TP
import [file]
import an ics/vcal file to a calendar
\- a single \fB\-\-calendar\fR must specified
\- if a file is not specified then the data is read
.TP
from standard input
\- if \fB\-v\fR is given then each event in the file is
.TP
displayed and you're given the option to import
or skip it, by default everything is imported
quietly without any interaction
.TP
\- if \fB\-d\fR is given then each event in the file is
displayed and is not imported, a \fB\-\-calendar\fR does
not need to be specified for this option
.TP
remind <mins> <command>
execute command if event occurs within <mins>
minutes time ('%s' in <command> is replaced with
event start time and title text)
\- <mins> default is 10
\- default command:
.IP
\&'notify\-send \fB\-u\fR critical \fB\-a\fR gcalcli %s'
.SS "\&OPTIONS"
.HP
\fB\-\-[no]allday\fR: If \fB\-\-allday\fR is given, the event will be an all\-day event
.IP
(possibly multi\-day if \fB\-\-duration\fR is greater than 1). The time part of the
\fB\-\-when\fR will be ignored.
(default: 'false')
.HP
\fB\-\-[no]cache\fR: Execute command without using cache
.IP
(default: 'true')
.HP
\fB\-\-calendar\fR: Which calendars to use;
.IP
repeat this option to specify a list of values
(default: '[]')
.HP
\fB\-\-client_id\fR: API client_id
.IP
(default: '232867676714.apps.googleusercontent.com')
.HP
\fB\-\-client_secret\fR: API client_secret
.IP
(default: '3tZSxItw6_VnZMezQwC8lUqy')
.HP
\fB\-\-[no]color\fR: Enable/Disable all color output
.IP
(default: 'true')
.HP
\fB\-\-color_border\fR: Color of line borders
.IP
(default: 'white')
.HP
\fB\-\-color_date\fR: Color for the date
.IP
(default: 'yellow')
.HP
\fB\-\-color_freebusy\fR: Color for free/busy calendars
.IP
(default: 'default')
.HP
\fB\-\-color_now_marker\fR: Color for the now marker
.IP
(default: 'brightred')
.HP
\fB\-\-color_owner\fR: Color for owned calendars
.IP
(default: 'cyan')
.HP
\fB\-\-color_reader\fR: Color for read\-only calendars
.IP
(default: 'magenta')
.HP
\fB\-\-color_writer\fR: Color for writable calendars
.IP
(default: 'green')
.HP
\fB\-\-configFolder\fR: Optional directory to load/store all configuration information
.HP
\fB\-\-[no]conky\fR: Use Conky color codes
.IP
(default: 'false')
.HP
\fB\-\-[no]declined\fR: Show events that have been declined
.IP
(default: 'true')
.HP
\fB\-\-defaultCalendar\fR: Optional default calendar to use if no \fB\-\-calendar\fR options
.IP
are given;
repeat this option to specify a list of values
(default: '[]')
.HP
\fB\-\-[no]default_reminders\fR: If no \fB\-\-reminder\fR is given, use the defaults. If this
.IP
is false, do not create any reminders.
(default: 'true')
.HP
\fB\-\-description\fR: Event description
.HP
\fB\-\-[no]detail_all\fR: Display all details
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_attachments\fR: Display event attachments
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_attendees\fR: Display event attendees
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_calendar\fR: Display calendar name
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_description\fR: Display description
.IP
(default: 'false')
.HP
\fB\-\-detail_description_width\fR: Set description width
.IP
(default: '80')
(an integer)
.HP
\fB\-\-[no]detail_email\fR: Display creator email
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_length\fR: Display length of event
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_location\fR: Display event location
.IP
(default: 'false')
.HP
\fB\-\-[no]detail_reminders\fR: Display reminders
.IP
(default: 'false')
.HP
\fB\-\-detail_url\fR: <long|short>: Set URL output
.HP
\fB\-\-details\fR: Which parts to display, can be: 'all', 'calendar', 'location',
.IP
\&'length', 'reminders', 'description', 'longurl', 'shorturl', 'url',
\&'attendees', 'email';
repeat this option to specify a list of values
(default: '[]')
.HP
\fB\-d\fR,\-\-[no]dump: Print events and don't import
.IP
(default: 'false')
.HP
\fB\-\-duration\fR: Event duration in minutes or days if \fB\-\-allday\fR is given.
.IP
(an integer)
.HP
\fB\-\-flagfile\fR: Insert flag definitions from the given file into the command line.
.IP
(default: '')
.HP
\fB\-\-[no]help\fR: Show this help
.HP
\fB\-\-[no]helpshort\fR: Show command help only
.HP
\fB\-\-[no]helpxml\fR: like \fB\-\-help\fR, but generates XML output
.HP
\fB\-\-[no]iamaexpert\fR: Probably not
.IP
(default: 'false')
.HP
\fB\-\-[no]includeRc\fR: Whether to include ~/.gcalclirc when using configFolder
.IP
(default: 'false')
.HP
\fB\-\-[no]lineart\fR: Enable/Disable line art
.IP
(default: 'true')
.HP
\fB\-\-locale\fR: System locale
.HP
\fB\-\-[no]military\fR: Use 24 hour display
.IP
(default: 'false')
.HP
\fB\-\-[no]monday\fR: Start the week on Monday
.IP
(default: 'false')
.HP
\fB\-\-[no]prompt\fR: Prompt for missing data when adding events
.IP
(default: 'true')
.HP
\fB\-\-[no]refresh\fR: Delete and refresh cached data
.IP
(default: 'false')
.HP
\fB\-\-reminder\fR: Reminders in the form 'TIME METH' or 'TIME'. TIME is a number
.IP
which may be followed by an optional 'w', 'd', 'h', or 'm' (meaning weeks,
days, hours, minutes) and default to minutes. METH is a string 'popup',
\&'email', or 'sms' and defaults to popup.;
repeat this option to specify a list of values
(default: '[]')
.HP
\fB\-\-[no]started\fR: Show events that have started
.IP
(default: 'true')
.HP
\fB\-\-title\fR: Event title
.HP
\fB\-\-[no]tsv\fR: Use Tab Separated Value output
.IP
(default: 'false')
.HP
\fB\-\-undefok\fR: comma\-separated list of flag names that it is okay to specify on
.IP
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the \fB\-\-flag\fR=\fI\,value\/\fR
format.
(default: '')
.HP
\fB\-\-[no]use_reminders\fR: Honour the remind time when running remind command
.IP
(default: 'false')
.HP
\fB\-v\fR,\-\-[no]verbose: Be verbose on imports
.IP
(default: 'false')
.HP
\fB\-\-[no]version\fR: Show the version and exit
.IP
(default: 'false')
.HP
\fB\-\-when\fR: Event time
.HP
\fB\-\-where\fR: Event location
.HP
\fB\-\-who\fR: Event attendees;
.IP
repeat this option to specify a list of values
(default: '[]')
.HP
\fB\-w\fR,\-\-width: Set output width
.IP
(default: '10')
(an integer)