home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / mail / detag100.zip / DETAG.DOC < prev    next >
Text File  |  1993-01-08  |  15KB  |  337 lines
  1.  
  2.  
  3.  
  4.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 1
  5.  
  6.  
  7.      DESCRIPTION
  8.      -----------
  9.      DETAG deletes and/or copies taglines from QWK message archives. DETAG
  10.      automatically determines the compression type, calls the appropriate
  11.      unarchiver to extract MESSAGES.DAT, and strips the taglines. If any
  12.      taglines were deleted, DETAG optionally makes a backup of the original
  13.      QWK file, then calls the appropriate archiver to replace the old
  14.      MESSAGES.DAT with the updated one. DETAG can handle wildcards, with an
  15.      optional Yes/No prompt before stripping each file.
  16.  
  17.  
  18.      REQUIREMENTS
  19.      ------------
  20.      DETAG runs under DOS 2.0 or better. DETAG also calls various file
  21.      archivers/unarchivers, depending on the compression type used on your
  22.      QWK message archives; DETAG can handle ZIP, ARJ, LZH, ARC/PAK, and ZOO
  23.      type archives. Note that you probably will not need to have every
  24.      archive/unarchive program listed in DETAG.CFG; it is quite likely that
  25.      you already have the ones that you need, since you are able to read
  26.      QWK message archives in the first place. If your archivers/unarchivers
  27.      are not in your path, or if you use programs other than those listed
  28.      in DETAG.CFG (like NoGate's PAK or SEA's ARC), then you will also need
  29.      an ASCII text editor to edit DETAG.CFG.
  30.  
  31.  
  32.      DISCLAIMER
  33.      ----------
  34.      DETAG is distributed on an "AS IS" basis without warranty, expressed
  35.      or implied. Considerable testing effort has been expended, but the
  36.      user is advised to check the program's suitability before relying on
  37.      it. The user assumes full risk as to the results of using this
  38.      program. In no event shall the author be liable for any incidental or
  39.      consequential damages arising from the use, or inability to use this
  40.      program.
  41.  
  42.  
  43.      REGISTRATION
  44.      ------------
  45.      The unregistered version of DETAG is freely distributable and fully
  46.      functional, and may be used for a 30-day trial period. If you plan to
  47.      continue using DETAG, you are obligated to pay the modest registration
  48.      fee of $15. Registered users will receive an individually serialized
  49.      nag-free version of DETAG, a free upgrade, and $5 subsequent upgrades.
  50.  
  51.      All registration information is contained in the DETAG.REG file. If
  52.      that file is missing, register by sending your name, address, and a
  53.      check or money order for $15 in US dollars to:
  54.  
  55.         Copy Con Incorporated
  56.         PO Box 23255
  57.         Baltimore MD 21203-5255
  58.  
  59.      Please specify 3.5" or 5.25" diskette. MD residents add 5% sales tax.
  60.      Thank you for supporting Shareware.
  61.  
  62.  
  63.  
  64.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 2
  65.  
  66.  
  67.      INSTALLATION
  68.      ------------
  69.      To install, copy both DETAG.EXE and DETAG.CFG into your path. If your
  70.      archivers/unarchivers are not in your path, or if you use programs
  71.      other than those listed in DETAG.CFG (like NoGate's PAK or SEA's ARC),
  72.      then you will need to edit DETAG.CFG with any ASCII text editor.
  73.  
  74.      DETAG.CFG contains the locations and command line options of your file
  75.      archivers/unarchivers. A typical line in DETAG.CFG would look like:
  76.  
  77.         LZH = C:\ARCHIVES\LHARC.EXE a /mt !A !F
  78.  
  79.      Each config line can be broken into parts; using the example above:
  80.  
  81.         LZH =         Operation being performed. Operations are UNZIP and
  82.                       ZIP, UNARJ and ARJ, UNLZH and LZH, UNARC and ARC (for
  83.                       ARC or PAK compression), UNZOO and ZOO. Not every
  84.                       operation needs to be specified in DETAG.CFG.
  85.  
  86.         C:\ARCHIVES\  Program location. If no location is specified, DETAG
  87.                       will search your path for the program.
  88.  
  89.         LHARC.EXE     Archive/unarchive program name. If a program location
  90.                       has been specified, the program name must directly
  91.                       follow the program location, as in the example above.
  92.  
  93.         a /mt         Program options. Although the rest of the config line
  94.                       is not case-sensitive, some archive/unarchive
  95.                       programs use case-sensitive options, so this part of
  96.                       the config line will be sent exactly as is.
  97.  
  98.         !A            Will be replaced with the QWK archive name.
  99.  
  100.         !F            Will be replaced with MESSAGES.DAT filename.
  101.  
  102.      After making all desired changes, save DETAG.CFG in ASCII format, in
  103.      the same directory that DETAG.EXE is in.
  104.  
  105.  
  106.      OPERATION
  107.      ---------
  108.      DETAG is activated from the command line, using the format
  109.  
  110.         DETAG filespec [options]
  111.  
  112.      The filespec can include a path, and can also contain wildcards. If no
  113.      extension is specified, an extension of ".Q*" will be appended before
  114.      searching for matching files.
  115.  
  116.  
  117.  
  118.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 3
  119.  
  120.  
  121.      OPTIONS
  122.      -------
  123.      The options can be in any order (even before the filespec), and are
  124.      not case-sensitive. Option descriptions are as follows:
  125.  
  126.         /C   Config file path. This option is usually not needed unless
  127.              your DETAG.CFG file is not in the same directory as your
  128.              DETAG.EXE file, or if you are using DOS version 2.x (which
  129.              cannot determine the path of the program being run). The path
  130.              must directly follow the /C (no spaces). Trailing backslashes
  131.              will be added automatically, if needed.
  132.  
  133.         /N   Do not create backup files. By default, the original QWK file
  134.              will be copied before being updated; use this option to skip
  135.              that step. When backups are made, the first letter of the
  136.              backup file's extension will be changed to a B. Example:
  137.              PROG0101.QWK will be copied to PROG0101.BWK before being
  138.              updated. If the original QWK file's extension started with a
  139.              B, the backup file will start with a C. if the original QWK
  140.              file had no extension, the backup file will have an extension
  141.              of BWK.
  142.  
  143.         /O   Tagline output device or filename. As the taglines are being
  144.              stripped, they will be written to whatever device/file is
  145.              specified here. Default is none. If an existing file is
  146.              specified, the taglines will be appended to that file.
  147.  
  148.         /P   Prompt before stripping each file. This option is useful when
  149.              you want to strip taglines from all but a few QWacK packs.
  150.  
  151.         /Q   Quiet mode. By default, DETAG will display progress messages,
  152.              and will also show you what each archive/unarchive program is
  153.              doing; use this option to attempt to surpress these messages.
  154.              DETAG's progress messages, and all archive/unarchive program
  155.              progress messages as well, will be redirected to NUL, although
  156.              output from some programs cannot be redirected. The only
  157.              messages displayed by DETAG will be warnings and error
  158.              messages, both of which are directed to STDERR.
  159.  
  160.         /R   Read only - do not delete taglines. By default, any taglines
  161.              encountered are deleted; use this option to read the taglines
  162.              without deleting. You will most likely also want to use the /O
  163.              option to route the taglines elsewhere, unless you just want
  164.              to find out how many taglines are in a QWK file.
  165.  
  166.  
  167.  
  168.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 4
  169.  
  170.  
  171.      MESSAGES
  172.      --------
  173.      DETAG messages come in three flavors: progress, warnings and errors.
  174.  
  175.      Progress messages tell you what step DETAG is in.
  176.  
  177.         "Calling (program)" is shown before DETAG attempts to run a file
  178.         archiver/unarchiver.
  179.  
  180.         "Stripping taglines..." is shown when the process of stripping
  181.         taglines from MESSAGES.DAT has begun.
  182.  
  183.         "X tag(s) stripped." is shown upon completion of tagline stripping.
  184.         X is replaced with the number of taglines stripped.
  185.  
  186.         "Copying (file1) to (file2)" is shown when backing up the QWK file.
  187.  
  188.      Warnings are displayed when DETAG has problems with a particular QWK
  189.      file. Warnings will not halt the program; when processing multiple QWK
  190.      files, DETAG will skip the current file and go on to the next one if a
  191.      warning is encountered. If any warnings occur during processing, DETAG
  192.      will return an errorlevel of 2 to DOS, unless overridden by an error.
  193.  
  194.         "Unknown archive method used for (QWK file)" is shown when the QWK
  195.         file does not appear to have been archived by any of the supported
  196.         archive types. (Let me know the archive type, and if I can track
  197.         down the specifications, I'll most likely add support for it.)
  198.  
  199.         "(config option) not defined in config file" is shown when the
  200.         archive type has been determined, but there is no config option in
  201.         DETAG.CFG corresponding to the archive type.
  202.  
  203.         "Not enough memory to call (program)" is shown when there is too
  204.         little RAM to run an archive/unarchive program.
  205.  
  206.         "Unable to extract MESSAGES.DAT from (QWK file)" is shown when a
  207.         file unarchiver returns an error code when trying to extract
  208.         MESSAGES.DAT from a QWK archive. The actual error will have been
  209.         displayed by the unarchive program prior to this message.
  210.  
  211.         "Cannot open (filename)" is shown when DETAG cannot open a file in
  212.         the desired mode, such as if trying to delete taglines from a
  213.         read-only file, or if an archiver/unarchiver is not found. If the
  214.         latter, check the config options in DETAG.CFG to make sure they are
  215.         pointing to the proper programs.
  216.  
  217.         "Error creating backup file" is shown when DETAG is unable to copy
  218.         the original QWK file prior to update. (out of disk space?)
  219.  
  220.         "Unable to update (QWK file)" is shown when a file archiver returns
  221.         an error code when trying to add the updated MESSAGES.DAT file to
  222.         a QWK archive. The actual error will have been displayed by the
  223.         archive program prior to this message.
  224.  
  225.  
  226.  
  227.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 5
  228.  
  229.  
  230.      MESSAGES (continued)
  231.      --------------------
  232.      Errors are displayed when there exists a condition severe enough to
  233.      stop DETAG from continuing. Processing will stop immediately and an
  234.      errorlevel will be returned to DOS.
  235.  
  236.         Lvl Description
  237.  
  238.          1  Help screen. Not actually an error; the help screen is shown
  239.             when no command-line arguments are given.
  240.  
  241.          2  A warning has occurred. Warnings will not halt the program, but
  242.             the errorlevel will be set to 2, unless overridden by an error.
  243.  
  244.          3  Ctrl-break pressed. This will only occur when pressed while
  245.             DETAG is running; if pressed while an archiver/unarchiver is
  246.             running, the ctrl-break will be sent to that program, which
  247.             will more than likely cause a warning message in DETAG.
  248.  
  249.          4  "No filespec found" is shown when options have been specified
  250.             without a filespec.
  251.  
  252.          5  "Invalid option: (option)" is shown when DETAG runs across an
  253.             unsupported option.
  254.  
  255.          6  "Cannot open (config file)" is shown when DETAG.CFG is not in
  256.             the same directory as DETAG.EXE, or if DETAG.CFG is not in the
  257.             directory specified with the /C option.
  258.  
  259.          7  "Cannot open (tagline file)" is shown when the device or file
  260.             specified with the /O option cannot be opened for writing.
  261.  
  262.          8  "No files match (filespec)" is shown when no files match the
  263.             given filespec. (recursive enough? ;^)
  264.  
  265.          9  "Not enough memory" is shown when DETAG is not able to allocate
  266.             enough RAM prior to processing.
  267.  
  268.  
  269.      EXAMPLES
  270.      --------
  271.      DETAG
  272.         displays a help screen.
  273.  
  274.      DETAG * /p
  275.         deletes taglines from all files matching a "*.Q*" filespec, making
  276.         backup copies along the way, confirming (/P) before processing each
  277.         file.
  278.  
  279.      DETAG progcrnr.qwk /oprn /q
  280.         deletes taglines from file PROGCRNR.QWK, sending all taglines found
  281.         to the printer (/O), and surpressing progress messages (/Q).
  282.  
  283.  
  284.  
  285.      DETAG V1.00 Copyright (c) 1993 Copy Con Incorporated            Page 6
  286.  
  287.  
  288.      EXAMPLES (continued)
  289.      --------------------
  290.      DETAG exec* /r /oc:\slmr\taglines.mr
  291.         reads without deleting (/R) taglines found in "EXEC*.Q*" files, and
  292.         appends the taglines to an existing tagline file (/O).
  293.  
  294.      DETAG cci /n /cc:\utils
  295.         deletes taglines from "CCI.Q*" files without making backups (/N),
  296.         and specifying that DETAG.CFG is in the C:\UTILS directory (/C).
  297.  
  298.  
  299.      SUPPORT
  300.      -------
  301.      If you have questions, comments, suggestions, bug reports, et cetera,
  302.      feel free to contact me by one of the following methods:
  303.  
  304.      1: By modem at The Programmer's Corner (301-596-7692 or 410-995-6873).
  305.         Send a message to RD Thomas in the General conference, and check
  306.         back in a couple of days for a reply.
  307.  
  308.      2: By modem in the RIME Shareware conference (RD Thomas ->1520). If
  309.         you do not recieve a reply within a week, it is because there are
  310.         still some kinks to be worked out at this node; try contacting me
  311.         via methods 1 or 3.
  312.  
  313.      3: By US Mail at the address given on the first page. If you would
  314.         like a reply, please include a self-addressed, stamped envelope.
  315.  
  316.  
  317.      COMMENTS
  318.      --------
  319.      DETAG is most successful in stripping taglines with the format
  320.  
  321.         * QWK Reader 1.00 * This is a standard tagline.
  322.  
  323.      where * can also be the "square" symbol (ASCII 254). DETAG can also
  324.      strip most non-standard taglines, but due to the proliferation of QWK
  325.      file readers, there will always be new non-standard tagline formats
  326.      popping up; DETAG will be updated continuously to handle new formats.
  327.  
  328.      The QWK format is Copyright 1987 by Sparkware.
  329.  
  330.      All program names mentioned in this document are either Copyright or
  331.      Trademark of respective owners.
  332.  
  333.      This document can be printed by typing "copy detag.doc LPTx" at the
  334.      DOS prompt, where x is the number of the printer port to be used.
  335.  
  336.      * DETAG 1.00 * Have a nice day.
  337.