home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / bbs / srtdsc28.zip / SORTDESC.DOC < prev    next >
Text File  |  1994-01-02  |  17KB  |  353 lines
  1.                                    SORTDESC
  2.                        SHAREWARE (C) 1993 Vince Sorensen
  3.                               All Rights Reserved
  4.  
  5.  
  6.                     Registration - Individual Users $25.00
  7.                                    Commercial Users $CALL
  8.  
  9.  
  10.                                    Send to:
  11.                                 Vince Sorensen
  12.                                 6 Armstrong Bay
  13.                              Regina, Sask. Canada
  14.                                     S4N 4G7
  15.  
  16.                        BBS 306-789-8682 or 306-789-8690
  17.                               Voice 306-789-4654
  18.  
  19.  
  20.  
  21. ┌─────────────────────────────────────────────────────────────────────────────┐
  22. │                                WHO WANTS IT?                                │
  23. └─────────────────────────────────────────────────────────────────────────────┘
  24.  
  25.    For BBS operators, CD-ROM publishers, or anyone who wants to have
  26. their files sorted automatically into directories using information in
  27. those files descriptions. The source of file descriptions can be
  28. either the industry standard FILE_ID.DIZ within an archive, a text
  29. file with many file descriptions (for example, a captured on-line
  30. or BBS session), or a README file within an archive.
  31.    Options include adding a copy of the description into the archive
  32. if it doesn't already contain a FILE_ID.DIZ, adding a standard text
  33. file to each archive, search for descriptions with or without having
  34. to match the extension (I.E. you downloaded a ZIP file and converted
  35. it to ARJ... the captured BBS listing still says ZIP), remove extended
  36. characters or other phrases from the description (I.E. no more
  37. ░'s in the description).
  38.  
  39.  
  40. The basic operation of SORTDESC:
  41.  
  42.    Checks a directory for files. For all files found, it checks
  43. to see if they contain a FILE_ID.DIZ. If so, it adds the description
  44. to a text file, in PCBoard format. If not, it checks a text file
  45. (or text files) that contain PCBoard format descriptions (which
  46. may have been captured from a download session, or are from a
  47. CD-ROM/BBS file listing). If a description is found there, it
  48. is added to the description text file, with an updated size field.
  49. If not, a description of "No Description Found" is added to the
  50. description text file, again in PCBoard format. All additions to
  51. the description text file are dated with tomorrow's date.
  52.    Optionally, you can add the description that was found, plus
  53. a small message to the archive.
  54.  
  55.  
  56. Requirements:
  57.    If handling .ARJ files, you need ARJ.EXE. If handling .ZIP files,
  58. you need PKUNZIP.EXE. If handling .LZH programs, you need LHA.EXE.
  59. If handling .SDN files, you need PAK.EXE. Please note that for archives
  60. with ARJ or SDN secured envelopes the archiver programs do not allow you
  61. to alter the archive itself, and SORTDESC does not attempt to get around
  62. their limitation.
  63.  
  64.  
  65. ┌─────────────────────────────────────────────────────────────────────────────┐
  66. │                             COMMAND LINE OPTIONS                            │
  67. └─────────────────────────────────────────────────────────────────────────────┘
  68.  
  69. SORTDESC /S         - run program interactively (see below) or set-up
  70.                       the "re-direction" keywords.
  71.  
  72.  
  73. SORTDESC            - run program in batch mode; SORTDESC.INI
  74.                       contains the options
  75.  
  76. SORTDESC I=path     - run program in batch mode; SORTDESC.INI
  77.                       contains the options and is located in the
  78.                       specified directory (without a trailing \
  79.                       unless you're specifying the root directory).
  80.                       Do not specify the name.
  81.  
  82. SORTDESC I=path [!option1=param1] [!option2=param2] [!option3=param3]...
  83.                     - run program in batch mode; SORTDESC.INI contains
  84.                       the options and is located in the directory specified
  85.                       by the I= parameter (without a trailing \ unless
  86.                       you're specifying the root directory). !option?
  87.                       should be one of the valid commands shown below,
  88.                       and param? should be one of the valid settings.
  89.                       Any of the commands shown below that may include
  90.                       a space in the parameter may not be used, nor
  91.                       may this syntax be combined with the /S switch.
  92.                       The I=path parameter must be first.
  93.  
  94.                       Example of a valid usage:
  95.                          SORTDESC I=C:\SD !D=C:\PCB\UPLOAD !NODIZ=YES !LIMITS=5
  96.                       This would use the options specified in
  97.                       C:\SD\SORTDESC.INI, EXCEPT the directory to be
  98.                       searched would be C:\PCB\UPLOAD, and it would skip
  99.                       checking for enclosed FILE_ID.DIZ's.
  100.  
  101.                       Example of what not to do:
  102.                          SORTDESC I=C:\SD !TAGLINE=MyBBSis#1
  103.                                              ^ Invalid option
  104.  
  105.  
  106.   ** DON'T FORGET TO SET UP YOUR SORTDESC.INI FILE BEFORE USING BATCH MODE **
  107.  
  108.  
  109. ┌─────────────────────────────────────────────────────────────────────────────┐
  110. │                            REGISTERED USERS ONLY                            │
  111. └─────────────────────────────────────────────────────────────────────────────┘
  112.  
  113.     The trial version provides batch style operation and the ability to set-up
  114. set-up your "Smart Key Words".
  115.     The registered version allows the user to process files and/or set-up
  116. their configuration files interactively as well as the standard functions
  117. available in the trial version.
  118.  
  119.   ────────────────────────────────SAMPLE────────────────────────────────────
  120.              PCBMPORT.INI Configuration  (*Registered Version Only*)
  121.  
  122.   Directory to Process...:
  123.   Text Files(s) to Search:
  124.   Default Output Listing.:
  125.   Smart Directory Redir'n:  NO       YES (ON) / NO (OFF)
  126.   Recheck Files w/o Desc.:  NO       YES (ON) / NO (OFF)
  127.   Skip Check for FILE_ID.:           YES (ON) / NO (OFF)
  128.   Check for README.......:           YES (ON) / NO (OFF)
  129.   Limit Desc Length to...:    0 Lines
  130.  
  131.  
  132.   Filter Graphic Char's..:           ON (YES) / OFF (NO)
  133.       Retain Beta Char  .:           YES (ON) / NO (OFF)
  134.       Filter User-Specify:
  135.       Add Tag Line.......:
  136.   Date in File Descript'n:           TODAY + 1 / REAL (Actual File Date)
  137.   Ignore File Extensions.:           YES (ON) / NO (OFF)
  138.   Add FILE_NFO.DIZ.......:           YES (ON) / NO (OFF)
  139.       Add Tag Line Here..:
  140.       File name to use...:  FILE_NFO.DIZ
  141.   Add Text/Advert File...:
  142.   Rename file w/ISO9660..:           YES (ON) / NO (OFF)
  143.   ────────────────────────────────******────────────────────────────────────
  144.  
  145.  
  146.  
  147.  
  148. ┌─────────────────────────────────────────────────────────────────────────────┐
  149. │                SORTDESC.INI can contain the following lines:                │
  150. └─────────────────────────────────────────────────────────────────────────────┘
  151.  Notes - Any that are indicated as OPTIONAL are not necessary... the program
  152.          will work as if they were in the INI file and set to their defaults).
  153.        - Options are shown in order of expected frequency of use. They do not
  154.          have to be in this order in the SORTDESC.INI file.
  155.  ─────────────────────────────────────────────────────────────────────────────
  156.  
  157.                             ┌────────────────────┐
  158.                             │   BASIC COMMANDS   │
  159.                             └────────────────────┘
  160.  
  161. D=Directory      Directory to Search
  162.  
  163. I=Import_File    File to search for descriptions for files without FILE_ID.DIZ
  164.  
  165. E=Export_File    File to place found descriptions in (unless redirected)
  166.  
  167. S=Smart_On_Off   SMART REDIRECTION (ON or OFF)
  168.                  Whether or not to redirect the files and descriptions according
  169.                  to keywords found in the descriptions
  170.  
  171. R=ON             RECHECK (ON or OFF)
  172.                  Whether or not to try to find descriptions for files that
  173.                  already exist in the listing being exported to (default
  174.                  export file only)
  175.  
  176. SKIPEXT=NO       Yes or no; when searching for descriptions, ignore if the
  177.                  extensions don't match (In other words, if this is set to
  178.                  Yes, the program being looked for is EGG.ZIP and the
  179.                  description found is for EGG.ARJ, the description WILL be
  180.                  used).  Default is NO.                   (OPTIONAL)
  181.  
  182. NODIZ=NO         Yes or no; Skip checking for FILE_ID.DIZ; Default is No.
  183.  
  184. DATE=REAL        Use actual file date rather than tomorrow's date when adding
  185.                  file descriptions to a text file.
  186.                  Default is TODAY+1, not REAL.            (OPTIONAL)
  187.  
  188. README=NO        Yes or no; If SORTDESC can't find either a FILE_ID.DIZ or
  189.                  a description in the specified text file(s), and you include
  190.                  the line README=YES, SORTDESC will try to find any file
  191.                  in the archive called DESC.SDI, README., READ.ME, README.1ST,
  192.                  or FILENAME.DOC (where Filename is the name of the archive
  193.                  being examined, without an extension). If any of these are
  194.                  found, SORTDESC will try to extract a description. If you
  195.                  use this option, it is HIGHLY recommended that you set a
  196.                  LIMIT. Default is NO.                    (OPTIONAL)
  197.  
  198. TIC=NO           YES, NO, or REMOVE; If SORTDESC can't find a FILE_ID.DIZ, then
  199.                  attempt to use any TIC files that exist in the same directory.
  200.                  YES simply checks the TIC files; REMOVE removes the TIC files
  201.                  after checking them, whether they are used or not.
  202.                  If TIC files have been included in the I= command,
  203.                  (I.E.  I=*.TIC  or  I=*.TXT when REN *.TIC *.TXT has been run)
  204.                  they will be included no matter what this is set to, but
  205.                  the TIC Area will be ignored.
  206.                  Default is NO.                           (OPTIONAL)
  207.  
  208. ONLYMOVE=DESC    DESC, FILE or N/A; SORTDESC will optionally only redirect
  209.                  descriptions, and leave files where they are, or vice versa.
  210.                  Default is N/A.                          (OPTIONAL)
  211.  
  212.  
  213.                             ┌────────────────────┐
  214.                             │ ADDING TO ARCHIVES │
  215.                             └────────────────────┘
  216.  
  217. DIZ=NO           Yes or no; Create FILE_ID.DIZ from description found in
  218.                  text file, and add to archive? (Also see TAGDIZ, TAGLINE
  219.                  and NFO below)
  220.                  Default is NO.                           (OPTIONAL)
  221.  
  222. TAGDIZ=Add_line  A line to add to the newly created FILE_ID.DIZ (does not
  223.                  apply to files already contain a FILE_ID.DIZ).
  224.                                                           (OPTIONAL)
  225.  
  226. TAGLINE=Add_line A line to add to the description that was found (only adds
  227.                  to new FILE_ID.DIZs, and the created description text file,
  228.                  does not change files that already contain a FILE_ID.DIZ).
  229.                                                           (OPTIONAL)
  230.  
  231. NFO=FileName     What to call the file that will be added to archives not
  232.                  containing a FILE_ID.DIZ. Defaults to FILE_NFO.DIZ.
  233.                  See the discussion below.
  234.                                                           (OPTIONAL)
  235.  
  236. MSG=Add_Msg.txt  A text file to add to the archive        (OPTIONAL)
  237.  
  238. GIF=ZIP          If file is a GIF, and not an archive, but you would still
  239.                  like to attach a FILE_ID.DIZ, add this line. The GIF will
  240.                  be placed in a ZIP file of the same name. You can also
  241.                  specify ARJ and LHA. (You must also set DIZ=YES for this
  242.                  to work). If this line is not included, or one
  243.                  of those three options are not taken, the GIF will be
  244.                  untouched, and no FILE_ID.DIZ will be attached.
  245.                                                           (OPTIONAL)
  246.  
  247.  
  248.                             ┌────────────────────┐
  249.                             │ FILTERS AND LIMITS │
  250.                             └────────────────────┘
  251.  
  252. LIMIT=###        The maximum lines to use for any file's description.
  253.                  Any number ranging from 1 TO 255; use LIMIT=0 or leave this
  254.                  line out entirely for no maximum limit on the number of lines.
  255.                                                           (OPTIONAL)
  256.  
  257. FILTER=ON        On or Off; Remove certain graphic characters and character
  258.                  combinations that contain no useful information.
  259.                  Default is ON                            (OPTIONAL)
  260.  
  261. BETA=OFF         On or Off; If ON, removes character 225 (ß) when filtering
  262.                  graphics characters. If OFF, skips filtering "ß" character.
  263.                  Default is OFF                           (OPTIONAL)
  264.  
  265. GONE=~STRING1~STRING2~STRING3~ETC~
  266.                  Specify extra character combinations that will be removed
  267.                  during filtering (if filtering not turned OFF). Separate
  268.                  each string with the ~ symbol; up to 80 characters total
  269.                  are allowed. Example: GONE=~GREAT~I LIKED IT~(NEW)~ will
  270.                  remove any occurance of the word "Great", the phrase
  271.                  "I Liked it", and the word "(NEW)".      (OPTIONAL)
  272.  
  273. ISO=9660         9660 or blank; If 9660, ensures that file names comply
  274.                  with the ISO9660 standard by changing !@#$%- characters
  275.                  to underscores. Default is blank.        (OPTIONAL)
  276.  
  277. SKIPNF=YES       Yes or no; Skip adding "Description Not Found" to the
  278.                  target description file if a description isn't found.
  279.                  Defaults to NO.                          (OPTIONAL)
  280.  
  281.  
  282.  
  283.  
  284.                             ┌────────────────────┐
  285.                             │   OTHER COMMANDS   │
  286.                             └────────────────────┘
  287.  
  288.                  The following commands determine the order in which
  289.                  items are checked for...
  290.  
  291. FIRST=DIZ        DIZ, DEScription, REAdme, OR TIC.
  292.                  Defaults to DIZ.                         (OPTIONAL)
  293.  
  294. SECOND=DES       DIZ, DEScription, REAdme, OR TIC.
  295.                  Defaults to DES.                         (OPTIONAL)
  296.  
  297. THIRD=REA        DIZ, DEScription, REAdme, OR TIC.
  298.                  Defaults to REA.                         (OPTIONAL)
  299.  
  300.  
  301.  
  302. For example, your SORTDESC.INI may look like this:
  303.  
  304. D=c:\pcb\upload
  305. I=c:\text\capture.cap
  306. E=c:\pcb\main\private.
  307. S=ON
  308. R=OFF
  309. DIZ=NO
  310. LIMIT=20
  311.  
  312.  
  313.  
  314. ┌─────────────────────────────────────────────────────────────────────────────┐
  315. │                   Interactive Version: Keyboard Navigation                  │
  316. └─────────────────────────────────────────────────────────────────────────────┘
  317.  
  318.    ESC         - Previous field or screen; cancel entry
  319.    ENTER       - Accept and move to next field or as otherwise indicated
  320.                  on-screen; On menu screens, execute highlighted function.
  321.    F5          - Bring up table to lookup information (where applicable)
  322.    ARROW DOWN  - Highlight next entry
  323.    ARROW UP    - Highlight previous entry
  324.  
  325.  
  326. ┌─────────────────────────────────────────────────────────────────────────────┐
  327. │         Why is the file thats added called FILE_NFO.DIZ by default?         │
  328. └─────────────────────────────────────────────────────────────────────────────┘
  329.  
  330.    The industry standard for file descriptions stored in an archive is
  331.    to call them FILE_ID.DIZ. The length of each line should not exceed
  332.    46 characters. This program is designed to correct certain FILE_ID.DIZs
  333.    that do not conform to this standard width.
  334.  
  335.    There is a reason why the name of the file SORTDESC adds by default
  336.    is FILE_NFO.DIZ and *not* FILE_ID.DIZ:  Since many BBSs receive
  337.    descriptions along the lines of "Gee - Great Program", it may not be
  338.    ideal to add an "official" FILE_ID.DIZ to an archive, as it does not
  339.    really conform to the FILE_ID.DIZ standard. Having a unique name helps
  340.    the end-user differentiate between an author's description and an
  341.    uploader's description. Since the author of SORTDESC is one of those
  342.    who must suffer through those odd descriptions, SORTDESC was originally
  343.    set up to default this way :)
  344.  
  345.    Other programs may require that you use the "official" FILE_ID.DIZ
  346.    filename and format. If the source of your files has properly described
  347.    described them, and you find that that the benefit outweighs the risk,
  348.    then by all means use the NFO= switch that will make SORTDESC use
  349.    FILE_ID.DIZ as the filename.
  350.  
  351.  
  352.  
  353.