1 # fcalendar.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name fcalendar

    14 

    15 ==short-description

    16 

    17 Queries the calendar database.

    18 

    19 ==long-description

    20 

    21 Note, all dates and times are shown in UTC.

    22 

    23 ==see-also

    24 

    25 L<fcontacts|fcontacts>

    26 

    27 ==argument enum command optional

    28 

    29 The command to execute. Defaults to C<list>.

    30 

    31 ==enum-value list

    32 

    33 List all the calendar entries. Optionally use C<-f> to specify the database file.

    34 

    35 ==enum-value delete

    36 

    37 Delete the specified calendar entries. Use C<-g> to specify the global identifier of the entry to be deleted.

    38 

    39 ==enum-value add

    40 

    41 Add a calendar entry. Use options C<-g>, C<-t>, C<-s>, C<-a> and C<-e> to specify properties.

    42 

    43 ==enum-value change

    44 

    45 Change a calendar entry. Use options C<-g>, C<-s>, C<-a> and C<-e> to specify properties.

    46 

    47 ==option bool v verbose multiple

    48 

    49 Print verbose output. Specify twice (i.e. C<-vv>) for even more detail.

    50 

    51 ==option string f file

    52 

    53 Specify calendar database file. By default F<c:Calendar> will be used. Note, the file name must not contain a path.

    54 

    55 ==option uint l local_id

    56 

    57 Speficify a local identifier. Used by C<add> and C<change> if specified.

    58 

    59 ==option string g global_id

    60 

    61 Speficify a global identifier. Must be specified when using C<add> or C<change>.

    62 

    63 ==option enum t type

    64 

    65 Specify type of entry.

    66 

    67 ==enum-value appointment

    68 

    69 ==enum-value todo

    70 

    71 ==enum-value event

    72 

    73 ==enum-value reminder

    74 

    75 ==enum-value anniversary

    76 

    77 ==option string s summary

    78 

    79 Specify the summary (or subject) text. Use quotes if there the string contains spaces.

    80 

    81 ==option string a start_time

    82 

    83 Specify the entry's start time. The string format must match current locale setting. E.g. C<25-12-2009 01:30:30> if current locale setting is UK. Use quotes the string contains spaces.

    84 

    85 ==option string e end_time

    86 

    87 Specify entry's end time. Format as for C<start_time>.

    88 

    89 ==copyright

    90 

    91 Copyright (c) 2009-2010 Accenture. All rights reserved.

    92