home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 7 / 07.iso / c / c495 / watcm953.arj / WPROFHLP.WPK / WPROF.HLP
Encoding:
Text File  |  1993-05-05  |  35.6 KB  |  887 lines

  1.           WATCOM Execution Profiler Help File
  2.           ═══════════════════════════════════
  3.  
  4. **********************************************************************
  5. *    Copyright by WATCOM International Corporation, 1989, 1993.   *
  6. *    All rights reserved. No part of this software may be         *
  7. *    reproduced in any form or by any means - graphic, electronic,*
  8. *    mechanical or otherwise, including, without limitation,         *
  9. *    photocopying, recording, taping or information storage and   *
  10. *    retrieval systems - except with the written permission of    *
  11. *    WATCOM International Corporation.                 *
  12. **********************************************************************
  13.  
  14. All help topics must be stored in order of the ASCII collating
  15. sequence.  Each topic is identified by a header consisting of a
  16. string of four colons followed by the topic name.  Any alphabetic
  17. characters must be entered in upper-case.
  18.  
  19. (ordering is based on stricmp() C run-time function which is operates
  20.  identically to:
  21.     stricmp( s1, s2 ) == strcmp( strlwr( s1 ), strlwr( s2 ) )
  22. ::::ABOUT
  23.              The WATCOM Execution Profiler
  24.              ═════════════════════════════
  25.  
  26.            WATCOM Execution Profiler Version 3.0
  27.     Copyright by WATCOM International Corp. 1989, 1993.
  28.     All rights reserved.
  29.     WATCOM is a trademark of WATCOM International Corp.
  30.  
  31. Technical Support:  phone:  (519) 886-3700
  32.             FAX:    (519) 747-4971
  33.             BBS:    (519) 884-2103 (8 bits/1 stop/no parity)
  34.  
  35. See also: <MAIN_HELP>
  36. ::::ABSOLUTE
  37.              Absolute Measurements
  38.              ═════════════════════
  39.  
  40. Absolute measurements are a result of using the total number of
  41. measurements for the entire execution of the program.  As such,
  42. these measurements reflect the total contribution of a region to
  43. the execution of the program.  Absolute measurements remain the
  44. same regardless of any adjustments to the visible region.
  45.  
  46. See also: <RELATIVE> <OPTION_HISTOGRAM_TYPE> <OPTION_PERCENTAGE_TYPE>
  47. ::::BACKOUT
  48.                 Backout
  49.                 ═══════
  50.  
  51. The zoom level will be changed to the previous zoom level. The
  52. previous select region will be identical to the select region that
  53. was used to zoom into the current level.  Successive applications of
  54. this operation will eventually result in the viewing of the entire
  55. program on the screen.
  56.  
  57. See also: <ZOOM> <ZOOM_MENU> <ZOOM_MODULE> <ZOOM_ROUTINE>
  58. ::::COLLECT_SAMPLES
  59.                Sample Collection
  60.                ═════════════════
  61.  
  62. The WATCOM Execution Profiler displays the results of a program
  63. execution that are stored in a sample file.  Sample files can be quite
  64. large so the progress of the profiler is displayed as it analyses the
  65. sample data.  The reading of the sample file can be aborted by hitting
  66. the Escape key.     A confirmation dialog will be displayed to allow
  67. reading of the sample file to continue.     If the reading of the sample
  68. file is aborted, the samples that have been read will be used for
  69. analysis purposes.
  70.  
  71. See also: <CONFIRMATION>
  72. ::::COMMAND_LINE_FORMAT
  73.               Command Line Format
  74.               ═══════════════════
  75.  
  76. The format for invoking the WATCOM Execution Profiler is:
  77.  
  78.     Usage:    wprof [sample_file]
  79.  
  80. See also: <DEFAULTS>
  81. ::::CONFIRMATION
  82.           Sample Collection Abort Confirmation
  83.           ════════════════════════════════════
  84.         
  85. The reading of the sample file has been interrupted by hitting
  86. the Escape key.     The Enter key can be used to confirm that the
  87. sample file should not be processed any further.  The Escape
  88. key will cancel the sample collection abort and continue the
  89. processing of the sample file.
  90.  
  91. See also: <COLLECT_SAMPLES>
  92. ::::CONTROL_MENU
  93.                   Control Menu
  94.                   ════════════
  95.  
  96. Online help can be requested through this menu.     A DOS session can
  97. also be started through this menu.  Changing the current option
  98. settings and asking about the WATCOM Execution Profiler can also
  99. be done through selecting menu items. Finally, the WATCOM Execution
  100. Profiler session can be terminated by selecting the final item.
  101. ::::CUT
  102.                   Cut
  103.                   ═══
  104.  
  105. The amount of information presented by the WATCOM Execution Profiler
  106. may be overwhelming to the user.  To combat this, the WATCOM Execution
  107. Profiler allows lines to be selectively removed from view.  A region
  108. may be selected and cut to accomplish this action.  The cut lines may
  109. be made visible or invisible, also.
  110.  
  111. See also: <CUT_MENU> <CUT_LINES_VISIBILITY> <UNCUT>
  112. ::::CUT_LINES_VISIBILITY
  113.             Making Cut Lines Hidden/Visible
  114.             ═══════════════════════════════
  115.  
  116. The display of lines that have been cut may be removed from view by
  117. the use of this operation.  To uncut the lines, this operation must
  118. be used to reveal cut lines.
  119.  
  120. See also: <CUT> <UNCUT> <CUT_MENU>
  121. ::::CUT_MENU
  122.                 Cut Menu
  123.                 ════════
  124.  
  125. The cut menu contains operations that deal with the "cutting" of lines
  126. that are displayed.  First of all, a line is either "cut" or normal.
  127. Furthermore, a "cut" line may be visible or invisible. The Cut Menu
  128. contains items that allow lines to be changed from normal to "cut"
  129. (by using the "Cut" item).  Lines may be changed from "cut" to normal
  130. by use of the "Uncut" menu item.  In order to uncut a line that has
  131. been cut, it must be visible.  Cut lines are usually invisible but
  132. they can be made visible by using the "Cut Lines Hidden/Visible" menu
  133. item to toggle between these two states.
  134.  
  135. See also: <CUT> <UNCUT> <CUT_LINES_VISIBILITY>
  136. ::::DEFAULTS
  137.              Configuration Defaults
  138.              ══════════════════════
  139.  
  140. The following defaults are used:
  141.  
  142. * Sample file extension: ".smp"
  143. * Executable file extension: ".exe"
  144. * Source file extension: ".c"
  145. * Source path:    Current directory
  146. * Sample counts are shown for each line
  147. * Lines with no samples are not shown
  148. * Lines with no overlay requests or program marks are not shown
  149. * Absolute percentages are shown for each line
  150. * Histogram indicates relative percentages
  151. * Mixing of source lines within the assembly lines
  152. * Operation code bytes are not shown for assembly lines
  153.  
  154. See also: <SOURCE_PATH> <OPTIONS>
  155. ::::DRIVE_SELECT
  156.               Select Current Drive
  157.               ════════════════════
  158.  
  159. Enter the drive letter for the drive that you would like to use
  160. in a directory selection.
  161. ::::ERROR
  162.                  Errors
  163.                  ══════
  164.  
  165. Various types of error conditions may arise during the execution of
  166. the WATCOM Execution Profiler.    These errors are reported and must be
  167. acknowledged.  The severity of the error may require the termination
  168. of the WATCOM Execution Profiler after the error is acknowledged.
  169.  
  170. See also: <TECHNICAL_SUPPORT>
  171. ::::FILE
  172.                   File Browser
  173.                   ════════════
  174.  
  175. The File Browser may be used in situations where a file is required
  176. for continuation of the program or an output file name is required
  177. by the WATCOM Execution Profiler.  If you press the F2 key, a
  178. file name browser will pop up to allow you to select a file without
  179. typing in the full name.
  180.  
  181. See also: <LOAD_OPTIONS> <SAVE_OPTIONS>
  182. ::::FILE_ENTRY
  183.                Enter a file name
  184.                ═════════════════
  185.  
  186. A file name is required at this point.    Depending on the context
  187. an existing file may be required.  In this case, press the F2 key
  188. in bring up a file browser so that errors are minimized.  If a new
  189. file has to be specified, use the browser to select the desired
  190. directory and type in the name.
  191.  
  192. See also: <FILE>
  193. ::::HELP
  194.                How to use the HELP System
  195.                ══════════════════════════
  196.  
  197. You are now looking at Help text which can be used to help you
  198. understand the particular component that you are now using.
  199.  
  200. When the text is too long to be displayed, you can view the next
  201. screenful by pressing the key labelled "PgDn" or "Page Down".
  202. Similarly, the preceding screenful can be viewed by pressing "PgUp" or
  203. "PageUp".
  204.  
  205. Sometimes the Help text contains references to other text such as
  206. <INDEX> which will allow you to obtain Help about another topic (in
  207. this case, to display the index of help topics for your current
  208. software package). When there is only one such reference visible on
  209. the screen, pressing the Enter key will cause that Help topic to be
  210. displayed. When there is a number of references, the current topic
  211. will be displayed when the Enter key is pressed. You can change the
  212. current topic by successively pressing the TAB-FORWARD, TAB_BACKWARD,
  213. or any of the cursor-positioning keys (denoted with arrows on your
  214. keyboard).
  215.  
  216. While Help text is being displayed, you can obtain this Help text by
  217. pressing the F1 key. Similary, if you press the F2 key, then an index
  218. for your software will be displayed.
  219.  
  220. When you have displayed more than one topic, you can return to the
  221. most recently viewed topic by pressing the F4 (Previous Topic) key.
  222.  
  223. If your computer has a mouse attached to it, the mouse can be used in
  224. the Help system, with the scroll bar on the right (see <SCROLL_BAR>)
  225. or to select a topic (press and release the leftmost button of the
  226. mouse while the mouse cursor is located on the topic). A scroll bar is
  227. visible only when the current topic is too long to be displayed on the
  228. screen.
  229.  
  230. See also: <MAIN_HELP> <MENUS> <HOT_SPOTS> <MOUSE>
  231. ::::HOT_SPOTS
  232.                    Hot spots
  233.                    ═════════
  234.  
  235. Hot spots are areas on the screen which contain text indicating
  236. function keys or special keys such as Escape or Enter. You can see a
  237. number of areas at the bottom of the area for this help text.
  238.  
  239. If you have a mouse, clicking the mouse on a hot spot is equivalent to
  240. pressing the indicated key. If you don't have a mouse, then these
  241. areas cannot be used (instead, use the indicated keys from the
  242. keyboard to activate the function).
  243.  
  244. See also: <HELP> <MAIN_HELP> <MENUS> <MOUSE>
  245. ::::INDEX
  246.                  Profiler Index
  247.                  ══════════════
  248.  
  249. Select the topic on which you need help:
  250. <ABOUT>               <ABSOLUTE>        <BACKOUT>
  251. <COMMAND_LINE_FORMAT>  <CONTROL_MENU>        <CUT>
  252. <CUT_LINES_VISIBILITY> <CUT_MENU>        <DEFAULTS>
  253. <LISTING>           <MARKS>            <MODE_MENU>
  254. <OPERATIONS_MENU>      <OPTIONS>        <OVERLAYS>
  255. <PATH_EDIT>           <QUIT>            <RELATIVE>
  256. <SAMPLES>           <SOURCE_PATH>        <SYSTEM>
  257. <TECHNICAL_SUPPORT>    <THREADS>        <TIME_RANGE>
  258. <UNCUT>               <ZOOM>            <ZOOM_MENU>
  259. <ZOOM_MODULE>           <ZOOM_ROUTINE>
  260.  
  261. See also: <MENUS> <HOT_SPOTS> <MOUSE> <SCROLL_BAR>
  262.       <HELP> <MAIN_HELP>
  263. ::::LISTING
  264.                 Analysis Listing
  265.                 ════════════════
  266.  
  267. A file will be generated that lists modules and routines along with
  268. their associated sample counts. In addition, a summary of the sampled
  269. execution will be saved in this file. There are two parts to the
  270. listing of the analysis:
  271.  
  272. (1) Modules listed in sorted order according to the number of samples
  273. (2) Modules with their contained routines (sorted as in (1))         
  274.     
  275. There are three choices for the listing file format.  It may be 
  276. written as a straight text file or as a Lotus 1-2-3 file.  In 
  277. addition, the user can choose to produce a listing file containing 
  278. only the information which is currently displayed on the screen.
  279.  
  280. See also: <OPERATIONS_MENU> <THREAD_SELECTION> <TIME_RANGE>
  281.       <PATH_EDIT>
  282. ::::LISTING_METHOD
  283. No help text is available.
  284. ::::LOAD_OPTIONS
  285.                   Load Options
  286.                   ════════════
  287.  
  288. The current settings for options and hidden lines may be saved for
  289. future use through a configuration file.  The state of the WATCOM
  290. Execution Profiler may be loaded in the options form.
  291.  
  292. See also: <OPTIONS>
  293. ::::MAIN_HELP
  294.             How to use the Profiler
  295.             ═══════════════════════
  296.  
  297. The WATCOM Execution Profiler takes the information from the sample
  298. file (which records a single session of a program's execution) and
  299. displays the results in a graphical form.  Regions of concentrated
  300. activity are visible and can be explored by zooming into the regions
  301. in question.  The quantities measured in the graphical display may be
  302. either samples, overlay loads, or program marks.  Successive zoom
  303. levels increase the detail from modules to routines to source lines
  304. and finally to assembly code.  The zoom levels may be backed out of
  305. in order to try new possibilities.  The interactive nature of the
  306. WATCOM Execution Profiler is an important feature because learning
  307. about the behaviour of the profiled program should be as enjoyable
  308. as possible to encourage experimentation and innovation in attacking
  309. the problems of improving performance.
  310.  
  311. See also: <SAMPLES> <OVERLAYS> <MARKS> <ZOOM> <BACKOUT> <CUT> <UNCUT>
  312. ::::MARK_SELECTION
  313.                  Mark Selection
  314.                  ══════════════
  315.  
  316. In order to set a time range accurately, a program may insert "marks"
  317. into the sample file so that the sample file contains a record of
  318. the exact time that the execution reached a certain point in the
  319. program.  These marks may be used to set the time range used in the
  320. analysis.  The Mark Selection dialogue box contains any program marks
  321. that are valid in the time range.  A time is displayed for each
  322. program mark.  A mark/time can be selected by using the cursor keys
  323. to move the highlighted line to the desired mark/time and pressing
  324. Enter.    The mouse can be used to select a mark/time by pressing and
  325. releasing the left-most mouse button while the cursor is on top of
  326. the desired mark/time.
  327.  
  328. See also: <TIME_RANGE>
  329. ::::MARKS
  330.                  Program Marks
  331.                  ═════════════
  332.  
  333. Program marks can be inserted by the programmer to delimit phases
  334. of the program.     The WATCOM Execution Sampler will save any program
  335. mark strings in the sample file along with the time that the mark
  336. occurred during the execution.    The WATCOM Execution Profiler makes
  337. use of this information to display how many marks where initiated
  338. during the execution of the program. The display can be refined by
  339. zooming into regions so that the exact sequence of assembly
  340. instructions that initiated the program mark can be identified.
  341.  
  342. See also: <SAMPLES> <OVERLAYS> <TIME_RANGE>
  343. ::::MENUS
  344.                 How to use Menus
  345.                 ════════════════
  346.  
  347. When you start an application, you are presented with a "menu bar" on
  348. the first line of the screen. Each of the names on that line
  349. represents a menu of actions that you can request.
  350.  
  351. Using the keyboard
  352. ══════════════════
  353.  
  354. You can pull down one of the menus by pressing the Alt key and the
  355. space bar simultaneously. You can then cycle through the menus by
  356. pressing the cursor-right or cursor-left keys.
  357.  
  358. When a menu is first pulled down, the first item in the menu is
  359. highlighted to indicate that it is the current item. You can press the
  360. cursor-down or the cursor-up keys to change the current item.
  361.  
  362. If you wish to cancel the menu-selection process, press the Escape key
  363. (Esc) and the current menu will disappear. If you wish to select one
  364. of the actions, use the cursor-up and/or cursor-down keys to make that
  365. action the current item (the high-lighted one) and then press the
  366. Enter key.
  367.  
  368. ALT key and a letter
  369. ════════════════════
  370.  
  371. When no menus have been pulled down, pressing the Alt key and a letter
  372. key simultaneously will pull down the menu for the first word on the
  373. menu bar that starts with that letter.
  374.  
  375. When a menu is pulled down, pressing the Alt key and a letter key
  376. simultaneously will select the first item in the menu that starts with
  377. that letter.
  378.  
  379. Using the mouse (see also <MOUSE>)
  380. ══════════════════════════════════
  381.  
  382. The menu for an item on the menu bar will be pulled down when you
  383. press the leftmost mouse button while the mouse cursor is within that
  384. item. To select an item from the menu, drag the mouse (move the mouse
  385. without releasing the mouse button) so that the mouse cursor is within
  386. the item to be selected and then release the mouse button.
  387.  
  388. Once a menu has been pulled down, if you drag the mouse to another
  389. word on the menu bar, then the menu for the new word is pulled down.
  390. The menu for the old word will disappear.
  391.  
  392. If you decide that you wish to cancel the menu-selection process, be
  393. careful to release the mouse button while the mouse cursor is
  394. positioned anywhere except within an item in the menu that is pulled
  395. down.
  396.  
  397. See also: <HELP> <MAIN_HELP> <HOT_SPOTS> <MOUSE>
  398. ::::MODE_MENU
  399.                    Mode Menu
  400.                    ═════════
  401.  
  402. The Mode menu is used to switch between the three different types of
  403. measurements that can be displayed by the WATCOM Execution Profiler.
  404. These measurements are: samples, overlay loads, and program marks.
  405.  
  406. See also: <SAMPLES> <OVERLAYS> <MARKS>
  407. ::::MOUSE
  408.                 Using the Mouse
  409.                 ═══════════════
  410.  
  411. General Information
  412. ═══════════════════
  413.  
  414. The mouse is a pointing device. As you move the mouse, the mouse
  415. cursor (a rectangular box) will move correspondingly about the screen.
  416. Moving the mouse, without pressing any of the button(s) on it has no
  417. effect except to move the mouse cursor.
  418.  
  419. The first mouse button (the leftmost one) or the only one, depending
  420. upon the particular mouse that you have, is used to signal the
  421. pointing interaction. When you press the button, you are starting a
  422. mouse interaction that is completed when you release that button. The
  423. particular interaction depends on the location of the mouse cursor
  424. when you press the mouse.
  425.  
  426. The term "click the mouse" means to press and then to immediately
  427. release the leftmost button on the mouse without moving it. Typically,
  428. you click the mouse to select an item or to invert the value of a
  429. check field.
  430.  
  431. The term "drag the mouse" means to move the mouse while the mouse
  432. button is depressed. Typically, you drag the mouse while a mouse
  433. interaction is not yet complete.
  434.  
  435. Using the mouse with menus (see also <MENUS>)
  436. ═════════════════════════════════════════════
  437.  
  438. The menu for an item on the menu bar will be pulled down when you
  439. press the leftmost mouse button while the mouse cursor is within that
  440. item. To select an item from the menu, drag the mouse (move the mouse
  441. without releasing the mouse button) so that the mouse cursor is within
  442. the item to be selected and then release the mouse button.
  443.  
  444. Once a menu has been pulled down, if you drag the mouse to another
  445. word on the menu bar, then the menu for the new word is pulled down.
  446. The menu for the old word will disappear.
  447.  
  448. If you decide that you wish to cancel the menu-selection process, be
  449. careful to release the mouse button while the mouse cursor is
  450. positioned anywhere except within an item in the menu that is pulled
  451. down.
  452.  
  453. Using the mouse with Hot Spots
  454. ══════════════════════════════
  455.  
  456. Hot spots are areas on the screen which contain text indicating
  457. function keys or special keys such as Escape or Enter. You can see a
  458. number areas at the bottom of the area for this help text.
  459.  
  460. If you have a mouse, clicking the mouse on a hot spot is equivalent to
  461. pressing the indicated key. If you don't have a mouse, then these
  462. areas cannot be used (instead, use the indicated keys from the
  463. keyboard to activate the function).
  464.  
  465. Using the mouse while editing
  466. ═════════════════════════════
  467.  
  468. If you click the mouse on an editable field into which data can be
  469. typed, the keyboard cursor is positioned to the field. The keyboard
  470. position is identical to the position of the mouse cursor if there is
  471. a non-blank character at that position or to the right of that
  472. position; otherwise, the keyboard cusror is positioned immediately
  473. following the right-most non-blank character.
  474.  
  475. If you click the mouse on a check field, the value of the field is
  476. changed. A check field is preceded by "(*)" to indicate that the value
  477. is true and by "( )" to indicate a false value.
  478.  
  479. If you click the mouse on a radio button, that button becomes the
  480. active button (and the previous active button becomes inactive). The
  481. active radio button is indicated by "[X]" at the start of the field;
  482. other buttons in that set of radio buttons will start with "[ ]".
  483.  
  484. In these cases, you don't actually have to click the mouse, although
  485. this is what you would normally do. To be more precise, you must press
  486. the mouse button while the mouse cursor is within the framed window
  487. containing the field in question. The button is released while the
  488. mouse cursor is within the field in question (the mouse could have
  489. been dragged to that field).
  490.  
  491. See also: <HELP> <MAIN_HELP> <MENUS> <HOT_SPOTS>
  492. ::::NODE_SELECT
  493.               Select Current Node
  494.               ═══════════════════
  495.  
  496. Enter the node name for the node that you would like to use
  497. in a directory selection.
  498. ::::OPERATIONS_MENU
  499.                 Operations Menu
  500.                 ═══════════════
  501.  
  502. The Operations menu is used for requesting miscellaneous operations.
  503. The four operations are: thread selection, time range adjustment,
  504. producing a listing file, and editting the source file path.
  505.  
  506. See also: <THREAD_SELECTION> <TIME_RANGE> <LISTING> <PATH_EDIT>
  507. ::::OPTION_ASSEMBLY_BYTES
  508.         Operation Code Bytes in Assembly Display
  509.         ════════════════════════════════════════
  510.  
  511. The display of assembly code may include the bytes that make up
  512. each instruction.  The display of sample measurements is not
  513. affected by this option.
  514.  
  515. See also: <OPTION_ASSEMBLY_SOURCE>
  516. ::::OPTION_ASSEMBLY_SOURCE
  517.             Source Code in Assembly Display
  518.             ═══════════════════════════════
  519.  
  520. The display of assembly code may include the source lines that
  521. were used to create the code.  The display of sample measurements
  522. is not affected by this option.
  523.  
  524. See also: <OPTION_ASSEMBLY_BYTES>
  525. ::::OPTION_HISTOGRAM_TYPE
  526.            Select Type Measured in Histogram
  527.            ═════════════════════════════════
  528.  
  529. The histogram can graphically display absolute or relative
  530. percentages.  The length of the histogram bar represents the
  531. percentage of samples for that particular line.     By default, the
  532. WATCOM Execution Profiler will display the relative percentages
  533. of each line with the histogram.
  534.  
  535. See also: <ABSOLUTE> <RELATIVE> <OPTION_PERCENTAGE_TYPE>
  536. ::::OPTION_NO_REQUESTS
  537.               Hide Lines with No Requests
  538.               ═══════════════════════════
  539.  
  540. Hide lines that did not make any overlay load requests or program
  541. marks.    An overlay load request may cause an actual load of code
  542. off disk or may already be satisifed because the section is already
  543. resident.  A line of code that inserts a program mark into the sample
  544. file is viewed in the same manner as a line of code that requests an
  545. overlay load in that all "requests" are displayed while non-requesting
  546. lines may be hidden.  Source code and assembly code are not hidden
  547. because the programmer has to be able to see the context of an
  548. overlay load during analysis.
  549.  
  550. See also: <OVERLAYS> <OPTION_NO_SAMPLES> <SAMPLES> <MARKS>   
  551. ::::OPTION_NO_SAMPLES
  552.                Hide Lines with no Samples
  553.                ══════════════════════════
  554.  
  555. Hide lines which do not have any samples associated with them.
  556. For source code and assembly code, there will be many lines with
  557. no samples recorded.  In this case, the WATCOM Execution Profiler
  558. will display the lines so that the intuitive nature of this option
  559. is preserved (hiding source code could cause problems in analysis
  560. by the programmer).
  561.  
  562. See also: <SAMPLES> <OPTION_NO_REQUESTS> <OVERLAYS> <MARKS>
  563. ::::OPTION_PERCENTAGE
  564.                Display Percentage
  565.                ══════════════════
  566.  
  567. A percentage for each line may be displayed.  The percentage can
  568. be either absolute or relative.     By default, the WATCOM Execution
  569. Profiler displays the absolute percentage for each line.
  570.  
  571. See also: <ABSOLUTE> <RELATIVE>
  572.       <OPTION_PERCENTAGE_TYPE> <OPTION_HISTOGRAM_TYPE>
  573. ::::OPTION_PERCENTAGE_TYPE
  574.           Change type of percentage displayed
  575.           ═══════════════════════════════════
  576.  
  577. A percentage for each line may be displayed.  The percentage can
  578. be either absolute or relative.     By default, the WATCOM Execution
  579. Profiler displays the absolute percentage for each line.
  580.  
  581. See also: <ABSOLUTE> <RELATIVE>
  582.       <OPTION_PERCENTAGE> <OPTION_HISTOGRAM_TYPE>
  583. ::::OPTION_SAMPLES
  584.                Display Number of Samples
  585.                ═════════════════════════
  586.  
  587. The number of samples recorded for each line can often be a valuable
  588. statistic.  By default, the WATCOM Execution Profiler will display
  589. the number of samples recorded for a particular line but if this is
  590. not required, it may be disabled.
  591.  
  592. See also: <SAMPLES> <OVERLAYS> <MARKS>
  593. ::::OPTIONS
  594.                 Options
  595.                 ═══════
  596.  
  597. The WATCOM Execution Profiler may be configured in a variety of
  598. manners to suit individual tastes and requirements.
  599.  
  600. See also:
  601. <OPTION_SAMPLES> <OPTION_NO_SAMPLES> <OPTION_NO_REQUESTS>
  602. <OPTION_PERCENTAGE> <OPTION_PERCENTAGE_TYPE> <OPTION_HISTOGRAM_TYPE>
  603. <OPTION_ASSEMBLY_BYTES> <OPTION_ASSEMBLY_SOURCE>
  604. ::::OVERLAYS
  605.                 Overlays
  606.                 ════════
  607.  
  608. The WATCOM Execution Sampler can recognize when an program requests
  609. an overlay.  The minimization of these overlay load requests is
  610. important for improving the speed and organization of overlaid
  611. programs.  The WATCOM Execution Profiler displays the number of
  612. overlay load requests that a region initiated.    The display can
  613. be refined by zooming into regions so that the exact sequence
  614. of assembly instructions that initiated the overlay load request
  615. can be identified.
  616.  
  617. See also: <SAMPLES> <MARKS>
  618. ::::PATH_BROWSE
  619.                Directory Browse 
  620.                ═════════════════
  621.  
  622. The source path browse feature allows the user to scan through all
  623. directory paths and select one.     This is useful for mouse users, in
  624. conjunction with the source path edit option.
  625.  
  626. Initially, the current active directory is displayed, along with all
  627. its immediate sub-directories.    Selecting a path (using either a mouse
  628. or keyboard commands) expands that directory, listing all its 
  629. subdirectories.     In this way, any valid path may be selected.
  630.  
  631. See also: <PATH_EDIT> <SOURCE_PATH>
  632. ::::PATH_EDIT
  633.                 Edit Source Path
  634.                 ════════════════
  635.  
  636. The source path is searched from the top to the bottom of the
  637. edittable list of directories.    The directory browser may be used
  638. to enter a directory into a line (useful for mouse users).  The
  639. directory browser can be activated by pressing F7 or its hot spot.
  640. The current highlighted line may be deleted by pressing F6.  A line
  641. can be inserted before the current line by pressing F5.     The F4 copy
  642. action will insert a line after the current line and copy the contents
  643. of the current line into the new line.    If you want to cancel any
  644. of your changes, press Escape. Pressing Enter will accept the changes
  645. made to the source file path.
  646.  
  647. See also: <SOURCE_PATH> <PATH_BROWSE> <OPERATIONS_MENU>
  648.       <THREAD_SELECTION> <TIME_RANGE> <LISTING>
  649. ::::PLOT
  650.                   Routine Plot
  651.                   ════════════
  652.    
  653. The Plot dialog displays the routine's sample behaviour over a
  654. period of time.     The histogram allows you to see whether most of
  655. the samples for a routine occured during a small amount of time
  656. or were evenly spread out during the execution of the program.
  657.  
  658. The vertical axis indicates the number of samples for a given unit
  659. of time while the horizontal axis indicates the time progression of
  660. the program.
  661. ::::PLOT_HISTORY
  662. No help text is available.
  663. ::::QUIT
  664.                Quit from Profiler
  665.                ══════════════════
  666.  
  667. The WATCOM Execution Profiler will exit and return to the system. All
  668. current settings will be lost unless they have been saved.
  669.  
  670. See also: <ABOUT>
  671. ::::RELATIVE
  672.               Relative Measurments
  673.               ════════════════════
  674.  
  675. Relative measurements are a result of using all of the measurements
  676. at the current level.  As such, these measurements reflect the
  677. contribution of the current region to the execution of the program.
  678. Relative measurements change whenever the level changes.
  679.  
  680. See also: <ABSOLUTE> <OPTION_HISTOGRAM_TYPE> <OPTION_PERCENTAGE_TYPE>
  681. ::::SAMPLES
  682.                 Samples
  683.                 ═══════
  684.  
  685. The WATCOM Execution Sampler sets up the system clock to periodically
  686. interrupt a program during its execution.  Every time the program is
  687. interrupted, the WATCOM Execution Sampler records the location in
  688. memory where the CPU was currently executing instructions.  This
  689. record of the program's activity at a certain point in time is called
  690. a sample.  Portions of the program that make up a substantial amount
  691. of the execution time will be interrupted many times because of the
  692. increased probability of being interrupted.  The WATCOM Execution
  693. Profiler makes use of the collection of addresses to grade regions
  694. of memory by the number of times the program was interrupted.  The
  695. statistical nature of this type of analysis makes it an ideal tool
  696. in identifying portions of the program that consume a lot of
  697. execution time.
  698.  
  699. See also: <OVERLAYS> <MARKS>
  700. ::::SAVE_OPTIONS
  701.                   Save Options
  702.                   ════════════
  703.  
  704. The current settings for options and hidden lines may be saved for
  705. future use through a configuration file.  The state of the WATCOM
  706. Execution Profiler may be saved in the options form.
  707.  
  708. See also: <OPTIONS>
  709. ::::SCROLL_BAR
  710.                   Scroll Bars
  711.                   ═══════════
  712.  
  713. A scroll bar is used when the information to be displayed is too large
  714. to fit in a display area. A scroll bar can be vertical (displayed up
  715. and down) when the information is too long and can be horizontal
  716. (displayed left and right) when the information is too wide.
  717.  
  718. The bar contains two symbols (called icons) at each end plus an area
  719. in the middle which contains a slider that is used to indicate the
  720. relative position of the information being displayed to the total
  721. information. When the display area is too small, the middle area and
  722. the page-up and page-down icons may be eliminated from the scroll bar.
  723.  
  724. If your computer does not have a mouse attached to it, the scroll bar
  725. is for display purposes only: it will indicate the relative position
  726. of the text being displayed. You can reposition the display text by
  727. pressing the PgUp, PgDn (TAB-FORWARD, TAB-BACKWARD) and the
  728. cursor-positioning keys (denoted with arrows on the keyboard).
  729.  
  730. When you can use a mouse, the scroll bar can be used to reposition the
  731. information being displayed. First, you must press the leftmost button
  732. of the mouse while the mouse cursor is located on the scroll bar. The
  733. position of the mouse cursor when you release the mouse, determines
  734. the repositioning. If the mouse cursor is not on the scroll bar at
  735. this point, no repositioning will take place. If the cursor is on the
  736. first icon at the top (left) of the scroll bar, the information will
  737. scroll down (right) one line (column). If the cursor is on the first
  738. icon at the bottom (right) of the scroll bar, the information will
  739. scroll up (left) one line (column). If the cursor is on the second
  740. icon at the top (left) of the scroll bar, the information will scroll
  741. down (right) by the size of the display area. If the cursor is on the
  742. second icon at the bottom (right) of the scroll bar, the information
  743. will scroll up (left) by the size of the display area. If the cursor
  744. is in the middle area of the scroll bar, the slider is positioned to
  745. indicate the position of the information to be displayed when the
  746. mouse button is released.
  747. ::::SOURCE_PATH
  748.                   Source Path
  749.                   ═══════════
  750.  
  751. A path specifies an ordering of directories so that files in other
  752. directories may be located. The WATCOM Execution Profiler makes use
  753. of a path for locating source files.  This feature is very similar
  754. to the WATCOM debugger WVIDEO's "SET SOURCE" command.
  755.  
  756. In the following examples, the * is replaced by the module name:
  757.  
  758.         C:\PROGRAM\C\*.C
  759.         F:\ANALYSIS\FOR\*.FOR
  760.         L:\LIBRARY\SRC              (*.C is assumed)
  761.  
  762. WPROF searches the current directory only if no source path is
  763. specified.
  764. ::::SYSTEM
  765.                  Exit to System
  766.                  ══════════════
  767.  
  768. Use this menu item if you wish to start a system session but do not
  769. want to lose your current work in the WATCOM Execution Profiler.
  770. You may return to the WATCOM Execution Profiler from the system
  771. session by typing the "exit" command.  The WATCOM Execution Profiler
  772. will continue executing normally upon completion of the system
  773. session.
  774. ::::TECHNICAL_SUPPORT
  775.              The WATCOM Execution Profiler
  776.              ═════════════════════════════
  777.  
  778.            WATCOM Execution Profiler Version 1.2
  779. Copyright by WATCOM Systems Inc. 1989, 1992. All rights reserved.
  780. WATCOM is a trademark of WATCOM Systems Inc.
  781.  
  782. Technical Support:  phone:  (519) 886-3700
  783.             FAX:    (519) 747-4971
  784.             BBS:    (519) 884-2103 (8 bits/1 stop/no parity)
  785.  
  786. See also: <MAIN_HELP>
  787. ::::THREAD_SELECTION
  788.                 Thread Selection
  789.                 ════════════════
  790.  
  791. All of the threads that were recorded during the execution of the
  792. program are displayed in the dialogue box.  A scroll bar is displayed
  793. if there are many threads.  The "YES" designation means that the
  794. particular thread's contributes to the execution analysis totals.
  795. A thread may be removed from the analysis by changing the "YES"
  796. designation to "no".  This can be done by toggling the particular
  797. thread's status when the thread's line is highlighted.    All of
  798. the threads may be excluded or included in the analysis.  These
  799. operations allow the user to set all threads to a particular status.
  800. At least one thread must be included in the analysis.
  801.  
  802. See also: <THREADS> <OPERATIONS_MENU> <TIME_RANGE> <LISTING>
  803.       <PATH_EDIT>
  804. ::::THREADS
  805.                 Threads
  806.                 ═══════
  807.  
  808. Some operating systems support multiple threads of execution in a
  809. program.  The WATCOM Execution Sampler records activity for each
  810. thread in the program.    The WATCOM Execution Profiler can make use
  811. of this information to allow a user to analyze a single thread's
  812. execution or a combination of threads' execution.  Initially, the
  813. WATCOM Execution Profiler will analyze the program with the data
  814. for all threads.  The threads that were recorded during execution
  815. can be viewed and adjusted for subsequent analysis.  Any subset
  816. of the recorded threads (that contains at least one thread) may
  817. be analyzed.
  818.  
  819. See also: <THREAD_SELECTION>
  820. ::::TIME_RANGE
  821.                    Time Range
  822.                    ══════════
  823.  
  824. Select the time range from which to select samples. The TAB keys
  825. switches between left and right. CTRL/LEFT and CTRL/RIGHT move the
  826. highlighted pointer on the bar left and right, respectively. Zoom
  827. and Backout control the resolution for time changes. Zoom will allow
  828. increased fine-tuning of the time range while Backout will move back
  829. to the previous level of coarse adjustment of the time range. Enter
  830. accepts the changes, and adjusts the samples, before returning to
  831. the main screen. Escape cancels the whole operation, and returns to
  832. the main screen.
  833.  
  834. See also: <MARK_SELECTION> <OPERATIONS_MENU> <THREAD_SELECTION>
  835.       <LISTING> <PATH_EDIT>
  836. ::::UNCUT
  837.                  Uncut
  838.                  ═════
  839.  
  840. This operation will restore the selected lines from being "cut" to
  841. normal status.    The cut lines must not be hidden for this operation
  842. to work because of the requirement for a selected region.
  843.  
  844. See also: <CUT_MENU> <CUT_LINES_VISIBILITY> <CUT>
  845. ::::ZOOM
  846.                   Zoom
  847.                   ════
  848.  
  849. The WATCOM Execution Profiler allows a region to be examined by
  850. zooming into it.  The zoom operation increases the amount of detail
  851. that is visible.  The detail changes from modules, to routines, to
  852. source lines, and finally to assembly code.  Successive applications
  853. of this operation will eventually result in the viewing of a small
  854. portion of the program in assembly code on the screen.
  855.  
  856. See also: <BACKOUT> <ZOOM_MENU> <ZOOM_MODULE> <ZOOM_ROUTINE>
  857. ::::ZOOM_MENU
  858.                    Zoom Menu
  859.                    ═════════
  860.  
  861. The Zoom Menu allows you to control the zooming operation. A single
  862. module or routine can be zoomed into through this menu. Zooming into
  863. and out of highlighted regions can also be done through these menu
  864. items.
  865.  
  866. See also: <ZOOM> <BACKOUT> <ZOOM_MODULE> <ZOOM_ROUTINE>
  867. ::::ZOOM_MODULE
  868.                   Module Zoom
  869.                   ═══════════
  870.  
  871. Programs with many different modules can prove cumbersome to work with
  872. during interaction with the WATCOM Execution Profiler.    It is with
  873. this in mind that a short-cut has been provided to quickly zoom into
  874. a module.  The module name may be typed in directly.
  875.  
  876. See also: <ZOOM> <BACKOUT> <ZOOM_MENU> <ZOOM_ROUTINE>
  877. ::::ZOOM_ROUTINE
  878.                   Routine Zoom
  879.                   ════════════
  880.  
  881. Programs with many different routines can prove cumbersome to work
  882. with during interaction with the WATCOM Execution Profiler.  It is
  883. with this in mind that a short-cut has been provided to quickly zoom
  884. into a routine.     The routine name may be typed in directly.
  885.  
  886. See also: <ZOOM> <BACKOUT> <ZOOM_MENU> <ZOOM_MODULE>
  887.