[Tcladdressbook-commits] Help tcladdressbook.n,1.4,1.5

[Bernard D. <bde...@us...>]

Update of /cvsroot/tcladdressbook/Help
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5650/Help

Modified Files:
	tcladdressbook.n 
Log Message:
Documents new 1.1b1 commands

Index: tcladdressbook.n
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/tcladdressbook.n,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- tcladdressbook.n	28 Jul 2004 23:10:57 -0000	1.4
+++ tcladdressbook.n	29 Jul 2004 13:32:09 -0000	1.5
@@ -56,13 +56,14 @@
 This command lets you export the record with unique ID \fI personID\fP as
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
-.SS addressbook getme
+.SS addressbook getme ?\fI -id\fP?
 .PP
-This command returns all the data available in the database concerning
-the logged-in user ("Me"). The returned value takes the form of 
-a keyed list: see the \fBaddressbook record\fP command for a description 
-of this format. Keyed lists can be easily manipulated with the 
-\fBkeylget\fP and \fBkeylset\fP commands defined in the TclX extension.
+This command returns the ID or the data corresponding to the logged-in user
+("Me"). If the \fI -id\fP option is specified, it returns the unique ID of
+the logged-in user. Otherwise the returned value takes the form of a keyed
+list: see the \fBaddressbook record\fP command for a description of this
+format. Keyed lists can be easily manipulated with the \fBkeylget\fP and
+\fBkeylset\fP commands defined in the TclX extension.
 .SS addressbook groups ?-ids? ?-ingroup \fI groupID\fP?
 .PP
 This command returns a list of all the existing group records: if no option
@@ -72,6 +73,25 @@
 returned list will contain only the unique IDs of the groups. If the 
 \fI -ingroup\fP option is specified, only the subgroups contained in the group
 with ID \fI groupID\fP will be returned.
+.SS addressbook identifier \fI personID\fP \fI groupID\fP \fI propName\fP ?\fI label\fP?
+.PP
+This command lets you get or set the distribution identifier for a
+multi-value list property of a person in a group. 
+.PP
+ Used without a \fI label\fP argument, this will return the
+distribution identifier for the person \fI personID\fP belonging to the
+group \fI groupID\fP concerning property \fI propName\fP if it was set,
+otherwise the property¹s primary identifier. Property \fI propName\fP must
+be a multi-value list property
+.PP
+ If the \fI label\fP argument is specified, this will assign a
+specific distribution identifier for the person¹s multi-value list property
+so that the group can be used as a distribution list (a mailing list for
+instance, in the case of an email property). This value must be a label
+used by the multi-value list (such as \fI home\fP for an \fI address\fP
+property). If \fI label\fP is an empty string, this command resets the
+distribution identifier to its default, i-e the multi-value list¹s primary
+identifier.
 .SS addressbook image \fI personID\fP ?\fI imageData\fP?
 .PP
 If no \fI imageData\fP argument is specified, this command returns the
@@ -123,11 +143,19 @@
 This argument can have one of the following values: \fI Array, Data, Date,
 Dictionary, Integer, Real, String, MultiArray, MultiData, MultiDate,
 MultiDictionary, MultiInteger, MultiReal, MultiString.\fP
-.SS addressbook property remove (-groups | -persons) \fI propName\fP
+.SS addressbook property remove (-groups | -persons | recordID) \fI propName\fP
 .PP
 This command lets you remove a property from the database, either for
 person or for group records. The name of the property is specified in the
-\fI propName\fP argument. One can get the list of all the existing
+\fI propName\fP argument. If the third argument is either \fB-groups\fP or
+\fB-persons\fP, the command should remove the given property from all
+the records of this type in the Address Book database and return the
+number of properties successfully removed. Otherwise the third 
+argument should be the record ID of a particular person or group: the 
+property is removed for this record only and the command returns an 
+empty string.
+.PP
+ One can get the list of all the existing
 properties with the \fBaddressbook property names\fP command.
 .SS addressbook record \fI recordID\fP
 .PP