.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH GCALCLI "1" "November 2007" "gcalcli v1.4" "User Commands"
.SH NAME
gcalcli \- Google Calendar Command Line Interface
.SH SYNOPSIS
gcalcli [options] command [command args]
.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.
.SH OPTIONS
.TP
\fB\-\-help\fR
this usage text
.TP
\fB\-\-config\fR <file>
config file to read (default is '~/.gcalclirc')
.TP
\fB\-\-user\fR <username>
google username
.TP
\fB\-\-pw\fR <password>
password
.TP
\fB\-\-cals\fR [all,
\&'calendars' to work with (default is all calendars)
.TP
default,
\- default (your default main calendar)
.TP
owner,
\- owner (your owned calendars)
.TP
editor,
\- editor (editable calendar)
.TP
contributor,
\- contributor (non\-owner but able to edit)
.TP
read,
\- read (read only calendars)
.TP
freebusy]
\- freebusy (only free/busy info visible)
.TP
\fB\-\-cal\fR <name>
\&'calendar' to work with (default is all calendars)
\- you can specify a calendar by name or by using a
.IP
regular expression to match multiple calendars
.IP
\- you can use multiple '\-\-cal' arguments on the
.IP
command line
.TP
\fB\-\-details\fR
show all event details (i.e. length, location,
reminders, contents)
.TP
\fB\-\-ignore\-started\fR
ignore old or already started events
\- when used with the 'agenda' command, ignore events
.IP
that have already started and are in\-progress with
respect to the specified [start] time
.IP
\- when used with the 'search' command, ignore events
.IP
that have already occurred and only show future
events
.TP
\fB\-\-width\fR
the number of characters to use for each column in
the 'cal' command output (default is 10)
.TP
\fB\-\-nc\fR
don't use colors
.TP
\fB\-\-cal\-owner\-color\fR
specify the colors used for the calendars and dates
.TP
\fB\-\-cal\-editor\-color\fR
each of these argument requires a <color> argument
.TP
\fB\-\-cal\-contributor\-color\fR
which must be one of [ default, black, brightblack,
.TP
\fB\-\-cal\-read\-color\fR
red, brightred, green, brightgreen, yellow,
.TP
\fB\-\-cal\-freebusy\-color\fR
brightyellow, blue, brightblue, magenta,
.TP
\fB\-\-date\-color\fR
brightmagenta, cyan, brightcyan, white,
.TP
\fB\-\-border\-color\fR
brightwhite ]
.IP
.SH COMMANDS
.TP
list
list all calendars
.TP
search <text>
search for events
\- only matches whole words
.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:
.IP
\&'9/24/2007'
\&'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 your default calendar
\- example:
.IP
\&'Dinner with Eric 7pm tomorrow'
\&'5pm 10/31 Trick or Treat'
.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
\&'gxmessage \fB\-display\fR :0 \fB\-center\fR \e
.IP
\fB\-title\fR "Ding, Ding, Ding!" %s'
.SH "SEE ALSO"
.UR http://code.google.com/p/gcalcli/w/list
Wiki page
.UE

.SH FILES
.TP
.I ~/.gcalclirc
If exists is consulted at startup for defaults.
Formatted with a section header "gcalcli" followed by lines
\fBoption: value\fR.  (See section OPTIONS above for list of valid
options.)  E.g.,

.nf
[gcalcli]
user: bertie_ahern
pw: topsecret
cal: Irish Holidays

.fi
.SH AUTHOR
Brandon Philips, Yaroslav Halchenko, Barak A. Pearlmutter

.SH COPYRIGHT
Copyright \(co 2007 Brandon Philips <brandon@ifup.org>

Copyright \(co 2009 Yaroslav Halchenko <debian@onerussian.com>