home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1997 December / PCO1297.ISO / FilesBBS / DOS / INF121X.EXE / contents.doc < prev    next >
Encoding:
Text File  |  1996-11-02  |  18.7 KB  |  361 lines
  1.  
  2.  
  3.       ______              ___________________              ______
  4.       >     |____________| InfoMail/386 1.20 |____________|     <
  5.       ~~||~~|  Centurion |~~~~~~~~~~~~~~~~~~~| 2:2502/666 |~~||~~
  6.         ||   ~~~~~~~~~~~~                     ~~~~~~~~~~~~   ||
  7.         ||                                                   ||
  8.         ||                                                   ||
  9.         ||                                                   ||
  10.         ||                     CENTURION                     ||
  11.         ||                                                   ||
  12.         ||                                                   ||
  13.         ||                        -*-                        ||
  14.         ||                                                   ||
  15.         ||                                                   ||
  16.         ||                 InfoMail/386 1.20                 ||
  17.         ||                                                   ||
  18.         ||       A Document Server for Fidonet Systems       ||
  19.         ||                                                   ||
  20.         ||          Copyright (C) Damian Walker 1996         ||
  21.         ||                                                   ||
  22.         ||                                                   ||
  23.         ||                        -*-                        ||
  24.         ||                                                   ||
  25.         ||                                                   ||
  26.         ||               DOCUMENTATION CONTENTS              ||
  27.         ||                                                   ||
  28.         ||                                                   ||
  29.         ||                        _____                      ||
  30.         ||                       (____()                     ||
  31.         ||                        /   /                      ||
  32.         ||                       /   /                       ||
  33.         ||                      (____()                      ||
  34.         ||                      _______                      ||
  35.         ||                     (_)|||(_)                     ||
  36.         ||                       |||||                       ||
  37.         ||                       |||||                       ||
  38.         ||                       |||||                       ||
  39.         ||                       |||||                       ||
  40.         ||                       |||||                       ||
  41.         ||                       |||||                       ||
  42.         ||                       |||||                       ||
  43.         ||                      /~~~~~\                      ||
  44.         ||                      ~~~~~~~                      ||
  45.         ||                                                   ||
  46.         ||                                                   ||
  47.         ||                                                   ||
  48.         ||                                                   ||
  49.         ||   ____________                     ____________   ||
  50.       __||__|  Copyright |___________________|    1996    |__||__
  51.       >     |~~~~~~~~~~~~| (C) Damian Walker |~~~~~~~~~~~~|     <
  52.       ~~~~~~              ~~~~~~~~~~~~~~~~~~~              ~~~~~~
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61. InfoMail/386 1.20 Contents
  62.  
  63. 0.      CONTENTS
  64.  
  65.         USER GUIDE                                            (USER.DOC)
  66.  
  67.         1.      INTRODUCTION    .       .       .       .       .    U-2
  68.         1.1.    What is InfoMail?       .       .       .       .    U-2
  69.         1.2.    System Requirements     .       .       .       .    U-3
  70.         1.3.    Disclaimer      .       .       .       .       .    U-3
  71.         1.4.    Acknowledgements        .       .       .       .    U-4
  72.         1.5.    Version History .       .       .       .       .    U-4
  73.  
  74.         2.      SETTING UP INFOMAIL     .       .       .       .    U-6
  75.         2.1.    The Configuration Editor        .       .       .    U-6
  76.         2.1.1.  Netmail Directory       .       .       .       .    U-7
  77.         2.1.2.  Log File        .       .       .       .       .    U-7
  78.         2.1.3.  AKA List        .       .       .       .       .    U-8
  79.         2.1.4.  Other Fields to Edit    .       .       .       .    U-8
  80.         2.1.5.  Exiting the Configuration Editor        .       .    U-9
  81.         2.2.    Setting Up Documents    .       .       .       .    U-9
  82.         2.2.1.  Adding a Document       .       .       .       .   U-10
  83.         2.2.2.  Subject Line    .       .       .       .       .   U-10
  84.         2.2.3.  Document Filename       .       .       .       .   U-11
  85.         2.2.4.  Saving the Document Record      .       .       .   U-11
  86.         2.2.5.  Editing and Deleting Documents  .       .       .   U-11
  87.         2.2.6.  Exiting the Document List Editor        .       .   U-11
  88.         2.3.    Creating Document Text Files    .       .       .   U-12
  89.         2.4.    Testing out Your Installation   .       .       .   U-13
  90.         2.5.    Running InfoMail Regularly      .       .       .   U-14
  91.         2.6.    Upgrading InfoMail      .       .       .       .   U-15
  92.  
  93.         3.      MORE CONTROL OVER YOUR DOCUMENTS        .       .   U-18
  94.         3.1.    Creating Secret Documents       .       .       .   U-18
  95.         3.1.1.  Hidden Documents        .       .       .       .   U-18
  96.         3.1.2.  Password Protection     .       .       .       .   U-18
  97.         3.2.    Using Expandable Macros .       .       .       .   U-19
  98.         3.2.1.  Program Information     .       .       .       .   U-20
  99.         3.2.2.  User Details    .       .       .       .       .   U-21
  100.         3.2.3.  Document Record Information     .       .       .   U-22
  101.         3.2.4.  Document List   .       .       .       .       .   U-23
  102.         3.2.5.  Other Macro Considerations      .       .       .   U-24
  103.         3.3.    File Attaches and Direct Messages       .       .   U-24
  104.         3.3.1.  Setting the Status Field for File Attaches      .   U-24
  105.         3.3.2.  Considerations for File Attaches on Hold        .   U-25
  106.         3.3.3.  Using the Status Field for Other Purposes       .   U-25
  107.         3.4.    Remotely Updating Documents     .       .       .   U-26
  108.         3.5.    Making a Document Temporarily Inactive  .       .   U-27
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120. Contents                                                            C- 2
  121. InfoMail/386 1.20 Contents
  122.  
  123.         4.      MORE CONTROL OF YOUR OVERALL SETUP      .       .   U-28
  124.         4.1.    Different Log Files     .       .       .       .   U-28
  125.         4.2.    What to Do with Inbound and Outbound Messages   .   U-28
  126.         4.3.    Message Headers and Footers     .       .       .   U-29
  127.         4.4.    Splitting Large Messages        .       .       .   U-29
  128.         4.5.    Customising the Standard Responses      .       .   U-30
  129.         4.5.1.  Customising the Document List   .       .       .   U-30
  130.         4.5.2.  Customising the Document Search Results .       .   U-31
  131.         4.5.3.  Customising the Other Responses .       .       .   U-32
  132.         4.6.    Inactivating the Setup  .       .       .       .   U-32
  133.  
  134.         5.      CONCLUSION      .       .       .       .       .   U-33
  135.  
  136.         REFERENCE GUIDE                                        (REF.DOC)
  137.  
  138.         1.      INTRODUCTION    .       .       .       .       .    R-2
  139.  
  140.         2.      THE COMMAND LINE        .       .       .       .    R-3
  141.         2.1.    The CONFIG command      .       .       .       .    R-3
  142.         2.2.    The LIST command        .       .       .       .    R-3
  143.         2.3.    The -MONO switch        .       .       .       .    R-3
  144.         2.4.    The -PATH switch        .       .       .       .    R-4
  145.         2.5.    The SCAN command        .       .       .       .    R-4
  146.         2.6.    The UPGRADE command     .       .       .       .    R-4
  147.  
  148.         3.      THE KEYBOARD    .       .       .       .       .    R-5
  149.         3.1.    Editing Text Fields     .       .       .       .    R-5
  150.         3.2.    The Configuration Editor        .       .       .    R-5
  151.         3.2.1.  Editing the Configuration Record        .       .    R-5
  152.         3.2.2.  Editing the AKA List    .       .       .       .    R-5
  153.         3.3.    The Document List Editor        .       .       .    R-6
  154.         3.3.1.  Browsing the Document List      .       .       .    R-6
  155.         3.3.2.  Editing a Document Record       .       .       .    R-6
  156.         3.3.3.  Editing the Message Status      .       .       .    R-7
  157.  
  158.         4.      CONFIGURATION FIELDS    .       .       .       .    R-8
  159.         4.1.    Netmail .       .       .       .       .       .    R-8
  160.         4.2.    Log File        .       .       .       .       .    R-8
  161.         4.3.    Active  .       .       .       .       .       .    R-8
  162.         4.4.    Max Message Size        .       .       .       .    R-8
  163.         4.5.    Kill Outbound Errors    .       .       .       .    R-8
  164.         4.6.    Requests        .       .       .       .       .    R-9
  165.         4.7.    Updates .       .       .       .       .       .    R-9
  166.         4.8.    Searches        .       .       .       .       .    R-9
  167.         4.9.    Kill Inbound Requests/Updates/Searches  .       .    R-9
  168.         4.10.   Header and Footer       .       .       .       .    R-9
  169.         4.11.   Doc List        .       .       .       .       .    R-9
  170.         4.12.   File Err        .       .       .       .       .   R-10
  171.         4.13.   Inactive        .       .       .       .       .   R-10
  172.         4.14.   Accept  .       .       .       .       .       .   R-10
  173.         4.15.   Reject  .       .       .       .       .       .   R-10
  174.         4.16.   Results .       .       .       .       .       .   R-10
  175.         4.17.   AKA List        .       .       .       .       .   R-10
  176.  
  177.  
  178.  
  179.  
  180. Contents                                                            C- 3
  181. InfoMail/386 1.20 Contents
  182.  
  183.         5.      DOCUMENT RECORD FIELDS  .       .       .       .   R-11
  184.         5.1.    Document        .       .       .       .       .   R-11
  185.         5.2.    Active  .       .       .       .       .       .   R-11
  186.         5.3.    Listed  .       .       .       .       .       .   R-11
  187.         5.4.    Macros  .       .       .       .       .       .   R-11
  188.         5.5.    Routing .       .       .       .       .       .   R-12
  189.         5.6.    Subject .       .       .       .       .       .   R-12
  190.         5.7.    Status  .       .       .       .       .       .   R-12
  191.         5.8.    Request .       .       .       .       .       .   R-12
  192.         5.9.    Update  .       .       .       .       .       .   R-12
  193.         5.10.   File    .       .       .       .       .       .   R-13
  194.         5.11.   2nd File        .       .       .       .       .   R-13
  195.         5.12.   Accesses        .       .       .       .       .   R-13
  196.  
  197.         6.      DOCUMENT MACROS .       .       .       .       .   R-14
  198.         6.1.    {A} - InfoMail's Address        .       .       .   R-14
  199.         6.2.    {C} - Access Counter    .       .       .       .   R-14
  200.         6.3.    {D} - Document Name     .       .       .       .   R-14
  201.         6.4.    {F} - User's First Name .       .       .       .   R-15
  202.         6.5.    {I} - InfoMail Request Name     .       .       .   R-15
  203.         6.6.    {L} - User's Last Name  .       .       .       .   R-15
  204.         6.7.    {N} - User's Full Name  .       .       .       .   R-15
  205.         6.8.    {O} - Operating System Filename of Document     .   R-15
  206.         6.9.    {P} - Program Name and Version  .       .       .   R-15
  207.         6.10.   {S} - Document Subject Line     .       .       .   R-16
  208.         6.11.   {U} - User's Address    .       .       .       .   R-16
  209.         6.12.   {W} - Document List     .       .       .       .   R-16
  210.         6.13.   {X} - Extended Document List    .       .       .   R-16
  211.         6.14.   {{} - Literal Left Brace        .       .       .   R-16
  212.  
  213.         7.      SCREEN MESSAGES .       .       .       .       .   R-18
  214.         7.1.    ! Cannot create configuration file      .       .   R-18
  215.         7.2.    ! Cannot create document list file      .       .   R-18
  216.         7.3.    ! Cannot open configuration file        .       .   R-18
  217.         7.4.    ! Cannot open document list file        .       .   R-19
  218.         7.5.    ! Cannot open log file  .       .       .       .   R-19
  219.         7.6.    ! Cannot read netmail directory .       .       .   R-19
  220.         7.7.    ? Cannot read netmail message   .       .       .   R-19
  221.         7.8.    * Conversion finished   .       .       .       .   R-20
  222.         7.9.    * Converting configuration file .       .       .   R-20
  223.         7.10.   * Converting document list file .       .       .   R-20
  224.         7.11.   Error: InfoMail is already running      .       .   R-20
  225.         7.12.   Error: cannot create semaphore  .       .       .   R-20
  226.         7.13.   Error: cannot remove semaphore  .       .       .   R-21
  227.         7.14.   Error: type INFOMAIL alone for help     .       .   R-21
  228.         7.15.   * Finished!     .       .       .       .       .   R-21
  229.         7.16.   ! Invalid configuration file    .       .       .   R-21
  230.         7.17.   ! Invalid document list file    .       .       .   R-22
  231.         7.18.   ! Missing or invalid configuration file .       .   R-22
  232.         7.19.   ! Missing or invalid document list file .       .   R-22
  233.         7.20.   ! No netmails to read   .       .       .       .   R-22
  234.         7.21.   * Processing request from...    .       .       .   R-22
  235.         7.22.   * Processing search from...     .       .       .   R-23
  236.         7.23.   * Processing update from...     .       .       .   R-23
  237.  
  238.  
  239.  
  240. Contents                                                            C- 4
  241. InfoMail/386 1.20 Contents
  242.  
  243.         8.      LOG FILE ENTRIES        .       .       .       .   R-24
  244.         8.1.    ? Cannot open document file...  .       .       .   R-24
  245.         8.2.    ! Cannot read netmail directory .       .       .   R-25
  246.         8.3.    ? Cannot read netmail message   .       .       .   R-25
  247.         8.4.    ? Cannot write netmail message  .       .       .   R-25
  248.         8.5.    - Document list closed  .       .       .       .   R-25
  249.         8.6.    - Document list opened  .       .       .       .   R-25
  250.         8.7.    ! Missing or invalid document list      .       .   R-25
  251.         8.8.    ! No netmails to read   .       .       .       .   R-26
  252.         8.9.    * Processing request from...    .       .       .   R-26
  253.         8.10.   * Processing search from...     .       .       .   R-26
  254.         8.11.   * Processing update from...     .       .       .   R-26
  255.         8.12.   + Sending document list to...   .       .       .   R-26
  256.         8.13.   + Sending document...   .       .       .       .   R-26
  257.         8.14.   + Sending file error to...      .       .       .   R-26
  258.         8.15.   + Sending inactive document error to... .       .   R-27
  259.         8.16.   + Sending reject message to...  .       .       .   R-27
  260.         8.17.   + Sending search results to...  .       .       .   R-27
  261.         8.18.   + Sending update confirmation to...     .       .   R-27
  262.         8.19.   + Updated document...   .       .       .       .   R-27
  263.  
  264.         9.      MISCELLANEOUS INFORMATION       .       .       .   R-28
  265.         9.1.    InfoMail Directory Contents     .       .       .   R-28
  266.         9.1.1.  INFOMAIL.EXE - The InfoMail Executable  .       .   R-28
  267.         9.1.2.  CWSDPMI.EXE - The DPMI Server   .       .       .   R-28
  268.         9.1.3.  *.DOC - The Main Documentation  .       .       .   R-28
  269.         9.1.4.  FILE_ID.DIZ/*.TXT - Minor Documentation Files   .   R-29
  270.         9.1.5.  *.SAM - The Sample Files        .       .       .   R-29
  271.         9.1.6.  INFOMAIL.CFG - The Configuration File   .       .   R-30
  272.         9.1.7.  INFOMAIL.DAT/INFOMAIL.NDX - The Document List   .   R-30
  273.         9.1.8.  INFOMAIL.CF$/INFOMAIL.DA$ - Upgrade Backups     .   R-30
  274.         9.2.    The INFOMAIL Environment Variable       .       .   R-30
  275.         9.3.    Defaults        .       .       .       .       .   R-30
  276.         9.4.    Limits  .       .       .       .       .       .   R-31
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300. Contents                                                            C- 5
  301. InfoMail/386 1.20 Contents
  302.  
  303.         DEVELOPER'S GUIDE                                      (DEV.DOC)
  304.  
  305.         1.      INTRODUCTION    .       .       .       .       .    D-2
  306.  
  307.         2.      THE CONFIGURATION FILE  .       .       .       .    D-3
  308.         2.1.    The NETMAIL field       .       .       .       .    D-4
  309.         2.2.    The LOGFILE field       .       .       .       .    D-5
  310.         2.3.    The FLAGS field .       .       .       .       .    D-5
  311.         2.4.    The REQUEST field       .       .       .       .    D-6
  312.         2.5.    The UDPATE field        .       .       .       .    D-6
  313.         2.6.    The SEARCH field        .       .       .       .    D-6
  314.         2.7.    The HEADER field        .       .       .       .    D-6
  315.         2.8.    The FOOTER field        .       .       .       .    D-7
  316.         2.9.    The DOCLIST field       .       .       .       .    D-7
  317.         2.10.   The NOFILE field        .       .       .       .    D-7
  318.         2.11.   The INACTIV field       .       .       .       .    D-7
  319.         2.12.   The ACCEPT field        .       .       .       .    D-7
  320.         2.13.   The REJECT field        .       .       .       .    D-7
  321.         2.14.   The RESULTS field       .       .       .       .    D-7
  322.         2.15.   The SPLIT field .       .       .       .       .    D-7
  323.         2.16.   The AKA LIST records    .       .       .       .    D-8
  324.  
  325.         3.      THE DOCUMENT LIST FILES .       .       .       .    D-9
  326.         3.1.    The DELETED field       .       .       .       .   D-10
  327.         3.2.    The DOCNAME field       .       .       .       .   D-11
  328.         3.3.    The FLAGS field .       .       .       .       .   D-11
  329.         3.4.    The SUBJECT field       .       .       .       .   D-11
  330.         3.5.    The ATTR field  .       .       .       .       .   D-11
  331.         3.6.    The REQUEST field       .       .       .       .   D-12
  332.         3.7.    The UPDATE field        .       .       .       .   D-12
  333.         3.8.    The FILE field  .       .       .       .       .   D-12
  334.         3.9.    The SECFILE field       .       .       .       .   D-12
  335.         3.10.   The COUNTER field       .       .       .       .   D-12
  336.         3.11.   Details of the Index File       .       .       .   D-12
  337.  
  338.         INDEX                                                (INDEX.DOC)
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360. Contents                                                            C- 6
  361.