home *** CD-ROM | disk | FTP | other *** search
/ WordPerfect for Linux Bible / WP4LinuxBible.iso / readme / readme.adr < prev    next >
Text File  |  1999-06-25  |  3KB  |  86 lines
  1. Address Book
  2.  
  3. ------------ Information -------------------------
  4.  
  5. Corel WordPerfect will utilize a third-party
  6. address book if installed as an executable or a
  7. symbolic link as /<WPdir>/shbin10/addrbook
  8. You can find more information about third party
  9. addressbooks at http://www.sdcorp.com
  10.  
  11. If you already have a third party address book
  12. that you would like to use with WordPerfect,
  13. install it as follows (you may need to be the
  14. administrator to do this):
  15.  
  16. 1. Quit WordPerfect
  17. 2. Use the following shell commands to install
  18.    the address book:
  19.     cd /<WPdir>/shbin10
  20.     ln -s <path-to-addressbook> addrbook
  21. 3. Start WordPerfect
  22.  
  23.  
  24. ----------- Third Party Interface ---------------
  25.  
  26. The addressbook will be invoked with the following
  27. options:
  28.  
  29. addrbook -wp -fd <filedscrptr> [-type <n>] [-single] 
  30.        [-merge <filename>] [-mergeselect <filename>]
  31.  
  32. The file descriptor is a two-way pipe for reading
  33. and writing.  The type can be:
  34.     1: Tells addrbook to return a comma
  35.        delimited addressbook record which
  36.        should be null terminated.  This type
  37.        is currently not used.
  38.     2: Tells addrbook to return individual
  39.        e-mail addresses (one e-mail address per
  40.        message) which should be null terminated.
  41.     3: Tells addrbook to return individual 
  42.        pre-formatted addresses (one address per
  43.        message) which should be null terminated.
  44.  
  45. The -single option tells the address book to
  46. return a maximum of one selection.  In other
  47. words, it will only send one message through the
  48. pipe for the command line -type option rather than
  49. multiple messages.
  50.  
  51. The -merge option tells the addressbook to write
  52. all of its records to <filename> in WordPerfect
  53. secondary merge format.  The -mergeselect option
  54. starts the addressbook so that the user can
  55. select the records to write to the secondary
  56. merge file.  For both of these options, the
  57. only data sent through the pipe to WordPerfect
  58. is the MapNotify and DestroyNotify.
  59.  
  60. The address book communicates information to Corel
  61. WordPerfect by sending two bytes telling WP how
  62. many more bytes of data follow in the message.
  63. The following two bytes (included in the count of
  64. the total number of bytes being transmitted)
  65. contain the type of message being transmitted.
  66. This corresponds to the types described above.
  67. When addrbook starts, it should send a two-byte
  68. MapNotify (defined by X-windows to be 19) type
  69. message to WP.  After data is sent to WP, the
  70. address book should exit.  When it exits, it
  71. should send a destroy notify (defined as 17) and
  72. close the pipe.
  73.  
  74. Example:
  75.  
  76. |         |<--------- message ------------>|
  77. | length  | type    | remainder of message |    
  78. | 2 bytes | 2 bytes | n-bytes=(length-2)   |
  79. +---------+---------+----------------------+
  80. |       2 |      19 |                MapNotify
  81. |      26 |       3 |Hello World\0|  address type
  82. |      10 |       3 |bye\0|          address type
  83. |       2 |      17 |                DestroyNotify
  84.     
  85.  
  86.