NAME

td —

TDcal calendar program

SYNOPSIS

`td`	[`-CdeflSuvVx`] [`-a` `sdt edt desc`] [`-c` `calendar`] [`-F` `fmt`] [`-i` `file`] [`-I` `encoding`] [`-L` `dt`] [`-n` `N`] [`-r` `repetition`] [`-s` `pattern`] [`-t` `timezone`] [`[cal/]id ...`]

DESCRIPTION

td is the command-line client of the TDcal(7) calendar system.

td allows calendars to be viewed, have events added, edited and deleted and can import and export events from and to iCalendar files.

The default operation of td is to display forthcoming calendar events for the next two weeks.

The following options modify the behavior as follows:

-a sdt edt desc

Adds a new event with start date sdt, end date edt and description desc to calendar calendar which must be specified in the -c option. If the -S option is given and the calendar type permits, the event is immediately synchronized to its calendar server.

-c calendar

Restricts operation to just the calendars specified by the calendar argument. calendar may contain shell wildcards (which must be escaped from the shell) which are expanded to match calendar names. If a calendar collection is given, it is expanded to all the calendars within that colection.

-C

Displays a list of known calendars to stdout. Calendars configured in the configuration file are listed un-indented. Calendars discovered from synchronization servers are listed indented beneath their configured collection.

-d

Deletes calendar events specified by id arguments.

-e

Exports one or more calendar events specified by any id arguments in iCalendar format. If no calendars are specified, all calendars are exported. If no id arguments are specified, all events are exported. The calendar is displayed on stdout.

-f

When displaying forthcoming events using -l or -L or when searching using -s, show the calendar name and the event's id instead of the start and end date/time. Similar to -F "%c/%i %t".

-F fmt

When displaying forthcoming events using -l or -L or when searching using -s, format the output according to the fmt specification. fmt is any string with the following substitutions:

%s: formatted start date/time
%f: formatted finish date/time
%S: yyyymnddhhmmss start date/time
%F: yyyymnddhhmmss finish date/time
%c: calendar name
%i: event ID
%t: summary text
%l: location
%r: rrule
%R: rdate
%e: exrule
%E: exdate

The sequences ‘\t’ and ‘\n’ may also be included to represent TAB and NL characters.

-i file

Imports events from iCalendar file file to calendar calendar which must be specified in the -c option.

-I encoding

Sets the character set encoding for the import file. All encodings supported by the system (such as utf-8, iso8859-1, eucJP, GB2312, KOI8-R, etc) are supported. If not provided, the encoding given in the LC_CTYPE environment variable is used and, if that's not set, utf-8 is the default.

-l

Display a list of forthcoming events to stdout together with their start and end date/times. If no other options are used, this is the default.

-L dt

Set start date/time for event displays and searches to dt.

-n N

Set period for event displays and searches to N days (default is the ‘lperiod’ value configured in td(5), or 14 days if no ‘lperiod’ is configured.

-r repetition

When adding a new calendar event, specify repetition frequency. The format of repetition is rrule, rrule/exdate, or rrule/rdate/exdate. See TDcal(7) for full details of these.

-s pattern

Searches for events matching the Perl regular expression pattern. The -L and -n flags may be used to restrict the start date and duration of the search period.

-S

Perform a synchronization run with remote calendar servers. This does not override synchronization time restrictions that may have been configured in the configuration file, but will perform synchronization with any servers for which time restrictions have expired.

WARNING: synchronizing calendars can be destructive in that events as well as whole calendars may be removed based on changes received from the server. Be sure to have a backup copy of your calendar data (e.g., using the -e export flag) before synchronizing with untested servers.

-t timezone

Specifies the timezone in which event date/time values are shown as well as that used when adding new events using -a and their repetition and exclusion dates/times using -r. When importing events using -i, the timezone information contained in the imported file will be used.

-u

Update events specified by id arguments. This option is equivalent to exporting events in iCalendar format, editing with an external editor, and then re-importing back to td. Note that if multiple id arguments are given or if multiple items are are generated from a search, they will be exported/edited/re-imported separately for each calendar due to it otherwise being impossible to re-import them back to their correct calendars.

-v

Enables a verbose trace to stderr of what TDcal is doing.

-V

Displays the TDcal version number and exits.

-x

Displays a short explanation of command-line options.

[cal/]id ...

List of events. When naming events, id can be of the form ‘calendar/id’ or ‘collection/calendar/id’ to name one specific event, or one or more -c cal flags can be given to designate calendars and then id events without calendar names will be searched for in those calendars.

All dt, sdt and edt arguments are in the format yyyymnddhhmmss. Optional separation characters ‘/:-’ and spaces may be used to make dates more human-readable, for example ‘2013/08/03 10:45:00’. When adding new calendar items using -a, the date may be omitted if it is today. The time may also be abbreviated to just hhmm (or hh:mm). When listing events using -L, the time may be omitted.

The timezone names are standard system timezones such as UTC, America/New_York, Asia/Bangkok, Europe/Paris, etc.

Event ids are strings containing arbitrary names chosen by the calendar software that was used to create that event. Use the -f flag to list events with their ids. Example ids might be:

ZVR0FWTUQBHRD9YVFXI2PT
a1ff6b23-09a3-4741-92d2-4f6a29c27da9
user-3c6727c_176_c1@mycomputer.example.com

ENVIRONMENT

The following environment variables affect the execution of td:

DISPLAY: X-Windows GUI display name.
EDITOR: Name of the external editor to use when updating items. If not set, defaults to vi(1). See the -u flag.
HOME: The user's home directory. Used for the location of the configuration file and the default location of the calendar data and the log file.
LANG: NLS general language specifier. Its value is used if either of the LC_ variables are not set.
LC_CTYPE: The locale setting for the user's character encoding.
LC_TIME: The locale setting for the user's date and time formats.
PATH: Used to find an external editor. See the -u flag.
TMPDIR: Used for storage of the exported calendar item during editing. See the -u flag.
TZ: Timezone. If not set, the system timezone is used.
USER: The user's login name.

EXIT STATUS

The td utility exits 0 on success, and >0 if an error occurs.

FILES

See TDcal(7).

STANDARDS

See TDcal(7).

HISTORY

See TDcal(7).