NAME

dtcm_admin − administer the calendar and appointment services database

SYNOPSIS

dtcm_admin [−d] [−a action] [−c calendar] [−s start_date] [−e end_date] [−f filename]

dtcm_admin −h

DESCRIPTION

The dtcm_admin utility is the administration interface to the CDE calendar and appointment services, used to archive and restore data from user calendars. 

Archiving calendar information dumps data from the calendar’s database within a specified date range, and stores it in an archive file for backup or other purposes.  This allows the user to limit the amount of redundant historical data in a calendar, saving disk space and improving the performance of the calendar database manager rpc.cmsd(1). 

By default, dtcm_admin performs a nondestructive operation, which is useful for backup or data transfer between calendars; the −d removes the archived data from the calendar. 

OPTIONS

The following options are available:

−a action
Specify the operation to be performed. The supported argument values are archive and restore.  The default action is to archive data. 

−c calendar
Specify the name of the calendar on which action will be performed.  Permission to perform the operation is required.  Calendar names typically take the form user@ hostname, where user is a user’s login name and hostname is the host machine name.  An example is felix@cat.  If no target calendar is specified, the calendar defaults to the current user at the current host machine. 

−d Delete the data from the calendar after archiving it.  By default the data is not deleted.  This only has an effect for archive operations. 

−h Write a usage help message to standard output and terminate.  All other options are ignored. 

−s start_date
Specify the beginning of a date range that constrains the effect of the operation. The start_date option-argument is in the form mmddyy, where mm, dd and yy are the two-digit month, day and year modulo 100, respectively.  The granularity of the range is one day, meaning that the operation is performed on every calendar entry whose start time falls from 00:00 on the specified start_date date to 23:59, inclusive, on the end_date date.  If start_date is not specified, all the entries in the calendar dated before or on the end_date date are processed.  If end_date is not specified, all the entries in the calendar dated on or after the start_date date are processed.  If neither −s nor −e is specified, the operation is performed for the entire input data set. 

−e end_date
Specify the end of a date range that constrains the effect of the operation, in the same format as −s. 

−f filename
Specify the name of a file for the output of an archive operation or input to a restore operation. If this option is omitted, archived data is sent to standard output and data for a restore operation is taken from the standard input.

OPERANDS

None. 

STDIN

When −a restore is specified, the standard input is archived data produced by a previous invocation of dtcm_admin.  The standard input is used only if no −f filename option is specified. 

INPUT FILES

When −a restore and −f filename are specified, the input file named by filename is archived data produced by a previous invocation of dtcm_admin. 

ENVIRONMENT VARIABLES

The following environment variables affect the execution of dtcm_admin:

LANG Provide a default value for the internationalization variables that are unset or null.  If LANG is unset or null, the corresponding value from the implementation-specific default locale will be used.  If any of the internationalization variables contains an invalid setting, the utility behaves as if none of the variables had been defined. 

LC_ALL If set to a non-empty string value, override the values of all the other internationalization variables. 

LC_MESSAGES
Determine the locale that is used to affect the format and contents of diagnostic messages written to standard error and informative messages written to standard output.

NLSPATH Determine the location of message catalogues for the processing of LC_MESSAGES.

RESOURCES

None. 

ASYNCHRONOUS EVENTS

The dtcm_admin utility takes the standard action for all signals. 

STDOUT

Unless −a restore and −f filename are specified, the standard output contains the archived data suitable for later restores by dtcm_admin.  If −f filename is specified, the standard output is not used. 

STDERR

Used only for diagnostic messages. 

OUTPUT FILES

If −a archive and −f filename are specified, the file named by filename contains the archived data suitable for later restores by dtcm_admin. 

EXTENDED DESCRIPTION

None. 

EXIT STATUS

The following exit values are returned:

0 Successful completion. 

>0 An error occurred. 

CONSEQUENCES OF ERRORS

Default. 

FILES

/usr/spool/calendar/callog.username

/usr/dt/bin/rpc.cmsd

APPLICATION USAGE

None. 

EXAMPLES

The following archives calendar data up to the end of 1993:

dtcm_admin −a archive −e 123193 −f calendar.1993

The following merges another user’s calendar data into the user’s calendar:

dtcm_admin −a archive −c theboss@bigcheese | dtcm_admin −a restore

SEE ALSO

rpc.cmsd(1), dtcm(1), dtcm_delete(1), dtcm_insert(1), dtcm_lookup(1). 

  —  9 March 1992