1 # fcontacts.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 fcontacts

    14 

    15 ==short-description

    16 

    17 Queries the contacts database.

    18 

    19 ==long-description

    20 

    21 Note, all dates are shown in UTC.

    22 

    23 ==see-also

    24 

    25 L<fcalendar|fcalendar>

    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 contacts. Use C<-i> to specify a contact identifier or C<-m> to specify a match sting to list a sub-set of contacts.

    34 

    35 ==enum-value add

    36 

    37 Add a contact. Use options C<-f>, C<-s>, C<-t> and C<-b> to specify the contact's details.

    38 

    39 ==enum-value delete

    40 

    41 Delete a contact. Use C<-i> to specify the identifier of the contact entry to be deleted.

    42 

    43 ==enum-value change

    44 

    45 Change an existing contact. Use C<-i> to specify the identifier of the contact entry to be changed. Use options C<-f>, C<-s>, C<-m> and C<-t> to specify the new details. Unspecified details will remain the same.

    46 

    47 ==enum-value delete-all

    48 

    49 Delete all contacts in the database.

    50 

    51 ==enum-value create-group

    52 

    53 Create a new group. Use C<-g> to specify the group's name.

    54 

    55 ==enum-value add-to-group

    56 

    57 Add a contact to a group. Use C<-i> and C<-d> to specify the contact and group identifiers.

    58 

    59 ==enum-value compact

    60 

    61 Compact the database.

    62 

    63 ==option bool v verbose multiple

    64 

    65 Shows all fields. Specify twice (i.e. C<-vv>) for even more detail about field mappings.

    66 

    67 ==option uint i contact-id

    68 

    69 Specify the identifier of a contact.

    70 

    71 ==option uint d group-id

    72 

    73 Specify the identifer of a group. Used when adding a contact to a group.

    74 

    75 ==option string m match

    76 

    77 A match string to limit what contacts are shown. Only valid with the C<list> command. Can contain wild-cards C<*> and C<?>.

    78 

    79 ==option bool o first-phone-only

    80 

    81 Only print the first phone number of the first matching contact. Only valid with the C<list> command, and if C<--verbose> has not been specified.

    82 

    83 ==option string f first-name

    84 

    85 Specify the contact's first name.

    86 

    87 ==option string l last-name

    88 

    89 Specify the contact's last name.

    90 

    91 ==option string t telephone

    92 

    93 Specify the contact's general telephone number.

    94 

    95 ==option string b mobile

    96 

    97 Specify the contact's mobile phone number.

    98 

    99 ==option filename p photo

   100 

   101 Specify the name of a file that contains a photo or logo of the contact.

   102 

   103 ==option string g group

   104 

   105 Specify the name of a group. Used when creating a new group.

   106 

   107 ==copyright

   108 

   109 Copyright (c) 2008-2010 Accenture. All rights reserved.

   110