home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast2.iso / bbs / fce10.zip / FCE.DOC < prev    next >
Text File  |  1991-08-30  |  29KB  |  802 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                         FCE: File Comment Extractor
  7.                           DOS Edition, Version 1.0
  8.                       ────────────────────────────────
  9.                       (C) Copyright 1991 by Andy Hakim
  10.                             All Rights Reserved
  11.  
  12.  
  13.                       R E F E R E N C E    M A N U A L
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.         For a quick summary of options, type FCE at the dos prompt.
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                              TABLE OF CONTENTS
  68.  
  69. ADDRESSES ..............................................................  1
  70.  
  71. SOFTWARE LICENSE  ......................................................  1
  72.  
  73. NOTATIONS/TERMINOLOGY ..................................................  1
  74.  
  75. WHAT IS FCE?  ..........................................................  2
  76.  
  77. WILL FCE BE USEFUL TO YOU?  ............................................  2
  78.  
  79. SEARCH STRATEGY ........................................................  3
  80.  
  81. SYSTEM REQUIREMENTS ....................................................  3
  82.  
  83. TEXT FILES  ............................................................  4
  84.  
  85. COMMAND LINE SYNTAX ....................................................  4
  86.      <inputfile>  ......................................................  4
  87.      <wildcards>  ......................................................  4
  88.      <scanfile[.lst]> ..................................................  4
  89.      [outputfile] ......................................................  4
  90.      [options]  ........................................................  4
  91.  
  92. COMMAND LINE OPTIONS  ..................................................  5
  93.      /? ................................................................  5
  94.      /F=# ..............................................................  5
  95.      /T=# ..............................................................  5
  96.      /M ................................................................  5
  97.      /C ................................................................  5
  98.      /O ................................................................  5
  99.      /S ................................................................  6
  100.      /I<F,E>  ..........................................................  6
  101.      /CLS=# ............................................................  6
  102.      /CO<O,S>=# ........................................................  6
  103.      /FL<I,S>=# ........................................................  6
  104.      /C=<file[.cfg]>  ..................................................  7
  105.      /EMS=# ............................................................  7
  106.  
  107. COMMAND LINE EXAMPLES ..................................................  8
  108.  
  109. FILE PROCESSING SCREEN  ................................................  9
  110.  
  111. ERROR MESSAGES  ........................................................  9
  112.  
  113. PROJECT HISTORY ........................................................ 10
  114.  
  115. SOURCE CODE ............................................................ 10
  116.  
  117. TRADEMARKS ............................................................. 10
  118.  
  119. REVISION HISTORY  ...................................................... 11
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133. FCE version 1.0  Reference Manual                                   Page: 1
  134. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  135.  
  136.  
  137. ADDRESSES
  138. ───────────────────────────────────────────────────────────────────────────
  139. Comments, suggestions, or questions?  You can contact me via:
  140.  
  141.  
  142.                    US Mail │ FCE Development
  143.                            │ P.O. Box 70392
  144.                            │ Houston, TX 77270-0392
  145.                            │
  146.                  Telephone │ (713) 880-3059
  147.                            │
  148.            Electronic Mail │ st144@menudo.uh.edu
  149.       (Internet addresses) │ cosc12r2@jetson.uh.edu
  150.                            │
  151.             Bulletin Board │ Sand's BBS
  152.                            │ (713) 961-1604
  153.                            │ 2400/9600/14400 baud, HST/v.32
  154.                            │ Username: Andy Hakim
  155.  
  156.  
  157.  
  158.  
  159.  
  160. SOFTWARE LICENSE
  161. ───────────────────────────────────────────────────────────────────────────
  162. FCE (DOS Edition, v1.0) is a free, public domain program.  There is no
  163. registration process or monetary fee required in order to use it.
  164.  
  165. You may freely distribute FCE to others as long as:
  166.  
  167.                ■ Only the original files are distributed
  168.                ■ No changes are made to any files
  169.                ■ No money is charged for the program
  170.  
  171. FCE, its documentation, and all related files are (C) Copyright 1991 by
  172. Andy Hakim.  All Rights Reserved.  The author of this program is not liable
  173. for any damage caused by its use.  By using this program, you agree to the
  174. above conditions.
  175.  
  176. If you find FCE useful, I would appreciate it if you let me know.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184. NOTATIONS/TERMINOLOGY
  185. ───────────────────────────────────────────────────────────────────────────
  186. The following notations are used in this documentation:
  187.  
  188.                 <> describes a required parameter
  189.                 [] describes an optional parameter
  190.                 {} describes a default parameter
  191.  
  192. Do not type <>, [], or {}, only the information inside them.
  193.  
  194. You should be familiar with basic DOS concepts such as wildcards, paths,
  195. subdirectories and text files.  If those concepts are foreign to you,
  196. refer to your DOS manual.  There are also many books written on
  197. understanding DOS.
  198.  
  199. FCE version 1.0  Reference Manual                                   Page: 2
  200. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  201.  
  202. WHAT IS FCE?
  203. ───────────────────────────────────────────────────────────────────────────
  204. FCE is an abbreviation for File Comment Extractor.  It is a utility that
  205. compares two text files that contain filenames and comments, and tries to
  206. match filenames.  On a successful match, the comment is copied from the
  207. scan file to the output file.  For example:
  208.  
  209. Contents of file one (files you have downloaded from a bbs):
  210. ┌─────────────────────────────────────────────────────────────────────────┐
  211. │  SOLAR   .ZIP                                                           │
  212. │  386UTILS.ZIP                                                           │
  213. │  MICRODRW.ZIP                                                           │
  214. │  MOUSEADJ.ZIP                                                           │
  215. └─────────────────────────────────────────────────────────────────────────┘
  216.  
  217. Contents of file two (a file list from your favorite bbs)
  218. ┌─────────────────────────────────────────────────────────────────────────┐
  219. │  MOUSEADJ.ZIP     Mouse adjustment utility                              │
  220. │  GUMBY   .ZIP     Doubles your cpu speed (386/33 -> 386/66)!            │
  221. │  MICRODRW.ZIP     Micro Draw -- easy to use drawing program             │
  222. │  POKEY   .ZIP     Use modem lights as infrared signals!                 │
  223. │  386UTILS.ZIP     Useful utilities for 386 based pc's                   │
  224. │  PRICKLE .ZIP     Store up to 5mb on a 360k floppy -- works!            │
  225. └─────────────────────────────────────────────────────────────────────────┘
  226.  
  227. FCE's Output:
  228. ┌─────────────────────────────────────────────────────────────────────────┐
  229. │  SOLAR   .ZIP                                                           │
  230. │  386UTILS.ZIP     Useful utilities for 386's                            │
  231. │  MICRODRW.ZIP     Micro Draw -- easy to use drawing program             │
  232. │  MOUSEADJ.ZIP     Mouse adjustment utility                              │
  233. └─────────────────────────────────────────────────────────────────────────┘
  234.  
  235. If you are familiar with database operations, you may recognize that FCE is
  236. similar to a JOIN function.  FCE's advantage is that it operates on text
  237. files and saves you the trouble of converting the file to your database,
  238. defining fields, creating indexes, etc.  It also offers many features that
  239. may be hard or cumbersome to duplicate in a database.
  240.  
  241.  
  242.  
  243.  
  244.  
  245. WILL FCE BE USEFUL TO YOU?
  246. ───────────────────────────────────────────────────────────────────────────
  247. It all depends on how you categorize your files (if at all), and the number
  248. of files you acquire over a given period of time.  The main purpose of FCE
  249. is to save you the time and drudgery of entering comments for each file,
  250. not to mention the trouble of figuring out what some of the filenames are.
  251.  
  252. FCE reads and creates text files.  Therefore it is very easy to search,
  253. manipulate, or transfer information using viewing programs, text editors,
  254. and word processors, etc.  If you organize your file lists as text files
  255. you will find FCE much more helpful.
  256.  
  257. FCE can also be used to compare two file lists and mark filenames that are
  258. duplicates.  The output can be sent to a separate output file.  See the
  259. last example in COMMAND LINE EXAMPLES.
  260.  
  261.  
  262.  
  263.  
  264.  
  265. FCE version 1.0  Reference Manual                                   Page: 3
  266. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  267.  
  268. SEARCH STRATEGY
  269. ───────────────────────────────────────────────────────────────────────────
  270. Before you use FCE, you will need a copy of a file list from some BBS or
  271. an anonymous FTP site, preferably from the board/site that you got the
  272. files from.  Usually, sysops have a text file containing a list of all
  273. files avaiable on their system.  If they dont, you can probably do a text
  274. file capture on all available files.  This will serve as your scan file.
  275. Note: FCE defaults to PC Board formatted lists.  By the way, dont expect
  276. a 100% success rate!  On the other hand, if you start seeing rates of
  277. 0 - 10% MAKE SURE THE COLUMN OFFSETS/LENGTHS ARE SETUP CORRECTLY.
  278.  
  279.  
  280.  
  281. SYSTEM REQUIREMENTS
  282. ───────────────────────────────────────────────────────────────────────────
  283.           ■ Any IBM PC or compatible running MS-DOS 2.0 or higher
  284.           ■ Any video card, EGA/VGA recommended
  285.           ■ Minimum of 200k of free conventional RAM
  286.           ■ Optional: Hard disk, any size
  287.           ■ Optional: EMS memory, as much as possible
  288.           ■ Optional: Disk cache software
  289.           ■ Optional: Ram disk software
  290.  
  291.  
  292. EGA/VGA:
  293.      FCE uses various features that are available on EGA or VGA display
  294.      cards.  You can use other displays, but the screen will not look
  295.      snazzy.
  296.  
  297. Hard Disk:
  298.      FCE accesses the disk frequently and needs space to store temporary
  299.      files.  A hard disk offers better performance and greater storage
  300.      space.
  301.  
  302. Conventional Memory:
  303.      You can use the dos CHKDSK command to see how much free memory is
  304.      available on your system.  If there is not enough memory, FCE will
  305.      inform you.  More memory allows you to use larger scan files.
  306.  
  307. Expanded (EMS) Memory:
  308.      EMS memory is automatically detected and used.  The EMS driver should
  309.      meet LIM v3.2 (or higher) specifications.  More EMS memory allows you
  310.      to use larger scan files.
  311.  
  312. Disk Cache:
  313.      Using a disk cache may dramatically decrease the file processing time. 
  314.      There are many commercial and public domain disk cache programs
  315.      available.
  316.  
  317. Ram Disk:
  318.      Using a ram disk will also decrease the file processing time.  For
  319.      maximum performance you should log on to the ram disk before running
  320.      FCE (this is because temporary files are created on the currently
  321.      logged drive.)
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331. FCE version 1.0  Reference Manual                                   Page: 4
  332. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  333.  
  334. TEXT FILES
  335. ───────────────────────────────────────────────────────────────────────────
  336. FCE is a line oriented text file processor, that is: it operates on text
  337. files, and each line in the text file is treated as a distinct entity.
  338. Lines may be of different lengths but all fields (ie: filenames, comments,
  339. dates) must be in consistent locations.  For example, all comments must
  340. be one below the other.
  341.  
  342. There is no need to edit text files.  Blank lines, headers, footers,
  343. titles, and high order characters are ignored.
  344.  
  345. Input files do not occupy system memory and therefore can be of any length.
  346.  
  347. Each line in a scan file occupies 4 bytes of conventional memory, and N+5
  348. bytes of conventional or EMS memory.  N is the filename length specified by
  349. the /FLS=# option (see COMMAND LINE OPTIONS).  A machine with 500k free
  350. and no EMS (under default options) can handle files of about 20,000 lines.
  351. With approximately 1.5mb of EMS memory, FCE can handle files of about
  352. 100,000 lines.
  353.  
  354.  
  355.  
  356.  
  357.  
  358. COMMAND LINE SYNTAX
  359. ───────────────────────────────────────────────────────────────────────────
  360. There are two basic formats that can be used to start FCE:
  361.  
  362.       FCE <inputfile> <scanfile[.lst]> [outputfile] [options]
  363. or:
  364.       FCE <wildcards> <scanfile[.lst]> [outputfile] [options]
  365.  
  366.  
  367. <inputfile>
  368.      ASCII text file containing filenames that need to be identified.  This
  369.      parameter is required if <wildcards> are not specified.
  370.  
  371. <wildcards>
  372.      Generates a file list (similar to DIR) and appends it to inputfile. 
  373.      If inputfile is not specified, FILELIST.TXT is created.  Multiple
  374.      wildcards may be used (ex: *.zip *.arc *.doc).  This parameter is
  375.      required if <inputfile> is not specified.
  376.  
  377. <scanfile[.lst]>
  378.      ASCII text file containing filenames and comments.  A .LST extension
  379.      is assumed if none is specified.  This parameter is always required.
  380.  
  381. [outputfile]
  382.      ASCII text file that will contain new information created by the
  383.      search.  This parameter is optional.  If it is not specified the
  384.      <inputfile> will be used as the output file.
  385.  
  386. [options]
  387.      Options are used to set various settings.  See the section labeled
  388.      COMMAND LINE OPTIONS for more information.
  389.  
  390. Any valid dos device and/or pathname [d:][path] may precede a file name or
  391. wildcard parameter.
  392.  
  393.  
  394.  
  395.  
  396.  
  397. FCE version 1.0  Reference Manual                                   Page: 5
  398. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  399.  
  400. COMMAND LINE OPTIONS
  401. ───────────────────────────────────────────────────────────────────────────
  402. Options allow you to customize various setting.  Options are not case
  403. sensitive, may be specified in any order, may not be abbreviated, must be
  404. preceded by slash (/) or minus (-), and must be separated by a space ( ).
  405.  
  406.  
  407. /?   (/HELP, or FCE with no options)
  408.      Displays help screens.  There are three help screens which can be
  409.      viewed by pressing the <space> bar.  After you cycle through the help
  410.      screens, you return to the dos prompt.  You can also quit any help
  411.      screen by pressing <esc>.
  412.  
  413. /F=#
  414.      Sets the fuzzy match minimum percentage.  A fuzzy match, also called a
  415.      partial match, occurs when some (but not all) characters in the two
  416.      filenames are the same.  A percentage is calculated by dividing the
  417.      number of characters that match consecutively by the total number of
  418.      characters in the filename.  For example, a fuzzy match on TFE10 and
  419.      TFE20 yields a percentage 60.  If you set /F=100, only identical
  420.      matches will be considered "good".  If you set /F=0, all matches
  421.      will be considered "good".  By default /F=75 which picks up many
  422.      filenames are vary only slightly (ie: version numbers).
  423.  
  424. /T=#
  425.      Sets the tab expansion length.  Tab characters (ASCII code 9) are
  426.      automatically expanded into spaces.  By default, tab stops are set at
  427.      8 characters apart.  If you do not want to expand tabs, use /T=1.
  428.  
  429.  
  430. /M
  431.      Displays minimal information.  No statistics are shown, and no EGA/VGA
  432.      display tricks are used.  Only a few basic messages are displayed as
  433.      work progresses.  This option causes text to be sent DOS's standard
  434.      output device and uses BIOS screen writes.  Output can be redirected
  435.      using > or >>.  For example, of you want absolutely no output from FCE,
  436.      redirect it to the NUL device (consider it a black hole):
  437.  
  438.                     FCE MYFILES.TXT BBSLIST > NUL
  439.  
  440.      Use this option if you experience problems under Desqview of Windows.
  441.  
  442. /C
  443.      Filenames are considered case sensitive.  Normally, both UPPER and
  444.      lower case is considered the same.
  445.  
  446.  
  447. /O
  448.      Overwrites old comments in the input file with new comments in the
  449.      scan file.  Normally, as a safety measure, if a comment exists in the
  450.      input file the new comment is not copied.  If a comment does not exist
  451.      in the scanfile and the filenames match, nothing is done.
  452.  
  453. /S
  454.      Strips leading and trailing spaces from filenames before a comparison
  455.      takes place.  Normally, no striping is done.
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463. FCE version 1.0  Reference Manual                                   Page: 6
  464. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  465.  
  466. /I<F,E>
  467.      Translates to /IF for Fuzzy match or /IE for Exact match.  The
  468.      appropriate type of match is marked in the output file with an
  469.      asterisk character.  The * is placed immediately before the comment
  470.      field of the output file.  More specifically, it is placed one
  471.      character behind the value given by /COO=# option.
  472.  
  473.      A match is treated as EXACT when all characters in both filenames are
  474.      identical.  A match is treated as FUZZY when the filenames match only
  475.      match partially.  The partially matched value must meet or exceed the
  476.      fuzzy value specified by the /F=# option.  Example:
  477.                                 ┌──────────────────┘
  478. GREATTAG.ZIP     9349  03-26-90 *Allows you to sign your message
  479. CORE292.ZIP     37718  10-04-90 *Coretest version 2.92
  480.  
  481. /CLS=#
  482.      Sets the comment length in scan file.  If the length is 0 no comments
  483.      are copied.  If the length is greater than the actual length of the
  484.      comment, spaces are added at the end of the line.  The default length
  485.      is 45.  ─────────────────────────────────────────┐
  486.                                  ┌────────────────────┴─────────────────┐
  487. GREATTAG.ZIP     9349  03-26-90  Allows you to sign your message
  488. CORE292.ZIP     37718  10-04-90  Coretest version 2.92
  489.  
  490. /CO<O,S>=#
  491.      Translates to /COO=# for output file or /COS=# for scan file.  Sets
  492.      the comment offset (starting column) of the appropriate file.  The
  493.      default offset is 34. ──────┐
  494.                                  │
  495. GREATTAG.ZIP     9349  03-26-90  Allows you to sign your message
  496. CORE292.ZIP     37718  10-04-90  Coretest version 2.92
  497.  
  498. /FO<I,S>=#
  499.      Translates to /FOI=# for input file or /FOS=# for scan file.  Sets the
  500.      filename offset (starting column) of the appropriate file.  The
  501.      default offset is 1.
  502. ┌────────────────┘
  503. GREATTAG.ZIP     9349  03-26-90  Allows you to sign your message
  504. CORE292.ZIP     37718  10-04-90  Coretest version 2.92
  505.  
  506. /FL<I,S>=#
  507.      Translates to /FLI=# for input file or /FLS=# for scan file.  Sets the
  508.      filename length of the appropriate file.  The default offset is 8.
  509.    ┌──────────────────────────────────────────────────────────┘
  510. ┌──┴───┐
  511. GREATTAG.ZIP     9349  03-26-90  Allows you to sign your message
  512. CORE292.ZIP     37718  10-04-90  Coretest version 2.92
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529. FCE version 1.0  Reference Manual                                   Page: 7
  530. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  531.  
  532. /C=<file[.cfg]>
  533.      Reads options from a configuration file.  A .CFG extension is
  534.      assumed if none is specified.  The config file is a text file
  535.      that contains a list of options each on a new line.  Every line in the
  536.      config file is treated as a separate parameter just as though it was
  537.      typed on the command line.  A space ( ), period (.) or semicolon (;)
  538.      in the first column of a config line indicates that the entire line is
  539.      to be used as a comment.  Comments may also be used after an option by
  540.      separating them by at least one space.  For example:
  541.           ┌─────────────────────────────────────────────────────────┐
  542.           │;  A SAMPLE FCE CONFIG FILE                              │
  543.           │/f=35       ; this sets fuzzy level to 35%               │
  544.           │/cls=60     ; this sets comment length to 60 characters  │
  545.           └─────────────────────────────────────────────────────────┘
  546.      There are several config files included with this copy of FCE.  They
  547.      contain field offsets and lengths for various BBS systems and internet
  548.      host systems.  You can TYPE them from dos.
  549.  
  550. /EMS=#
  551.      Restricts expanded memory usage to # Kbytes.  Normally, EMS is used
  552.      only as a last resort.  At a maximum, FCE will use up about 2
  553.      megabytes of EMS.  If you want to disable all EMS related routines,
  554.      use: /EMS=0.
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595. FCE version 1.0  Reference Manual                                   Page: 8
  596. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  597.  
  598. COMMAND LINE EXAMPLES
  599. ───────────────────────────────────────────────────────────────────────────
  600. Many combinations of the command syntax are possible.  You can try out
  601. some of the following examples.  The sample files MYFILES.TXT and
  602. BBSFILES.LST are included in this package.
  603.  
  604. FCE MYFILES.TXT BBSFILES.LST
  605.      Compares all filenames in myfiles.txt to those in bbsfiles.lst. 
  606.      Because no output file is specified, the input file myfiles.txt
  607.      becomes the output file.
  608.  
  609. FCE MYFILES.TXT BBSFILES
  610.      Compares all filenames in myfiles.txt to those in bbsfiles.lst.  The
  611.      extension ".lst" is added automatically.
  612.  
  613. FCE C:\DL\*.ZIP BBSFILES
  614.      Directory listing of all *.zip files is stored in filelist.txt which
  615.      serves as the inputfile and output file.
  616.  
  617. FCE C:\DL\*.ZIP BBSFILES FINAL.TXT
  618.      Directory listing of all *.zip files is stored in filelist.txt which
  619.      serves as the inputfile.  Output is stored in final.txt.
  620.  
  621. FCE C:\DL\*.* C:\OLD\*.* C:\NEW\*.* BBSFILES FINAL.TXT
  622.      Directory listing of all file of the directories \dl \old \new are
  623.      stored in filelist.txt which serves as the input file.  Output is
  624.      stored in final.txt.
  625.  
  626. FCE MYFILES.TXT C:\DL\*.* BBSFILES FINAL.TXT
  627.        The input file myfiles.txt is appended with a listing of all
  628.        files in c:\dl.  The new version of myfiles.txt is compared
  629.        to filenames in bbsfiles.lst and the output is stored in
  630.        final.txt.
  631.  
  632. FCE MYFILES.TXT BBSFILES.LST /C=PCBOARD.CFG
  633.      Reads configuration file pcboard.cfg which contains parameters for
  634.      scanfile.
  635.  
  636. FCE MYFILES.TXT BBSFILES.LST /IM /F=50 /COS=30
  637.      Indicates exact matches, sets fuzzy match level to 50%, and sets the
  638.      comment offset in scanfile to 30 characters.
  639.  
  640. FCE BBSFILES.LST MYFILES.TXT NEEDHAVE.TXT /IF /CLS=0
  641.      Compares filenames in bbsfiles.lst to myfiles.txt and creates a file
  642.      called needhave.txt.  An asterisk is placed beside each filename that
  643.      matches.  The /CLS=0 option insures that no comments will be copied. 
  644.      Notice that the order of the input and scan file have been reversed. 
  645.      In this way, FCE can also be used as a file comparison utility.
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661. FCE version 1.0  Reference Manual                                   Page: 9
  662. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  663.  
  664. FILE PROCESSING SCREEN (not available if you use the /M option)
  665. ───────────────────────────────────────────────────────────────────────────
  666. The screen is organized into three windows: information, statistics, and
  667. output.  The output window, though not labeled, is the one in the center of
  668. the screen.  The bottom line of screen displays the name of the task
  669. currently being executed:  analyzing, indexing, sorting, searching, and
  670. copying.
  671.  
  672. At the bottom right of the screen there are various spinning symbols
  673. informing you that work is in progress.  They are pretty neat looking...
  674. if you have an EGA/VGA display.  The icon rotation speed is synchronized
  675. with the system clock so that it does not vary with the CPU speed.
  676.  
  677. Information on statistics:
  678. Exact Matches:  Count of identical matches
  679. Fuzzy Matches:  Count of partial matches (meeting /F=# value)
  680. Lines Written:  Count of modified lines written to the output file
  681. Lines Analyzed: Count of lines looked at in input file
  682. Success:        Percentage of matching filenames
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689. ERROR MESSAGES
  690. ───────────────────────────────────────────────────────────────────────────
  691. Error messages are reported on the screen as well as in the ERRORLEVEL
  692. system variable in dos.  A successfull run will set ERRORLEVEL to 0.
  693.  
  694. 1: SCAN FILE TOO LARGE
  695.      The scan file contains too many lines.  You must split the file into a
  696.      smaller size.
  697.  
  698. 2: INSUFFICIENT CORE/EXPANDED MEMORY
  699.      The scan file contains too many lines.  You can either split the file
  700.      into a smaller size or remove some memory-resident programs.
  701.  
  702. 3: CANNOT ACCESS INPUT FILE
  703.      The file does not exist, or there is some other access problem.
  704.  
  705. 4: CANNOT ACCESS SCAN FILE
  706.      The file does not exist, or there is some other access problem.
  707.  
  708. 5: CANNOT CREATE TEMPORARY FILE
  709.      There is some problem while trying to create the file.  There may not
  710.      enough free disk space on the currently logged drive.
  711.  
  712. 6: CANNOT CREATE OUTPUT FILE
  713.      There is some problem while trying to create the file.  There may not
  714.      enough free disk space on the currently logged drive.  An invalid
  715.      filename and/or path may have been specified.
  716.  
  717. 7: CANNOT ACCESS INPUT FILE
  718.      The file does not exist, or there is some other access problem.
  719.  
  720. 8: CANNOT ACCESS CONFIG FILE
  721.      The file does not exist, or there is some other access problem.
  722.  
  723. 9: INVALID COMMAND LINE OPTION
  724.      An invalid option has been specified on the command line.
  725.  
  726.  
  727. FCE version 1.0  Reference Manual                                  Page: 10
  728. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  729.  
  730. 10: INVALID CONFIG FILE OPTION
  731.      An invalid option has been specified in the config file.
  732.  
  733.  
  734. 11: DISK READ/WRITE FAILURE
  735.      A disk error has occurred.  There may not be enough disk space.
  736.  
  737. 12: EXPANDED MEMORY CORRUPT
  738.      There is problem with the EMS system.  Reboot and try again.  Or
  739.      disable the EMS option by specifying /EMS=0.
  740.  
  741. 13: INVALID PATHNAME OR FILESPEC
  742.      An invalid pathname or wildcard combination has been specified.
  743.  
  744. 14: GUMBY ERROR
  745.      Critical Error: Please contact the author if you see this message.
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752. PROJECT HISTORY
  753. ───────────────────────────────────────────────────────────────────────────
  754. FCE was originally written because I was transferring some archives to a
  755. different tape format, and I did not feel like retyping each comment.  A
  756. friend suggested that it may be a handy tool.  After some additions,
  757. FCE v1.0 "became".  This was a part time project for me, and as such I
  758. do not have any plans to expand it.  However, I will fix bugs and minor
  759. annoyances... time permitting.
  760.  
  761.  
  762.  
  763.  
  764.  
  765. SOURCE CODE
  766. ───────────────────────────────────────────────────────────────────────────
  767. FCE was written using Borland C++ v2.0.  If you would like to purchase a
  768. copy of the source code, please contact me at the addresses listed at the
  769. start of this document.  The source code contains ORIGINAL techniques
  770. relating to:
  771.  
  772.               ■ EGA/VGA font redefinition
  773.               ■ Database style indexed retrieval system
  774.               ■ Non-recursive Quick Sort algorithm
  775.               ■ Fuzzy search algorithm
  776.               ■ Interrupt driven spinner routines
  777.               ■ EMS interface library
  778.               ■ Other interesting C tools...
  779.  
  780. The program is written in standard C with some inline assembly language.
  781. It should be compatible with Microsoft C after minor modifications.
  782.  
  783.  
  784.  
  785. TRADEMARKS
  786. ───────────────────────────────────────────────────────────────────────────
  787. Desqview is a trademark of Quarterdeck Systems.
  788. Borland C++ is a trademark of Borland International.
  789. Windows and Microsoft C are a trademarks of Microsoft Corp.
  790.  
  791.  
  792.  
  793. FCE version 1.0  Reference Manual                                  Page: 11
  794. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  795.  
  796. REVISION HISTORY
  797. ───────────────────────────────────────────────────────────────────────────
  798. August 30, 1991    Version 1.0    Initial Release
  799.  
  800.  
  801.  
  802.