home *** CD-ROM | disk | FTP | other *** search
/ ftp.uv.es / 2014.11.ftp.uv.es.tar / ftp.uv.es / pub / unix / pine4.10.tar.gz / pine4.10.tar / pine4.10 / imap / docs / drivers.txt < prev    next >
Text File  |  1998-05-06  |  6KB  |  148 lines
  1.            c-client Driver Characteristics
  2.                  Mark Crispin
  3.                   6 May 1998
  4.  
  5.  
  6. I. Special name "INBOX"
  7.  
  8. The following rules to select INBOX and its format apply in
  9. the order given if "black box mode" is not in effect:
  10.  1) mbox format is selected if file ~/mbox exists, and is in unix
  11.     format or is zero-length.
  12.  2) mx format is selected if file ~/INBOX/.mxindex exists.
  13.  3) mbx format is selected if file ~/INBOX exists and is in mbx format.
  14.  4) tenex format is selected if:
  15.     a) file ~/mail.txt exists, and is in tenex format or is zero-length.
  16.     b) file ~/INBOX exists and is in tenex format.
  17.  5) mtx format is selected if:
  18.     a) file ~/INBOX.MTX exists, and is in mtx format or is zero-length.
  19.     b) file ~/INBOX exists and is in mtx format.
  20.  6) mmdf format is selected if the spool directory file exists and is
  21.     in mmdf format.
  22.  7) unix format is selected if the spool directory file exists and is
  23.     in in unix format.   
  24.  8) the dummy driver is selected if the spool directory file does not
  25.     exist, or exists and is empty.
  26.  
  27. If "black box mode" is not in effect, messages are automatically
  28. transferred ("snarfed") from the spool directory to an INBOX in mbox,
  29. mx, mbx, tenex, and mtx formats.
  30.  
  31. The following rules to select INBOX and its format apply in the order
  32. given if "black box mode" is in effect:
  33.  1) mx format is selected if file ~/INBOX/.mxindex exists.
  34.  2) mbx format is selected if file ~/INBOX exists and is in mbx format.
  35.  3) tenex format is selected if file ~/INBOX exists and is in tenex format.
  36.  4) mtx format is selected if file ~/INBOX exists and is in mtx format.
  37.  5) mmdf format is selected if file ~/INBOX exists and is in mmdf format.
  38.  6) unix format is selected if file ~/INBOX exists and is in unix format.
  39.  7) the dummy driver is selected if ~/INBOX does not exist, or exists
  40.     and is empty.
  41.  
  42. II. Special Name #mhinbox
  43.  
  44. #mhinbox always refers to the directory "inbox" in the MH path, which
  45. is declared in the ~/.mh_profile file.  Messages are automatically
  46. transferred from the spool directory to #mhinbox mailbox.
  47.  
  48.  
  49. III. Special Prefix "#mh/"
  50.  
  51. Any name prefixed with "#mh/" always refers to a directory in the MH
  52. path, which is declared in the ~/.mh_profile file.  For example, the name
  53. "#mh/foo" refers to directory "foo" in the MH path.
  54.  
  55.  
  56. IV. Special prefix "#news."
  57.  
  58. Any name prefixed with "#news" always refers to a newsgroup.  For
  59. example, the name "#news.comp.mail.misc" refers to newsgroup
  60. "comp.mail.misc".
  61.  
  62.  
  63. V. All Other Names
  64.  
  65. The driver is selected by generating a file name from the mailbox
  66. name, and then examining the data of the object with the resulting
  67. name.  The formats are checked in order: mx, mbx, tenex, mtx, mmdf,
  68. unix, and phile.  The dummy driver is selected if the file is empty.
  69.  
  70. The file name is generated according to certain rules, based upon the
  71. prefix of the mailbox name.  On UNIX, the following rules apply:
  72.  
  73. Prefix        Interpretation of Suffix
  74. ------        ------------------------
  75. /        [black box] preceeds a user name; "/foo/bar" means
  76.          "black box user foo's mailbox bar"
  77.         [not black box] preceeds an absolute path name.
  78. ~        [not black box] preceeds a user name; "~foo/bar" means
  79.          "UNIX user foo's mailbox bar"
  80. #ftp/        preceeds UNIX user ftp's mailbox name
  81. #public/    preceeds UNIX user imappublic's mailbox name
  82. #shared/    preceeds UNIX user imapshared's mailbox name
  83.  
  84. All other names are interpreted in the context of the UNIX user's home
  85. directory (not black box), the black box user's black box directory
  86. (black box), or UNIX user ftp's home directory (anonymous).
  87.  
  88. The strings "..", "//", and /~ are forbidden in names in:
  89.  black box mode
  90.  #ftp, #public, or #shared names
  91.  anonymous users
  92.  
  93. Anonymous users may only access:
  94.  INBOX (belonging to UNIX user ftp)
  95.  files in or below UNIX user ftp's home directory
  96.  #ftp, #news, and #public namespace
  97.  
  98. VI. Driver Comparison
  99.  
  100. The following information about the local file drivers is an
  101. elaboration of a table compiled by Osma Ahvenlampi.
  102.  
  103. Driver    CA    CE    UID    Kwd    Sub    NFS    Performance    Layout
  104. ------    --    --    ---    ---    ---    ---    -----------    ------
  105. unix    no    no    yes    yes    no    limited    fair        file
  106.  ;;; traditional UNIX format
  107. mbox    no    no    yes    yes    no    limited    fair        file
  108.  ;;; traditional UNIX format, INBOX only, using ~/mbox with automatic
  109.  ;;; moving from the mail spool directory.
  110. mmdf    no    no    yes    yes    no    limited    fair        file
  111.  ;;; default on SCO systems
  112. mbx    yes    yes    yes    yes    no    no    very good    prefile
  113.  ;;; best performing local file driver; preferred format at UW
  114. tenex    yes    no    no    limited    no    no    good        prefile
  115.  ;;; compatible with UNIX MM
  116. mtx    yes    no    no    limited    no    no    very good    prefile
  117.  ;;; PC Pine standard format; compatible with TOPS-20; identical to tenex
  118.  ;;; but instead CRLF newlines instead of LF
  119. mx    yes    buggy    yes    yes    yes    no    poor        ixdir
  120.  ;;; fullest function; *not* recommended due to performance problems and bugs;
  121.  ;;; to be redesigned/rewritten
  122. mh    yes    no    no    no    yes    yes    very poor    dir
  123.  ;;; compatible with mh; #mhinbox for INBOX, #mh/ prefix for all other names
  124. news    yes    no    yes    no    yes    yes    very poor    ixdir
  125.  ;;; local news spool access; #news. prefix for all names
  126. phile    no    no    no    no    no    yes    good        file
  127.  ;;; reads arbitrary file as a single readonly message
  128.  
  129. IMPORTANT: the "performance" ratings are relative to other drivers,
  130. and not necessarily to other software which implements those formats.
  131. They relate to the driver's performance in typical operations such as
  132. an IMAP "FETCH ALL".
  133.  
  134. Key to headings:
  135.     CA:    concurrent read/write access
  136.     CE:    expunge permitted in concurrent read/write access
  137.     UID:    sticky UIDs
  138.     Kwd:    keyword flags
  139.     Sub:    subfolders
  140.     NFS:    usable over network filesystems (NFS, AFS, etc.)
  141.     Layout:    file - single file
  142.         prefile - file with preallocated space for state
  143.         dir - directory, messages are files
  144.         ixdir - directory, messages are files, with helper index
  145.  
  146. In addition, drivers imap, nntp, and pop3 support IMAP4rev1, NNTP, and
  147. POP3 protocols respectively.
  148.