home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / d / detag120.zip / DETAG.DOC < prev    next >
Text File  |  1993-01-22  |  17KB  |  401 lines
  1.  
  2.  
  3.  
  4.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 1
  5.  
  6.  
  7.      DESCRIPTION
  8.      -----------
  9.      DETAG removes taglines and subject prefixes from QWK message archives.
  10.      DETAG determines compression type by signature, calls the appropriate
  11.      unarchiver to extract MESSAGES.DAT or a specified .REP file, reads or
  12.      removes taglines and subject prefixes (optionally routing taglines to
  13.      a separate device or file), optionally backs up the original QWK file,
  14.      then calls the appropriate archiver to replace the old MESSAGES.DAT or
  15.      .REP file with the updated one. DETAG can handle wildcards, with an
  16.      optional Yes/No prompt before processing each file.
  17.  
  18.  
  19.      REQUIREMENTS
  20.      ------------
  21.      DETAG runs under DOS 2.0 or better, and calls various file archivers
  22.      and unarchivers; DETAG can process ZIP, ARJ, LZH, ARC/PAK, and ZOO
  23.      archive types. You won't necessarily need every (un)archive program
  24.      listed in DETAG.CFG; if your QWK reader uses external programs, then
  25.      you already have the ones that you need. If the programs are not in
  26.      your path, or if you use programs other than those listed in DETAG.CFG
  27.      (like NoGate's PAK or SEA's ARC), then you will also need an ASCII
  28.      text editor to edit DETAG.CFG.
  29.  
  30.  
  31.      DISCLAIMER
  32.      ----------
  33.      DETAG is distributed on an "AS IS" basis without warranty, expressed
  34.      or implied. Considerable testing effort has been expended, but the
  35.      user is advised to check the program's suitability before relying on
  36.      it. The user assumes full risk as to the results of using this
  37.      program. In no event shall the author be liable for any incidental or
  38.      consequential damages arising from the use, or inability to use this
  39.      program.
  40.  
  41.  
  42.      REGISTRATION
  43.      ------------
  44.      The unregistered version of DETAG is freely distributable and fully
  45.      functional, and may be used for a 30-day trial period. If you plan to
  46.      continue using DETAG, you are obligated to pay the modest registration
  47.      fee of $15. Registered users will receive an individually serialized
  48.      nag-free version of DETAG, a free upgrade, and $5 subsequent upgrades.
  49.  
  50.      All registration information is contained in the DETAG.REG file. If
  51.      that file is missing, register by sending your name, address, and a
  52.      check or money order for $15 in US dollars to:
  53.  
  54.         Copy Con Incorporated
  55.         PO Box 23255
  56.         Baltimore MD 21203-5255
  57.  
  58.      Please specify 3.5" or 5.25" diskette. MD residents add 5% sales tax.
  59.      Thank you for supporting Shareware.
  60.  
  61.  
  62.  
  63.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 2
  64.  
  65.  
  66.      INSTALLATION
  67.      ------------
  68.      To install, copy both DETAG.EXE and DETAG.CFG into your path. If your
  69.      (un)archivers are not in your path, or if you use programs other than
  70.      those listed in DETAG.CFG (like NoGate's PAK or SEA's ARC), then you
  71.      will need to edit DETAG.CFG with any ASCII text editor.
  72.  
  73.      DETAG.CFG contains the locations and command line options of your file
  74.      archivers/unarchivers. A typical line in DETAG.CFG would look like:
  75.  
  76.         LZH = C:\ARCHIVES\LHARC.EXE a /mt !A !F
  77.  
  78.      Each config line can be broken into parts; using the example above:
  79.  
  80.         LZH =         Operation being performed. Operations are UNZIP and
  81.                       ZIP, UNARJ and ARJ, UNLZH and LZH, UNARC and ARC (for
  82.                       ARC or PAK compression), UNZOO and ZOO. Not every
  83.                       operation needs to be specified in DETAG.CFG.
  84.  
  85.         C:\ARCHIVES\  Program location. If no location is specified, DETAG
  86.                       will search your path for the program.
  87.  
  88.         LHARC.EXE     Archive/unarchive program name. If a program location
  89.                       has been specified, the program name must directly
  90.                       follow the program location, as in the example above.
  91.  
  92.         a /mt         Program options. Although the rest of the config line
  93.                       is not case-sensitive, some archive/unarchive
  94.                       programs use case-sensitive options, so this part of
  95.                       the config line will be sent exactly as is.
  96.  
  97.         !A            Will be replaced with the QWK archive name.
  98.  
  99.         !F            Will be replaced with MESSAGES.DAT or the filename
  100.                       specified with the /F option.
  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.20 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.         /F   File to extract. By default, DETAG will attempt to extract and
  134.              process MESSAGES.DAT. SysOps may wish to remove taglines or
  135.              subject prefixes from .REP files uploaded by users, which have
  136.              virtually the same format as MESSAGES.DAT; the /F option,
  137.              followed directly by the filename to be extracted, can be used
  138.              for this purpose.
  139.  
  140.         /N   Do not create backup files. By default, the original QWK file
  141.              will be copied before being updated; use this option to skip
  142.              that step. When backups are made, the first letter of the
  143.              backup file's extension will be changed to a B. Example:
  144.              PROG0101.QWK will be copied to PROG0101.BWK before being
  145.              updated. If the original QWK file's extension started with a
  146.              B, the backup file will start with a C. if the original QWK
  147.              had no extension, the backup file's extension will be BWK.
  148.  
  149.         /O   Tagline output device/filename.  As the taglines are being
  150.              read or removed, they will be written to the device/filename
  151.              specified with this option. If an existing file is given, the
  152.              taglines will be appended to the file. If no device or file is
  153.              given with the /O option, a file with the name of TAGLINES.TXT
  154.              will be created or appended to in the current directory.
  155.  
  156.         /P   Prompt before processing each file. This option is useful when
  157.              you want to strip taglines from all but a few QWacK packs.
  158.              Type 'Y' for Yes, 'N' for No, 'A' for All, 'C' for Cancel.
  159.  
  160.         /Q   Quiet mode. By default, DETAG will display progress messages,
  161.              and will also show you what each (un)archive program is doing;
  162.              use this option to attempt to surpress these messages. DETAG's
  163.              progress messages, and (un)archive program messages as well,
  164.              will be redirected to NUL, although output from some programs
  165.              cannot be redirected. DETAG will still display warnings and
  166.              error messages, which are routed to STDERR.
  167.  
  168.         /R   Read only. By default, any taglines and subject prefixes
  169.              encountered are removed; use this option if you only want to
  170.              route the taglines with the /O option without removing them,
  171.              or if you want a count of messages, taglines, and subject
  172.              prefixes in a QWK file.
  173.  
  174.  
  175.  
  176.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 4
  177.  
  178.  
  179.      OPTIONS (continued)
  180.      -------------------
  181.  
  182.         /S   Do not remove subject prefixes. Some mail readers add an 'in
  183.              response to' prefix to the subject field of messages replied
  184.              to, which makes them appear out of order when sorting by
  185.              subject or thread. By default, DETAG removes these prefixes;
  186.              use this option to leave the subject field intact, while still
  187.              removing the taglines.
  188.  
  189.         /T   Do not remove taglines. Use this option if you only wish to
  190.              remove subject prefixes, while leaving taglines intact.
  191.  
  192.         /W   Work directory. By default, MESSAGES.DAT (or the /F option
  193.              file) is extracted to the current directory for processing;
  194.              use this option to specify an alternate location, like a RAM
  195.              drive for faster operation.
  196.  
  197.  
  198.      MESSAGES
  199.      --------
  200.      DETAG messages come in three flavors: progress, warnings and errors.
  201.  
  202.      Progress messages tell you what step DETAG is in.
  203.  
  204.         "Calling (program)" is shown before DETAG attempts to run a file
  205.         (un)archiver.
  206.  
  207.         "Processing..." is shown when the process of reading or removing
  208.         taglines and subject prefixes has begun.
  209.  
  210.         "X messages processed." is shown upon completion of processing. X
  211.         is the total number of messages found.
  212.  
  213.         "X tagline(s) read." is shown if the /R or /T option is used to
  214.         read taglines without removing them. X is the total number of
  215.         taglines read.
  216.  
  217.         "X tagline(s) removed." is shown upon completion of tagline
  218.         removal.
  219.  
  220.         "X subject prefix(es) read" is shown if the /R option is used to
  221.         read subject prefixes without removing them. X is the total number
  222.         of subject prefixes read.
  223.  
  224.         "X subject prefix(es) removed." is shown upon completion of subject
  225.         prefix removal.
  226.  
  227.         "Copying (file1) to (file2)" is shown when backing up the QWK file.
  228.  
  229.  
  230.  
  231.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 5
  232.  
  233.  
  234.      MESSAGES (continued)
  235.      --------------------
  236.      Warnings are displayed when DETAG has problems with a particular QWK
  237.      file. Warnings will not halt the program; when processing multiple QWK
  238.      files, DETAG will skip the current file and go on to the next one if a
  239.      warning is encountered. If any warnings occur during processing, DETAG
  240.      will return an errorlevel of 2 to DOS, unless overridden by an error.
  241.  
  242.         "Unknown archive method used for (QWK file)" is shown when the QWK
  243.         file does not appear to have been archived by any of the supported
  244.         archive types. (Let me know the archive type, and if I can track
  245.         down the specifications, I'll most likely add support for it.)
  246.  
  247.         "(config option) not defined in config file" is shown when the
  248.         archive type has been determined, but there is no config option in
  249.         DETAG.CFG corresponding to the archive type.
  250.  
  251.         "Not enough memory to call (program)" is shown when there is too
  252.         little RAM to run an archive/unarchive program.
  253.  
  254.         "Unable to extract (extract file) from (QWK file)" is shown when a
  255.         file unarchiver returns an error code when trying to extract
  256.         MESSAGES.DAT (or the /F option file) from a QWK archive. The actual
  257.         error will have been displayed by the unarchive program prior to
  258.         this message.
  259.  
  260.         "Cannot open (filename)" is shown when DETAG cannot open a file in
  261.         the desired mode, such as if trying to remove taglines from a
  262.         read-only file, or if an (un)archiver is not found. If the latter,
  263.         check the config options in DETAG.CFG to make sure they are
  264.         pointing to the proper programs.
  265.  
  266.         "Error creating backup file" is shown when DETAG is unable to copy
  267.         the original QWK file prior to update. (out of disk space?)
  268.  
  269.         "Unable to update (QWK file)" is shown when a file archiver returns
  270.         an error code when trying to add the updated MESSAGES.DAT (or the
  271.         /F option file) to a QWK archive. The actual error will have been
  272.         displayed by the archive program prior to this message.
  273.  
  274.      Errors are displayed when there exists a condition severe enough to
  275.      stop DETAG from continuing. Processing will stop immediately and an
  276.      errorlevel will be returned to DOS.
  277.  
  278.         Lvl Description
  279.  
  280.          1  Help screen. Not actually an error; the help screen is shown
  281.             when no command-line arguments are given.
  282.  
  283.          2  A warning has occurred. Warnings will not halt the program, but
  284.             the errorlevel will be set to 2, unless overridden by an error.
  285.  
  286.  
  287.  
  288.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 6
  289.  
  290.  
  291.      MESSAGES (continued)
  292.      --------------------
  293.  
  294.          3  "Ctrl-break pressed" is shown when DETAG receives a ctrl-break
  295.             or ctrl-c from the keyboard. If DETAG is running a program, the
  296.             program will receive the break signal instead of DETAG.
  297.  
  298.          4  "No filespec found" is shown when options have been specified
  299.             without a filespec.
  300.  
  301.          5  "Invalid option: (option)" is shown when DETAG runs across an
  302.             unsupported option.
  303.  
  304.          6  "Cannot open (config file)" is shown when DETAG.CFG is not in
  305.             the same directory as DETAG.EXE, or if DETAG.CFG is not in the
  306.             directory specified with the /C option.
  307.  
  308.          7  "Cannot open (tagline file)" is shown when the device or file
  309.             specified with the /O option cannot be opened for writing.
  310.  
  311.          8  "No files match (filespec)" is shown when no files match the
  312.             given filespec. (recursive enough? ;^)
  313.  
  314.          9  "Not enough memory" is shown when DETAG is not able to allocate
  315.             enough RAM prior to processing.
  316.  
  317.         10  "Invalid work directory" is shown when the drive or directory
  318.             specified with the /W option cannot be accessed.
  319.  
  320.         11  "Invalid extract file" is shown when the file specified with
  321.             the /F option is invalid.
  322.  
  323.  
  324.      EXAMPLES
  325.      --------
  326.      DETAG
  327.         displays a help screen.
  328.  
  329.      DETAG * /p /wd:
  330.         removes taglines from all files matching a "*.Q*" filespec, making
  331.         backup copies along the way, confirming (/P) before processing each
  332.         file, and specifying the D: drive as the work directory.
  333.  
  334.      DETAG progcrnr.qwk /oprn /q
  335.         removes taglines from file PROGCRNR.QWK, sending all taglines found
  336.         to the printer (/O), and surpressing progress messages (/Q).
  337.  
  338.      DETAG exec* /r /oc:\slmr\taglines.mr
  339.         reads without removing (/R) taglines found in "EXEC*.Q*" files, and
  340.         appends the taglines to an existing tagline file (/O).
  341.  
  342.      DETAG cci /n /cc:\utils
  343.         removes taglines from "CCI.Q*" files without making backups (/N),
  344.         and specifying that DETAG.CFG is in the C:\UTILS directory (/C).
  345.  
  346.  
  347.  
  348.      DETAG V1.20 Copyright (c) 1993 Copy Con Incorporated            Page 7
  349.  
  350.  
  351.      EXAMPLES (continued)
  352.      --------------------
  353.      DETAG rusty /o /s
  354.         will remove taglines found in RUSTY.QWK and place them in the
  355.         default file TAGLINES.TXT (/O). Subject prefixes will not be
  356.         altered (/S).
  357.  
  358.      DETAG rusty /o /t
  359.         will read taglines (/T) taglines found in RUSTY.QWK and place them
  360.         in the default file TAGLINES.TXT (/O). Subject prefixes will be
  361.         removed.
  362.  
  363.  
  364.      NOTES
  365.      -----
  366.      DETAG is most successful in stripping taglines with the format
  367.  
  368.         * QWK Reader 1.00 * This is a standard tagline.
  369.  
  370.      where * can also be the "square" symbol (ASCII 254). DETAG can also
  371.      strip most non-standard taglines, but due to the proliferation of QWK
  372.      file readers, there will always be new non-standard tagline formats
  373.      popping up; DETAG will be updated continuously to handle new formats.
  374.  
  375.      The QWK format is Copyright 1987 by Sparkware.
  376.  
  377.      All program names mentioned in this document are either Copyright or
  378.      Trademark of respective owners.
  379.  
  380.  
  381.      SUPPORT
  382.      -------
  383.      If you have questions, comments, suggestions, bug reports, et cetera,
  384.      feel free to contact me by one of the following methods:
  385.  
  386.      1: By modem at The Programmer's Corner (301-596-7692 or 410-995-6873).
  387.         Send a message to RD Thomas in the Shareware or General conference,
  388.         and check back in a couple of days for a reply.
  389.  
  390.      2: By modem in the RIME Shareware conference (RD Thomas ->1520). Allow
  391.         at least one week for a reply.
  392.  
  393.      3: By US Mail at the address given on the first page. If you would
  394.         like a reply, please include a self-addressed, stamped envelope.
  395.  
  396.      * DETAG 1.20 * Looking forward to hearing from you.
  397.  
  398.  
  399.      This document can be printed by typing "copy detag.doc LPTx" at the
  400.      DOS prompt, where x is the number of the printer port to be used.
  401.