home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / utility / fc11a.zip / FC.DOC < prev    next >
Text File  |  1992-10-02  |  7KB  |  158 lines
  1.  
  2.     FC.DOC        - Readme File for FC File Compare Utility
  3.  
  4.     Copyright (C) Davis Augustine, 1991.  All rights reserved.
  5.  
  6.     Last Modified:    2oct92.  Version 1.1a
  7.  
  8. Files
  9. -----
  10.     FC.COM    - The program
  11.     FC.DOC    - This documentation file
  12.  
  13.  
  14. Description
  15. -----------
  16.     FC is a utility for comparing DOS text files.  Its features
  17. include:
  18.     Speed.
  19.     Side-by-side or over-and-under display.
  20.     Case sensitivity can be enabled and disabled.
  21.     Can show equal lines instead of non-equal.
  22.     Can show equal lines and non-equal in side-by-side display.
  23.     Whitespace sensitivity can be enabled and disabled.
  24.     Wildcard and directory names allowed as the second filename.
  25.     Can page the output so it doesn't scroll off the screen.
  26.     And more.
  27.  
  28.  
  29. Installation
  30. ------------
  31.     Just copy FC.COM to your \BIN directory or wherever you keep
  32. utility programs.
  33.  
  34.  
  35. Help Screen (-h switch)
  36. -----------------------
  37. Usage:    fc [-?hbceilnpqwx] [-m N] F1 F2
  38.     -?h   Display this help message
  39.     -b      Skip blank lines (don't try to match them)
  40.     -c      Case sensitive comparison
  41.     -e      Display equal lines instead of unequal ones
  42.     -i      Display program information
  43.     -l      Display shareware license
  44.     -m N  Match N lines to realign files (Default is 3)
  45.     -n      Suppress line numbering
  46.     -p      Page the output (enter/space/tab/esc = line/page/flush/quit)
  47.     -q      Quit when first difference found
  48.     -w      Skip whitespace (don't try to match it)
  49.     -x      Cross-wise output
  50.  
  51.  
  52. Info Screen (-i switch)
  53. -----------------------
  54.       ********** FC PROGRAM INFORMATION **********
  55.  
  56. REQUIREMENTS:
  57.     FC runs on any x86 processor, under any version of DOS.  It does not
  58. access floating point or expanded or extended memory.  The minimum amount
  59. of memory needed for FC to execute in is only about 32K.
  60.  
  61. EXIT VALUES:
  62.     For people who write batch files using "if ERRORLEVEL..." statements,
  63. FC returns 0 if the files are the same, 1 if they are different, and 2
  64. if there is some kind of error.
  65.  
  66. COMMAND LINE:
  67.     Switches start with '/' or '-', and can appear anywhere in the command
  68. line.  Anything else is considered a filename.    Two filenames must be given.
  69. The second can be an actual filename, a "wildcard" name, a directory or a
  70. disk drive.  Here are examples of each, with various switch settings:
  71.         fc    snoopy.doc  snoopy.bak
  72.         fc    -q  snoopy.doc    *.bak
  73.         fc    snoopy.doc  \backup  -p
  74.         fc    -m10  /x  snoopy.doc  D:
  75.  
  76. WHAT FC SHOWS (DEFAULT, -Q, -E):
  77.     Basically, FC compares the two files, skips matching lines and shows those
  78. lines which differ.  Under the -Q switch, FC stops when the first difference
  79. is found, shows the nonmatching line in each file, and then quits.  This is
  80. used when you want to know if two files match or not, but don't care to see
  81. the actual differing lines.  It may also be of use to batch file programmers.
  82. The -E switch is interesting but perhaps of questionable use.  It causes
  83. the equal lines to be displayed rather than the different ones.  It is most
  84. useful in combination with the -X switch (see below).
  85.  
  86. VERTICAL VS. SIDE-BY-SIDE (-X) DISPLAY, AND -N:
  87.     Normally, you will see a block of "unmatched" lines from file one, followed
  88. by the corresponding block of unmatched lines from file two.  Then another
  89. block from file one, and so on.  Lines are allowed to wrap around.  Lines
  90. are numbered, unless the -N switch is given.  The -X switch produces a
  91. "split screen" display, in which each file gets half of the screen and you
  92. can really see where the files disagree.  Finally, with both -X and -E set
  93. you get the equal lines and the side-by-side unequal lines, thus putting the
  94. differences in context.  (A future version will be able to do side-by-side
  95. between two screens at once: monochrome and EGA/VGA).
  96.  
  97. PAGING THE OUTPUT (-P):
  98.     This is FC's built-in "more" capability.  With the -P switch, it stops
  99. after one full screen is displayed and waits for a keystroke.  Press ENTER
  100. or DOWN ARROW to get the next line, SPACE or PAGE DOWN to get the next screen
  101. full, TAB to dump the rest without pausing, and ESCAPE or CONTROL-C to exit
  102. immediately.  (Currently, a 25 line screen is assumed.    A future version will
  103. automatically detect the screen height.)
  104.  
  105. CASE AND SPACE SENSITIVITY (-C, -B, -W):
  106.     By default, all text differences are reported.  You can tell FC to ignore
  107. certain kinds of differences, however.    The -C switch causes the compare to
  108. be case insensitive, so that "Once Upon a Time", and "onCE uPoN a TIME" would
  109. be considered the same lines.  The -B switch causes FC to ignore blank lines
  110. in either file.  -W means skip whitespace differences between words, so that
  111. a tab and a space (and all combinations of both) are considered the same.
  112.  
  113. RESYNC-ING (-M):
  114.     When FC runs into a difference between the files, it tries to find where
  115. the files "resync", or start being identical again.  Of course it is entirely
  116. subjective when the files are "identical again".  Is it a run of ten matching
  117. lines, or five, or one?  FC lets you set this threshold with the -M switch.
  118. The default identity test is 3 lines.
  119.  
  120. CAVEATS:
  121.     Comparing very long files which have nothing in common may cause FC to exit
  122. with the message "FC halted: no matching lines in N bytes".  This means that
  123. FC has searched as far as it can for a resync of the files without finding
  124. one.  There is probably no point in comparing the files anyway.
  125.  
  126.  
  127.  
  128. Shareware License (-L switch)
  129. -----------------------------
  130.           ********** FC SHAREWARE LICENSE **********
  131.  
  132.  This is a copyrighted software work which is distributed as shareware.
  133.  Under this license agreement you are granted the right to use FC on all
  134.  machines and environments that it supports.  You are also free (and
  135.  encouraged) to pass copies of this shareware on to others as long as it
  136.  is not for payment and not bundled with anything else that is for payment.
  137.  
  138.  To become a registered user and receive immediate notice of updates,
  139.  send a registration fee by check or money order of 25 dollars to:
  140.  
  141.                Davis Augustine
  142.                P.O. Box 610
  143.                Sausalito, CA. 94966-0610
  144.  
  145.  Please indicate the version of FC you have and where you got it from.
  146.  Commercial distribution licenses, source code and customized versions
  147.  are also available at reasonable rates.  Please write to the above address
  148.  or send me email at Compuserve id 72230,3053.  I would also appreciate any
  149.  comments, questions, suggestions or bug reports.
  150.  
  151.  
  152. Revision History
  153. ----------------
  154.  v1.1a     1oct92 - Change shareware mailing address
  155.  
  156.  v1.0b     2apr91 - First shareware release
  157.  
  158.