home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / wps / utils / contrast / contrast.doc < prev    next >
Encoding:
Text File  |  1991-02-17  |  5.4 KB  |  151 lines
  1. ************ CONTRAST help ***************
  2.  
  3. Usage: CONTRAST [file1] [file2]
  4.  
  5.     If given no parameters (or just one), Contrast will bring up a dialog asking
  6. for 2 files. The files can be specified as for COMP, i.e. directories for both
  7. files default to the current one, and the second filename defaults to the first.
  8. If Contrast cannot open the files for some reason, it will bring up the dialog
  9. again. In this case, click Cancel if you want to exit from the program.
  10.  
  11.     To exit Contrast, press F3 or select Exit from the File pulldown.
  12.  
  13.     To scroll the displayed file, use either the cursor keys or the scroll bars.
  14. The mouse has no effect on either the text area, or the bar chart.
  15.  
  16. What it does:
  17.  
  18.     Contrast compares two files on disk and notes lines that are common to both.
  19. A bar chart is drawn, giving an overall view of which lines match, and the text
  20. of either file, or a composite file, is displayed. The default view is the
  21. composite file. Colours indicate which lines are common, and which unique.
  22.  
  23. Bar Chart
  24.  
  25.    The bar chart is a graphical representation of the two real files. Blocks of
  26. common lines are assigned a colour different from those around them, and drawn
  27. on the bars representing the files; a line links the matched blocks. The colours
  28. in the bar chart are used as the text colour for the file display; unmatched
  29. lines are written in black, and displayed in red or yellow on the chart. Black
  30. marks by the bar chart show where the current text display is in the files.
  31.  
  32. Composite
  33.  
  34. The composite file is made from the two files, using the common lines
  35. where possible.
  36.     Common lines have a white background.
  37.     Lines unique to File A are shown in black on yellow.
  38.     Lines unique to File B are shown in black on red.
  39.  
  40.     Where a block of lines in File B has been moved from where it was in File A
  41. the program has to guess whether block 1 was moved up past block 2 or block 2
  42. moved down past block 1. It shows the larger block as common and the other as
  43. moved in each file. The text shown as moved is drawn in a dark colour (not
  44. black) on yellow or red.
  45. The bar chart shows the connections.
  46.  
  47. Colours
  48.  
  49. Text Background
  50.   Yellow
  51.     Lines unique to File A (or moved in File A)
  52.     Used in bar chart and as text background.
  53.   Red
  54.     Lines unique to File B (or moved in File B)
  55.     Used in bar chart and as text background.
  56.   White
  57.     Lines common to File A and File B
  58.     Text background only.
  59. See Composite for how moved blocks are coloured.
  60.  
  61. Text Foreground
  62.   Dark blue
  63.   Dark pink
  64.   Dark green
  65.   Dark cyan
  66.     Text that has been matched in both files. The same colour is used for the
  67.     identical text in each file; the choice of colour is such that surrounding
  68.     blocks of matched lines use different ones. The same colour is used in the
  69.     bar chart to show the lines.
  70.   Black
  71.     Unmatched text.
  72.  
  73. File Selection Dialog
  74.  
  75.     The File Selection dialog asks you to enter the names of the two
  76. files to be contrasted. The default drive, and default paths for any drive
  77. used, are assumed if none are specified. Parent directories may be refered to
  78. as '..'. File B can be given just as a directory. In this case the file name
  79. and extension are taken as being the same as File A.
  80.  
  81. Problem Message Box
  82.  
  83.     The Problem message box informs the user of a problem in the
  84. program. This may or may not be fatal. The user is required to acknowledge the
  85. message; the program will take appropriate action.
  86.  
  87. File Menu
  88.  
  89. The File menu contains the following items:
  90.   File A
  91.   File B
  92.     Displays the text of the appropriate file.
  93.   Composite
  94.     Displays the composite file.
  95.   Open
  96.     Allows new files for contrasting to be specified.
  97.   Exit
  98.     Closes the Contrast program.
  99.  
  100. Help Menu (OS/2 1.2 version only)
  101.  
  102. The Help menu contains the following items:
  103.   Help for help
  104.     Explains the use of the help functions.
  105.   Extended help
  106.     Displays general help on the Contrast program.
  107.   Keys help
  108.     Displays help on the keys that can be used in the Contrast program.
  109.   Help index
  110.     Displays a list of selectable help topics.
  111.   About
  112.     Displays useless information about the application.
  113.  
  114. Keys for Contrast
  115.  
  116. The Contrast program assigns the following special functions to keys:
  117.   Alt+A
  118.   Alt+B
  119.     Display file A or B
  120.   Alt+C
  121.     Display the composite file
  122.   Alt+L
  123.   Alt+T
  124.     Ignore leading or trailing blanks for line comparison. Use the Options
  125.     menu to see the current status.
  126.   F3
  127.     Exit the Contrast program.
  128.   Arrow keys
  129.   Page Up
  130.   Page Down
  131.     Scroll the displayed file.
  132.  
  133. Options Menu
  134.  
  135.     The Options menu contains the following items:
  136.   Ignore leading blanks
  137.     Re-contrasts the files, with white space at the beginning of lines ignored.
  138.     Any formatting of programs will thus be irrelevant.
  139.   Ignore trailing blanks
  140.     Ignores white space at the end of lines. Some editors can be inconsistent
  141.     about leaving this in files.
  142.  
  143. Font Menu
  144.  
  145.     The Font menu allows up to three different point sizes of text
  146. to be used to display the file, if present on the system. All of these are
  147. Courier fonts, which are fixed-pitch, i.e. all characters are of equal width.
  148. If no Courier font is available, the program will use the System Proportional
  149. font, but text alignment will suffer as a result. Since font use is different
  150. for OS/2 1.1, it always seems to come up with the system proportional font.
  151.