home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 1 / Meeting Pearls Vol 1 (1994).iso / installed_progs / comm / ums / tools / importexport / export.man < prev    next >
Encoding:
Text File  |  1993-10-14  |  6.0 KB  |  162 lines
  1.  
  2.                 EXPORT (V2.5)
  3.                 ~~~~~~
  4.  
  5. Format:   EXPORT <name> <password> [SERVER <server>] [<file>]
  6. ~~~~~~~   [PRESERVE] [SUBSCRIBED] [UPDATE <updateflag>]
  7.           [FILTER <filterflag>] [VERBOSITY <level>]
  8.  
  9. Template: USER/A,PASSWORD/A,SERVER/K,FILE,PRESERVE/S,SUBSCRIBED/S,
  10. ~~~~~~~~~ UPDATE/K/N,FILTER/K/N,VERBOSITY/K/N
  11.  
  12. Purpose:  Export messages from a UMS message-base, either to backup
  13. ~~~~~~~~  or to transfer them to another UMS message-base.
  14.  
  15. Specification:
  16. ~~~~~~~~~~~~~~
  17.  
  18. EXPORT  reads  messages  from  a UMS message-base and stores them in a
  19. file.  It  uses its own format, which stores the complete UMS message,
  20. has very little overhead, is "almost plaintext" and can be efficiently
  21. read by a tool called IMPORT.
  22.  
  23. It may be used for different purposes:
  24.  
  25.  -  for  making backups of a message-base.
  26.  
  27. Advantages of using EXPORT instead of a filesystem based backups are:
  28.  
  29.     + incremental backups are supported.
  30.     + selective backups are possible. I.e. you can make a backup of
  31. only the more important messages.
  32.     + the backup is more space efficient, it uses less overhead.
  33.     + devices like tape-streamers may easily and efficiently be used.
  34.  
  35. However there is an important disadvantage:
  36.  
  37.     -  the  status  of  messages is not saved.  After a backup&restore
  38. operation  with EXPORT/IMPORT all information on what user has already
  39. read or exported what message is completely lost!
  40.  
  41.  
  42.  - for transfering messages from one message-base to another.
  43.  
  44. Let's  say  you want to create a new message-base on your system, e.g.
  45. to test a new configuration or some beta-tools.  In order not to start
  46. with  a  completely  empty message-base you might want to fill it with
  47. some  old "news" from your other message-base.  This can be easily and
  48. efficiently  done  with EXPORT and IMPORT.  All data will be preserved
  49. in the proper format and no garbage data will be added.
  50.  
  51.  
  52.  - to exchange messages with another node that also uses UMS.
  53.  
  54. Given  you  are  a  node  system  which  has  to feed some "points" or
  55. "leaf-nodes"  that  use  UMS,  too.  You  might want to use EXPORT and
  56. IMPORT  for  exchanging  messages  with  them,  since  these  tool are
  57. completely  capabale  of  doing this and are more efficient using less
  58. overhead than any other know protocol.
  59.  
  60. You  could  even  build  a complete complex network of UMS-using nodes
  61. with EXPORT/IMPORT, if you (and the other nodes) wanted to.
  62.  
  63.  
  64. Invocation:
  65. ~~~~~~~~~~~
  66. you  must  specify a username and password to log into the (optionally
  67. specified) UMS server that the messages are read from.
  68.  
  69. If  you  specify  the  filename  <file>, this will be the file that is
  70. written to.  Otherwise output will be written to stdout.
  71.  
  72. Specifying the PRESERVE keyword means your user-flag "old" must not be
  73. changed.  Otherwise messages written to the file will me marked as old
  74. and,  if  the  used  UMS account has "EXPORT" privileges, as exported.
  75. You  will want to use the PRESERVE keyword when making backups or just
  76. playing  around.   You should NOT use it when exchanging messages with
  77. other nodes.
  78.  
  79. The  SUBSCRIBED  keyword makes EXPORT only export messages with groups
  80. matching at least one of the patterns given in the "export.subscribed"
  81. var  (see:   Configuration).   You  may  want  to use this option when
  82. exchanging  news  with another node that not neccessarily always wants
  83. to receive all readable messages.
  84.  
  85. As  the  default,  EXPORT  exports  "new" message, with the "old" flag
  86. unset.   If  you want to want to export other messages, you can select
  87. them  with  any  suitable  tool  (e.g.   CleanEx) and tell EXPORT what
  88. user-flag  has  been  set  on  these  messages.  This is done with the
  89. FILTER  option.   With  this  option, EXPORT exports all messages with
  90. this flag set, no matter whether they are new or not.
  91.  
  92. EXPORT  can  use another user-flag, indicated by UPDATE, to mark which
  93. messages  have  been  exported to only export each message once.  This
  94. flag  is  used  analogously  to  the "old" flag.  Useful for archiving
  95. messages without having to dedicate an extra UMS user-account for this
  96. purpose.   ONLY  use this feature, if you EXACTLY know which flags you
  97. may use!!!
  98.  
  99. The  VERBOSITY  option allows you to control the verbosity of console-
  100. output (stderr) given by EXPORT. The <level> must be in the range of 0
  101. to  9.  Otherwise  it will be set to the default of 6, which gives you
  102. some 'graphical' progress-report. Set it to 5 to suppress the progress
  103. report  and  only see a short statistical summary. Set it to 4 to only
  104. get  stderr-output in case of errors. Set it to 0 to ignore all errors
  105. except  of gurus (which cannot be ignored). Set it to 9 to get as much
  106. output as possible.
  107.  
  108.  
  109. Configuration:
  110. ~~~~~~~~~~~~~~
  111.  
  112. EXPORT uses the following variables in teh UMS configuration:
  113.  
  114.   export.nodename -- the address used for the local system.
  115.  
  116. For messages that are written or received by local users UMS stores no
  117. "address".  Each  exporter must know what it's system's name is in the
  118. destination  network.  EXPORT  uses  this config var to determine this
  119. address. It is MANDATORY!
  120.  
  121.   export.subscribed -- subscribed groups.
  122.  
  123. This  is an AmigaDOS style pattern (or a list of patterns, one in each
  124. line).  If  option  SUBSCRIBED  is  activated, only messages in groups
  125. matching this pattern are exported.
  126.  
  127.  
  128. Examples:
  129. ~~~~~~~~~
  130.  
  131. 1)
  132. Make a complete backup of the MB to a file on volume "Spool":
  133.  
  134.   1> export sysop password Spool:backup.export preserve filter 10
  135.  
  136. Using  flag 10 as a filter exports all (readable) messages, since this
  137. is  the "ReadAccess" flag and thus always set on all messages the user
  138. can read.
  139.  
  140. Restore the backup:
  141.  
  142.   1> import sysop password Spool:backup.export restore
  143.  
  144.  
  145. 2)
  146. Transfer all new messages for user "mh" from machine "a500" to the
  147. local machine, using a temporary file on volume "Spool":
  148.  
  149.   1> export mh   password server default@a500 spool:a500.export subscribed
  150.   1> import a500 password server default      spool:a500.export
  151.  
  152.  
  153. 3)
  154. Archive all messages for user "mh" that have not yet been archived to
  155. a tape streamer:
  156.  
  157.   1> export mh password btntape:app preserve update 14 filter 10
  158.  
  159.  
  160. See also: IMPORT, UMSDOCTOR
  161. ~~~~~~~~~
  162.