home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 7 / 07.iso / c / c500 / 3.ddi / WPROFHLP.WPK / WPROF.HLP
Encoding:
Text File  |  1992-05-28  |  33.7 KB  |  829 lines

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