home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / pcboard / addpcb21.zip / ADDPCB.DOC next >
Text File  |  1992-12-10  |  23KB  |  622 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.         ███████┐ ████████┐ ████████┐ ███████┐ ███████┐ ████████┐
  8.         ██┌──██│ └██┌──██│ └██┌──██│ ██┌──██│ ██┌────┘ └██┌──██│
  9.         ███████│  ██│  ██│  ██│  ██│ ███████│ ██│       ███████│
  10.         ██┌──██│  ██│  ██│  ██│  ██│ ██┌────┘ ██│       ██┌──██│
  11.         ██│  ██│ ████████│ ████████│ ██│      ███████┐ ████████│
  12.         └─┘  └─┘ └───────┘ └───────┘ └─┘      └──────┘ └───────┘
  13.  
  14.  
  15.  
  16.  
  17.                  ADDPCB Version 2.1
  18.                  December 10, 1992
  19.  
  20.                  For PCBoard Systems
  21.  
  22.  
  23.  
  24.  
  25.  
  26.             Latest Versions and Support
  27.                  Available at the
  28.  
  29.                 OnLine Exchange BBS
  30.                   (714) 870-4614
  31.                2400-14,400 Baud V.32bis/HST
  32.  
  33.  
  34.  
  35.  
  36.  
  37.      Are you tired of typing in the descriptions  every time  you add files
  38.      to your board?  With this program, typing in descriptions by hand will
  39.      be over.
  40.  
  41.      This time-saving program  aids the PCB Sysop by  importing files  with
  42.      their descriptions downloaded from other PCBoard BBS's to your PCBoard
  43.      BBS automatically.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.          Copyright (C) 1992 by Bob Aune - All Rights Reserved.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                 Table of Contents
  61.                 ─────────────────
  62.  
  63.  
  64.        What is ADDPCB . . . . . . . . . . . . . . . . . . . . . . . . . 1
  65.  
  66.        Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  67.  
  68.        Possible Uses  . . . . . . . . . . . . . . . . . . . . . . . . . 3
  69.  
  70.        Installation . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  71.  
  72.        Starting ADDPCB  . . . . . . . . . . . . . . . . . . . . . . . . 5
  73.  
  74.        Command Line Options . . . . . . . . . . . . . . . . . . . . . . 6
  75.  
  76.        Operating ADDPCB . . . . . . . . . . . . . . . . . . . . . . . . 7
  77.  
  78.        Configuration (Fields) . . . . . . . . . . . . . . . . . . . . . 7
  79.  
  80.        Configuration (Options)  . . . . . . . . . . . . . . . . . . . . 9
  81.  
  82.        External Testing . . . . . . . . . . . . . . . . . . . . . . . .11
  83.  
  84.        FILE_ID.DIZ Support  . . . . . . . . . . . . . . . . . . . . . .11
  85.  
  86.        Support  . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
  87.  
  88.        Registration Information . . . . . . . . . . . . . . . . . . . .13
  89.  
  90.        Legal Stuff  . . . . . . . . . . . . . . . . . . . . . . . . . .14
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.      ADDPCB User Documentation                                       Page 1
  100.      ──────────────────────────────────────────────────────────────────────
  101.  
  102.  
  103.  
  104.      WHAT IS ADDPCB
  105.      ──────────────
  106.  
  107.      ADDPCB is a program that import files with  their descriptions to your
  108.      board painlessly. ADDPCB works off of 4 fields in the configuration as
  109.      shown on the main screen.  They are:
  110.  
  111.       / FILE                  - Contains descriptions       (field 1)
  112.      FROM
  113.       \ DIRECTORY             - Contains files              (field 2)
  114.  
  115.       / FILE                  - Descriptions imported to    (field 3)
  116.       TO
  117.       \ DIRECTORY             - Files imported to           (field 4)
  118.  
  119.      ADDPCB  looks for files  in the directory (field 2),  it might be your
  120.      download dir., misc. dir., or directory of  files  to be tested.  Next
  121.      it will search for the descriptions in a text file (field 1), The text
  122.      file could be a 'allfiles' list or a capture file.  If the description
  123.      is found, then the program will optionally test the file by calling an
  124.      external batch file and if the file passes the test, then will process
  125.      the description and the file into your system.
  126.  
  127.      This program can be run from a batch file or on the command line. It's
  128.      a ideal program to use after a download session  as it will import the
  129.      new files into your PCBoard system along with their descriptions.  The
  130.      automatic feature enables it to run in the unattended mode  such as in
  131.      events and with unattended communication programs.
  132.  
  133.  
  134.  
  135.      ADDPCB User Documentation                                       Page 2
  136.      ──────────────────────────────────────────────────────────────────────
  137.  
  138.  
  139.  
  140.      FEATURES
  141.      ────────
  142.  
  143.      *  Complete user interface with a built in configuration editor.
  144.  
  145.      *  Several configuration files can exist for importing files to
  146.     different conferences or directories.
  147.  
  148.      *  Can test whole directories of files without moving their location
  149.     or effecting the descriptions.
  150.  
  151.      *  Can be used in your event, comm program batch file, or on the
  152.     command line.
  153.  
  154.      *  Imports description from any ZIP archive containg FILE_ID.DIZ.
  155.  
  156.      *  Duplicate description and file detection with options.
  157.  
  158.      *  Optional test each file as it is imported to your board.
  159.  
  160.      *  Description Modification Options such as:
  161.     * First letter capitalized.
  162.     * All letters upper case.
  163.     * All letters lower case.
  164.     * Add 'Uploaded by (your name)' to the bottom of the description.
  165.  
  166.      *  Option to re-date the file and the date in the description to 
  167.     today's date.
  168.  
  169.      *  Can be used under a network or multitasker.
  170.  
  171.  
  172.  
  173.      ADDPCB User Documentation                                       Page 3
  174.      ──────────────────────────────────────────────────────────────────────
  175.  
  176.  
  177.  
  178.      POSSIBLE USES
  179.      ─────────────
  180.  
  181.      Import files from another PCBoard BBS to your BBS.
  182.      ┌────────────────────────────────────────────────────────────────────┐
  183.      │ 1) Call your favorite BBS.                                         │
  184.      │ 2) Turn your Communication program CAPTURE on.                     │
  185.      │ 3) Do a (Z)ippy search or search (N)ew files and the descriptions  │
  186.      │    will be captured to the capture file.                           │
  187.      │ 4) Download the files.                                             │
  188.      │ 5) Run ADDPCB.                                                     │
  189.      └────────────────────────────────────────────────────────────────────┘
  190.  
  191.  
  192.      Files placed in a hold/misc. directory for missing descriptions.
  193.      ┌────────────────────────────────────────────────────────────────────┐
  194.      │ 1) Download the ALLFILES list from a few boards.                   │
  195.      │ 2) Run ADDPCB.                                                     │
  196.      │ 3) Watch how many of the descriptions can be located.              │
  197.      │ 4) If still have files without descriptions, then get another      │
  198.      │    list and run ADDPCB again.                                      │
  199.      └────────────────────────────────────────────────────────────────────┘
  200.  
  201.  
  202.      Files on the board already but needs testing only.
  203.      ┌────────────────────────────────────────────────────────────────────┐
  204.      │ 1) Use your board's file listing.                                  │
  205.      │ 2) Change field 4 to the same as field 2.  This will then not move │
  206.      │    the files.                                                      │
  207.      │ 3) Change field 3 to the same as field 1 and go into 'OPTIONS' and │
  208.      │    set 'KEEP THE ORIGINAL DESCRIPTIONS' to (Y)es.                  │
  209.      │ 4) Run ADDPCB.                                                     │
  210.      └────────────────────────────────────────────────────────────────────┘
  211.  
  212.  
  213.  
  214.      ADDPCB User Documentation                                       Page 4
  215.      ──────────────────────────────────────────────────────────────────────
  216.  
  217.  
  218.  
  219.      Files on the board already with thier descriptions but if the file 
  220.      contains a FILE_ID.DIZ file and you would rather have the description
  221.      from the FILE_ID.DIZ file replace the description on the board.
  222.      ┌────────────────────────────────────────────────────────────────────┐
  223.      │ 1) Change field 4 to the same as field 2.  This will then not move │
  224.      │    the files.                                                      │
  225.      │ 2) Go into 'OPTIONS' and change 'SEARCH FOR FILE_ID.DIZ files' to  │
  226.      │    (Y)es and set 'OVERWRITE' to (Y)es which will overwrite the old │
  227.      │    description with the one from FILE_ID.DIZ.                      │
  228.      │ 3) Run ADDPCB.                                                     │
  229.      └────────────────────────────────────────────────────────────────────┘
  230.  
  231.  
  232.      Files on the board already but you would like an easy way to convert
  233.      the description to your likeing.
  234.      ┌────────────────────────────────────────────────────────────────────┐
  235.      │ 1) Use your board's file listing.                                  │
  236.      │ 2) Change field 4 to the same as field 2.  This will then not move │
  237.      │    the files.                                                      │
  238.      │ 3) Change field 3 to the same as field 1 and go into 'OPTIONS' and │
  239.      │    set 'OVERWRITE THE ORIGINAL DESCRIPTION' to (Y)es.              │
  240.      │ 4) Change one or more of the 'DESCRIPTION MODIFICATION OPTIONS'.   │
  241.      │ 5) Run ADDPCB.                                                     │
  242.      └────────────────────────────────────────────────────────────────────┘
  243.  
  244.  
  245.  
  246.      ADDPCB User Documentation                                       Page 5
  247.      ──────────────────────────────────────────────────────────────────────
  248.      
  249.  
  250.      INSTALLATION
  251.      ────────────
  252.  
  253.      The installation is very easy.  Put the file ADDPCB.EXE in a directory
  254.      of your choice.  Preferably your  utility directory  or a directory in
  255.      your path.  The configuration file  will be created the first time you
  256.      run the program.
  257.  
  258.  
  259.      STARTING ADDPCB
  260.      ──────────────-
  261.  
  262.      Type ADDPCB and the name of the configuration file you wish to use. If
  263.      the configuration file  does'nt exist, then one  will be created.  The
  264.      name of the configuration file(s) can be any name you choose.
  265.  
  266.      Examples:
  267.  
  268.      ADDPCB ADDPCB.CFG
  269.      ADDPCB CONF0.CFG
  270.      ADDPCB CONF1.CFG
  271.      ADDPCB IMPORT.CN0
  272.      ADDPCB IMPORT.CN1
  273.  
  274.      The configuration file  is placed in the same directory  that contains
  275.      ADDPCB.EXE regardless of the directory you called the program from. If
  276.      you do not wish to have the configuration file  in the same directory,
  277.      then you must specify the full path\name  of the configuration file on
  278.      the command line or in a batch file.
  279.  
  280.      EXAMPLE:  ADDPCB C:\PCB\UTILS\ADDPCB.CFG
  281.  
  282.  
  283.  
  284.      ADDPCB User Documentation                                       Page 6
  285.      ──────────────────────────────────────────────────────────────────────
  286.  
  287.  
  288.  
  289.      COMMAND LINE OPTIONS
  290.      ────────────────────
  291.  
  292.      ADDPCB has 3 switches that can be used.  These switches  are optional.
  293.      The command format and switch parameters are described below.  A quick
  294.      review of the command switches is available by typing ADDPCB.
  295.  
  296.      Automatic mode
  297.      /A or /a       Used for unattended operation.   The configuration file
  298.             you specified must exist and the fields must be correct
  299.             else the /A option will not function.
  300.             Put ADDPCB CONFIG.CFG /A in your batch file and it will
  301.             run without operator intervention.
  302.  
  303.      Registering your copy
  304.      /R or /r       Used for registering  your copy of ADDPCB.  Once it has
  305.             been registered, you will  receive a  key number.  Type
  306.             ADDPCB /R  and you will  be prompted  for your name and
  307.             number. The program will brand your copy of ADDPCB.EXE.
  308.             If you are registered and upgrading  to a later version
  309.             of ADDPCB, then you must use this switch using the same
  310.             number.
  311.  
  312.      Monochrome mode on a color monitor
  313.      /M or /m       Not that you will ever want to use this feature, but it
  314.             is there.
  315.  
  316.      Examples:
  317.  
  318.      ADDPCB IMPORT.CN0  /A
  319.      ADDPCB IMPORT.CN1  /AM
  320.      ADDPCB /R
  321.      ADDPCB ADDPCB.CFG /RM
  322.      ADDPCB CONF0.CFG
  323.      ADDPCB CONF1.CFG
  324.  
  325.  
  326.  
  327.      ADDPCB User Documentation                                       Page 7
  328.      ──────────────────────────────────────────────────────────────────────
  329.  
  330.  
  331.  
  332.      OPERATING ADDPCB
  333.      ────────────────
  334.  
  335.      The program is straight foward and should be self expanatory. Although
  336.      I'm making every attempt  to explain the program and its features.  If
  337.      you hav'nt already ran the program, now might  be a good time to do so
  338.      and get a feel for the program.  At the bottom of the screen there are
  339.      four selection items.  They are  'Exit', 'Edit Fields', 'Options', and
  340.      'Start Process'.  Before the  'Start Process'  can be selected, all of
  341.      the 'Fields' must contain valid path/names  and the files or directory
  342.      must exist (except the last one 'External Test' which is optional').
  343.      If any of the to fields (fields 3 and 4)  does'nt exist, then you will
  344.      be be asked if you would like the directory or file created for you.
  345.  
  346.  
  347.      CONFIGURATION (FIELDS)
  348.      ──────────────────────
  349.  
  350.      NOTE:
  351.      If a field is flashing, that is indicating  that the  path/name of the
  352.      file or the directory is not valid or does not exist.
  353.  
  354.  
  355.      DESCRIPTION FILE TO BE SEARCHED:                 C:\DL\ALLFILES.LST
  356.  
  357.      This is the path/name  of the description file.  It can  be a ALLFILES
  358.      list or a CAPTURE list or a DIRxx listing from your own board.
  359.  
  360.  
  361.      DIRECTORY OF FILES TO BE PROCESSED:              C:\DOWNLOAD
  362.  
  363.      This may be  the directory that is holding  your downloaded files or a
  364.      directory holding misc. files  without descriptions  or a directory of
  365.      files you want to test.
  366.  
  367.  
  368.  
  369.      ADDPCB User Documentation                                       Page 8
  370.      ──────────────────────────────────────────────────────────────────────
  371.      
  372.     
  373.      
  374.      DESCRIPTION FILE YOU WANT TO UPDATE:             C:\PCB\MAIN\UPDIR
  375.  
  376.      This is the  path/name  of the destination file that  new descriptions
  377.      are written to.  If the path\name of the file does not exist, then you
  378.      will be asked if you want the file created for you.
  379.  
  380.  
  381.      DIRECTORY WHERE THE FILES GET MOVED TO:         C:\UPDIR
  382.  
  383.      This is the directory  that the files gets moved into.  If you  do not
  384.      wish to have the files moved, then enter the same directory as field 2
  385.      If the path\name of the directory does'nt exist then you will be asked
  386.      if you want the directory created for you.
  387.  
  388.  
  389.      EXTERNAL TEST PROGRAM:                           C:\PCB\UTIL\TEST.BAT
  390.  
  391.      Put in the path/name  of the batch file calling your test program.  If
  392.      you don't want to test the files as they are imported, then leave this
  393.      field blank.
  394.  
  395.      After the last field  has been entered, then you will be taken back to
  396.      the main choices.  Press the <left> or <right> arrow key to select and
  397.      press the <ENTER> key.
  398.  
  399.  
  400.  
  401.      ADDPCB User Documentation                                       Page 9
  402.      ──────────────────────────────────────────────────────────────────────
  403.  
  404.  
  405.  
  406.      CONFIGURATION (OPTIONS)
  407.      ───────────────────────
  408.  
  409.      CAPITALIZE THE FIRST LETTER:
  410.  
  411.      Although most descriptions will have the first letter capitalize.
  412.      There might be times  when it's not and this feature will correect it.
  413.      This feature can also be used if the description  is in all upper case
  414.      and you use the option to convert to all lower case and this option to
  415.      capitalize the first letter.
  416.  
  417.  
  418.      ALL LETERS UPPER CASE:
  419.  
  420.      Convert the description imported to all upper case.
  421.  
  422.  
  423.      ALL LETTERS LOWER CASE:
  424.  
  425.      Convert the description imported to all lower case.
  426.  
  427.  
  428.      UPLOADED BY:
  429.  
  430.      Choose (Y)es and you'll be prompted for your name or 'Sysop' then when
  431.      the description is imported it will contain  'Uploaded by (your name)'
  432.      on the last line of the description.
  433.  
  434.      
  435.      SET FILE DATE TO TODAY'S DATE:
  436.  
  437.      Setting this option to (Y)es will change the file date to today's date
  438.      and will change the date in the description to today's date.
  439.  
  440.  
  441.  
  442.      ADDPCB User Documentation                                      Page 10
  443.      ──────────────────────────────────────────────────────────────────────
  444.      
  445.      
  446.  
  447.      NOTE:
  448.      These next 3 options work together  and only one of them can be set to
  449.      (Y)es at a time.
  450.  
  451.      PROMPT IF DUPLICATE IS DETECTED:
  452.  
  453.      If this option is set to (Y)es  and a duplicate description  is found,
  454.      then you will be asked if you want to keep the one thats already there
  455.      or to use the new one  or to keep both.  If a duplicate file is found,
  456.      then you have the choice of keeping the one that's already there or to
  457.      overwrite with the new file.  If you have this option set to (Y)es and
  458.      are running in the unattended mode, then any duplicate descriptions or
  459.      files found will be kept  and the new file  will not be moved and will
  460.      remain where it was before.
  461.  
  462.  
  463.      DON'T PROMPT - OVERWRITE:
  464.  
  465.      This option  can be used  in either the unattended  or in the attended
  466.      mode. If a duplicate description is detected, then the new description
  467.      will be appended to bottom of the description file specified in  field
  468.      3  and the description that was there before will be deleted.  The new
  469.      file will overwrite the one that was their before.
  470.  
  471.  
  472.      DON'T PROMPT - KEEP:
  473.  
  474.      This option  can be used  in either the unattended  or in the attended
  475.      mode.  If a duplicate description is detected, then the  original will
  476.      stay and the new one  will not be added.  The original file  will also
  477.      stay and the new file will remain where it was before.
  478.  
  479.  
  480.      SEARCH FOR FILE_ID.DIZ FILES:
  481.  
  482.      This option when set to (Y)es  will ignore any file specified in field
  483.      1 and will search an attire directory for any  .ZIP files containing a
  484.      FILE_ID.DIZ file and if found will import the .ZIP.   When this option
  485.      is selected, field 1 has no effect and can be blank.
  486.  
  487.      
  488.      ADDPCB User Documentation                                      Page 11
  489.      ──────────────────────────────────────────────────────────────────────
  490.  
  491.  
  492.  
  493.      EXTERNAL TESTING
  494.      ───────────────-
  495.  
  496.      If you chose to have ADDPCB test the files, then you must  specify the
  497.      name of your batch file in the field 'EXTERNAL TEST PROGRAM'.
  498.  
  499.      Your  upload tester MUST be configured  to move any failed files  to a
  500.      reject/offline/bad/hold  directory.  This will insure that ADDPCB will
  501.      detect any failed files.  If ADDPCB  sees that a file failed, then all
  502.      furture processing  of that file will end  and ADDPCB  will move on to
  503.      the next file.   The description will not be added.   If a file passed
  504.      the testing, then the description and file will be processed in.
  505.  
  506.  
  507.      FILE_ID.DIZ SUPPORT
  508.      ──────────────────-
  509.  
  510.      ADDPCB will detect any .ZIP  archive containing the  FILE_ID.DIZ  file
  511.      and will get the description from the FILE_ID.DIZ file to import. This
  512.      feature depends on a copy of PKUNZIP.EXE being in the path.
  513.  
  514.  
  515.  
  516.      ADDPCB User Documentation                                      Page 12
  517.      ──────────────────────────────────────────────────────────────────────
  518.  
  519.  
  520.  
  521.      Support
  522.      ──────-
  523.  
  524.      Comments and suggestions about ADDPCB  are welcomed.  Please notify me
  525.      if you discover a bug, so that it can be prompty corrected.
  526.  
  527.      OnLine Exchange at (714) 870-4614.  <<< Home of ADDPCB
  528.  
  529.      I can alse be reached on: RIME      - Sysops Conf.   Bob Aune
  530.                    Ilink     - Sysops Conf.    "   "
  531.                    Metrolink - PCBHints Conf.  "   "
  532.  
  533.  
  534.  
  535.      ADDPCB User Documentation                                      Page 13
  536.      ──────────────────────────────────────────────────────────────────────
  537.  
  538.  
  539.  
  540.      Registering ADDPCB
  541.      ──────────────────
  542.  
  543.      This program is distributed as SHAREWARE.  This enables users to eval-
  544.      uate software for a 30 day  trial period.  If you  find  this  program
  545.      useful, please register it.  Otherwise, if the user finds this program
  546.      is not of sufficient merit to warrant  purchase  through  registration
  547.      then the program must be removed from their computer.
  548.  
  549.      This concept enables quality software  to be distributed  at a reason-
  550.      able cost.  I do greatly appreciate all users that care enough to reg-
  551.      ister.  I try to provide the best possible software for the supporting
  552.      users.
  553.  
  554.      You may register ADDPCB by mailing in the enclosed REGISTER.FRM  along
  555.      with a check or money order in the amount of $10.00.
  556.  
  557.      
  558.      Send registration to:
  559.  
  560.      Bob Aune
  561.      2404 E. Nutwood Ave.
  562.      Fullerton, CA. 92631
  563.  
  564.  
  565.      The registration charge is a one time fee that entitles you to:
  566.  
  567.      * All future versions.
  568.      * Unlimited technical support.
  569.      * Access to the OnLine Exchange BBS.
  570.      * Removal of the "Please Register" message.
  571.      * A personalized number via US Mail and on the support BBS.
  572.  
  573.      This program  may either be obtained  from normal Shareware sources or
  574.      from the OnLine Exchange BBS (714) 870-4614.
  575.  
  576.  
  577.  
  578.  
  579.      ADDPCB User Documentation                                      Page 14
  580.      ──────────────────────────────────────────────────────────────────────
  581.  
  582.  
  583.  
  584.      Legal Stuff
  585.      ───────────
  586.  
  587.      Disclaimer
  588.  
  589.      I hereby  disclaim  all warranties  relating  to this product, whether
  590.      express or implied including without limitation any implied warranties
  591.      of merchantability or fitness for a  particular purpose.  I cannot and
  592.      will not be liable for any special, incidental, consequential,indirect
  593.      or  similar damages  due to loss of data  or any  other reason.  In no
  594.      event  shall the liability for any damages ever exceed  the price paid
  595.      for the license to use software, regardless of the form  and/or extent
  596.      of the claim.  The  user  of this  program  bears  all  risk as to the
  597.      quality and performance of the software.
  598.  
  599.  
  600.      File Contents
  601.      ─────────────
  602.  
  603.      ADDPCB.DOC   - The Document that you're reading now.
  604.      ADDPCB.EXE   - The Program.
  605.      TEST.BAT     - Sample BATCH file to call your favorite upload tester.
  606.      FILE_ID.DIZ  - Description of this program. Used by PCBoard for adding
  607.             the authors version of the description to the board
  608.             automatically.
  609.      REGISTER.FRM - Mail-in registration form.
  610.  
  611.  
  612.      This archive has been zipped  using  PKWARE  authenticity verification
  613.      system.  If there are any files in this archive that  do not  have the
  614.      verification tag  beside them (-AV), it indicates that the archive has
  615.      been tampered with  and is not  in the  original form.  If this is the
  616.      case, please call the support BBS for a valid copy.
  617.  
  618.  
  619.      Bob Aune
  620.      The OnLine Exchange
  621.      (714) 870-4614 2400-14,400 Baud V.32bis/HST
  622.