home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / PMVIEW5C.ZIP / PMVIEW.IPF < prev    next >
Text File  |  1992-04-06  |  19KB  |  453 lines
  1. :userdoc.
  2. :title.PM File View Help Facility
  3. .*
  4. :docprof.
  5. .*
  6. .* ----------------------------------------------------------------------
  7. .* Extended Help
  8. :h1 res=30002.Help for PM File View
  9. :i1 id=fvhelp.Help for PM File View
  10. :hp1.PM File View:ehp1. is a file browsing utility for the OS/2
  11. Presentation Manager.  It
  12. displays files either in ASCII or in hex (see
  13. :link res=42 reftype=hd.Display ASCII:elink.,
  14. :link res=43 reftype=hd.Display Hex-ASCII:elink., and
  15. :link res=44 reftype=hd.Display Hex-EBCDIC:elink.),
  16. and additionally permits
  17. searching by phrase or jumping directly to a specified point in a
  18. file (see
  19. :link res=30 reftype=hd.Find:elink.,
  20. :link res=31 reftype=hd.Repeat Find:elink., and
  21. :link res=32 reftype=hd.Goto:elink.).
  22. :p.
  23. :hp1.PM File View:ehp1. can be invoked either from an OS/2 window or from
  24. the full-screen command line.  If no filename is entered initially, or
  25. the filename contains wildcards,
  26. a dialog box is opened listing the available drives and files from
  27. which a file may be selected (see
  28. :link res=10 reftype=hd.Open:elink.).
  29. :hp1.PM File View:ehp1. can also be made
  30. a part of a Desktop Manager group, in which case it can be selected from
  31. a menu.  Adding the optional /i switch, either at the
  32. command line or as a parameter of the Program Properties menu, will
  33. load :hp1.PM File View:ehp1. with a specified filename and immediately
  34. shrink it to an icon at start-up, making the file information instantly
  35. available with the double-click of the mouse on the icon (see
  36. :link res=31001 reftype=hd.Command Line Options:elink.).
  37. Note that even if :hp1.PM File View:ehp1. is started from a menu with
  38. the "Minimized" Initial window size option selected, it will still be
  39. necesssary to specify the /i switch as a parameter to prevent the initial
  40. :hp2.File Open:ehp2. dialog box from popping up.
  41. :p.
  42. At any time, a file can also be viewed by "dragging" its file name from
  43. a File Manager list and
  44. "dropping" it on the :hp1.PM File View:ehp1. icon or window in the same
  45. manner that files can be "dragged" and "dropped" on the Print Manager.
  46. The same can be done with any file object in an application supporting
  47. the public OS/2 1.3/2.0 Drag and Drop protocol.  You should be aware, however,
  48. that if a list containing more than one file name is dragged and dropped,
  49. only the first file in the list will be displayed.
  50. :p.
  51. The selected
  52. filename is shown in the title bar of the display window and as the title
  53. of an icon when the window is minimized.  A status line containing the
  54. file position (line number
  55. or byte offset) can optionally also be displayed at the bottom of the
  56. display window (see
  57. :link res=45 reftype=hd.File Position:elink.).
  58. :p.
  59. Search menu options for :hp1.PM File View:ehp1. permit entering either a
  60. phrase or an offset to which the utility will jump.
  61. :link res=41 reftype=hd.Configuration:elink.
  62. options
  63. permit customizing the screen color, display font size, display format,
  64. tab stop setting, and whether or not the scroll bars and/or the file
  65. position status line should be shown (see also
  66. :link res=47 reftype=hd.Font Size:elink.).
  67. These settings become program defaults, but may be changed at any time.
  68. :p.
  69. .*
  70. .* ----------------------------------------------------------------------
  71. :h2 res=30003.Keys Help
  72. :i2 refid=fvhelp.Keys
  73. :parml.
  74. :pt.:hp2.F1:ehp2.
  75. :pd.
  76. Displays Help for Show Picture.
  77. :pt.:hp2.Esc:ehp2.
  78. :pd.
  79. Displays the Open File dialog box if a dialog box is not displayed.
  80. Cancels (removes) a file dialog box if one is displayed.
  81. (see :hp2.File :ehp2.:link res=10 reftype=hd.Open:elink.)
  82. :eparml.
  83. :p.
  84. :p.
  85. The following keys may be used only when there are no dialog boxes
  86. displayed:
  87. :parml.
  88. :pt.:hp2.F3:ehp2.
  89. :pd.
  90. Terminates :hp1.PM File View:ehp1..
  91. (see :hp2.File :ehp2.:link res=12 reftype=hd.Exit:elink.)
  92. :pt.:hp2.Ctrl-N:ehp2.
  93. :pd.
  94. Closes the current file being displayed, and brings up the Open File
  95. dialog box for selection of another file.
  96. (see :hp2.File :ehp2.:link res=11 reftype=hd.New:elink.)
  97. :pt.:hp2.Ctrl-O:ehp2.
  98. :pd.
  99. Displays the Open File dialog box.
  100. (see :hp2.File :ehp2.:link res=10 reftype=hd.Open:elink.)
  101. :pt.:hp2.Ctrl-F:ehp2.
  102. :pd.
  103. Displays the Find dialog box for entry of search parameters, and then
  104. searches the file for the specified text or hex string.
  105. (see :hp2.Search :ehp2.:link res=30 reftype=hd.Find:elink.)
  106. :pt.:hp2.Ctrl-R:ehp2.
  107. :pd.
  108. Repeats the last Find.
  109. (see :hp2.Search :ehp2.:link res=31 reftype=hd.Repeat Find:elink.)
  110. :pt.:hp2.Ctrl-G:ehp2.
  111. :pd.
  112. Displays the Goto dialog box for entry of a file offset, and then
  113. positions the file offset line at the top of the display window.
  114. (see :hp2.Search :ehp2.:link res=32 reftype=hd.Goto:elink.)
  115. :pt.:hp2.Ctrl-C:ehp2.
  116. :pd.
  117. Displays a dialog box for configuring the display appearance.
  118. (see :hp2.Display :ehp2.:link res=41 reftype=hd.Configure:elink.)
  119. :pt.:hp2.Ctrl-A:ehp2.
  120. :pd.
  121. Displays the file in ASCII format.
  122. (see :link res=42 reftype=hd.Display ASCII:elink.)
  123. :pt.:hp2.Ctrl-H:ehp2.
  124. :pd.
  125. Displays the file in Hexadecimal - ASCII format.
  126. (see :link res=43 reftype=hd.Display Hex-ASCII:elink.)
  127. :pt.:hp2.Ctrl-E:ehp2.
  128. :pd.
  129. Displays the file in Hexadecimal - EBCDIC format.
  130. (see :link res=44 reftype=hd.Display Hex-EBCDIC:elink.)
  131. :pt.:hp2.Ctrl-P:ehp2.
  132. :pd.
  133. Toggles the inclusion / exclusion of a file position status line in the
  134. display window.
  135. (see :hp2.Display :ehp2.:link res=45 reftype=hd.File Position:elink.)
  136. :pt.:hp2.Ctrl-B:ehp2.
  137. :pd.
  138. Toggles the inclusion / exclusion of scroll bars in the display
  139. window.
  140. (see :hp2.Display :ehp2.:link res=46 reftype=hd.Scroll Bars:elink.)
  141. :pt.:hp2.Ctrl-S:ehp2.
  142. :pd.
  143. Depending on the display, either toggles the font size (between large and
  144. small) or displays a dialog box for selecting a font size.
  145. (see :hp2.Display :ehp2.:link res=44 reftype=hd.Font Size:elink.)
  146. :pt.:hp2.&darrow.:ehp2.
  147. :pd.
  148. Moves the display window down one line in the file.
  149. :pt.:hp2.&uarrow.:ehp2.
  150. :pd.
  151. Moves the display window up one line in the file.
  152. :pt.:hp2.&bxh.&rarrow.:ehp2.
  153. :pd.
  154. Moves the display window one character to the right.
  155. :pt.:hp2.&larrow.&bxh.:ehp2.
  156. :pd.
  157. Moves the display window one character to the left.
  158. :pt.:hp2.Page Down:ehp2.
  159. :pd.
  160. Moves the display window down one screen in the file.
  161. :pt.:hp2.Page Up:ehp2.
  162. :pd.
  163. Moves the display window up one screen in the file.
  164. :pt.:hp2.Home:ehp2.
  165. :pd.
  166. Moves the display window to the top of the file.
  167. :pt.:hp2.End:ehp2.
  168. :pd.
  169. Moves the display window to the end of the file.
  170. :eparml.
  171. .* ----------------------------------------------------------------------
  172. :h2 res=10.Open
  173. :i2 refid=fvhelp.Open
  174. Use :hp2.File Open...:ehp2. to select a file to be
  175. displayed.
  176. :p.
  177. This selection will open a dialog box, from which a file can be selected
  178. or specified in the entry box of the dialog.  Wildcards specified in the
  179. entry box will filter the list of filenames displayed in the dialog box.
  180. :p.
  181. Shortcut keys: :hp2.Ctrl-O:ehp2., :hp2.Esc:ehp2.
  182. .* ----------------------------------------------------------------------
  183. :h2 res=11.New
  184. :i2 refid=fvhelp.New
  185. Use :hp2.File New...:ehp2. to close the current file and display an Open
  186. File dialog box.  As :hp1.PM File View:ehp1. does not allow other
  187. applications to write to the file being displayed,
  188. this selection is useful when it is needed to make the currently
  189. displayed file available to other programs for writing without exiting
  190. :hp1.PM File View:ehp1. or opening another file.
  191. :p.
  192. Shortcut key: :hp2.Ctrl-N:ehp2.
  193. .* ----------------------------------------------------------------------
  194. :h2 res=12.Exit
  195. :i2 refid=fvhelp.Exit
  196. Selection of :hp2.File Exit:ehp2. will terminate
  197. :hp1.PM File View:ehp1..
  198. :p.
  199. Shortcut key: :hp2.F3:ehp2.
  200. :p.
  201. (The shortcut key cannot be used when a
  202. dialog box is displayed)
  203. .* ----------------------------------------------------------------------
  204. :h2 res=30.Find
  205. :i2 refid=fvhelp.Find
  206. Use :hp2.Search Find...:ehp2. to locate a text or hexadecimal string
  207. in the displayed file.  The line containing the string becomes the top
  208. line in the display window.
  209. :p.
  210. Use the Find dialog box to enter the string to be located.
  211. The string entered is assumed to be ASCII text
  212. unless the :hp2.Hex String:ehp2. box is checked.  If it is desired to
  213. find the ASCII text exactly as entered in the dialog box, check the
  214. :hp2.Case Sensitive:ehp2. box; otherwise, the upper / lower case of
  215. characters in the search string and the file will be ignored in their
  216. comparison, e.g. an :hp2.a:ehp2. will match an :hp2.A:ehp2..
  217. :p.
  218. Hexadecimal strings may be entered with or without spaces between bytes
  219. and with upper and/or lower case hexadecimal digits.
  220. For example,
  221. :xmp.
  222. 6FAC880D
  223. :exmp.
  224. :p.
  225. can also be entered as
  226. :xmp.
  227. 6f Ac 88 0d
  228. :exmp.
  229. :p.
  230. However, be aware that the hexadecimal string entry
  231. :xmp.
  232. 6 f a c 8 8 0 d
  233. :exmp.
  234. :p.
  235. will be treated as
  236. :xmp.
  237. 060f0a0c0808000d
  238. :exmp.
  239. :p.
  240. The search will start from the current file position (the top line
  241. in the display window) unless the :hp2.Search from Top:ehp2. box is
  242. checked, in which case the search is started from the beginning of
  243. the file.
  244. :p.
  245. Shortcut key: :hp2.Ctrl-F:ehp2.
  246. .* ----------------------------------------------------------------------
  247. :h2 res=31.Repeat Find
  248. :i2 refid=fvhelp.Repeat Find
  249. Use :hp2.Search Repeat Find:ehp2. to find the next occurrence of the last
  250. string entered in the Find dialog box.  Note that if the
  251. :hp2.Search from Top:ehp2. box was checked when the last Find was
  252. executed, repeated use of the :hp2.Repeat Find:ehp2. selection will
  253. always go to the same point in the file -- the first occurrence of the
  254. search string in the file.  In other words, the :hp2.Repeat Find:ehp2.
  255. command is most useful when the :hp2.Search from Top:ehp2. box in the
  256. Find dialog box is not checked.
  257. :p.
  258. Shortcut key: :hp2.Ctrl-R:ehp2.
  259. .* ----------------------------------------------------------------------
  260. :h2 res=32.Goto
  261. :i2 refid=fvhelp.Goto
  262. Use :hp2.Search Goto...:ehp2. to move the display window to a specified
  263. offset position in the file.  The offset position and type of offset are
  264. entered in a Goto dialog box when the :hp2.Goto...:ehp2. selection is
  265. invoked.  If a byte offset is specified, the character in the file at
  266. the offset position is displayed at the top row and leftmost column of the
  267. display window; an offset of zero corresponds to the first character
  268. (byte) in the file.  If the offset is a line number, n, then the nth
  269. line in the file is displayed as top line in the display window (the
  270. first line in the file is line number 1).
  271. :p.
  272. To specify a byte offset, enter the offset in the dialog box and click
  273. on the either the :hp2.Decimal:ehp2. button if the offset is a decimal
  274. number, or the :hp2.Hexadecimal:ehp2. button if the offset is a
  275. hexadecimal value.  A line offset is specified by typing the line
  276. number in the dialog box entry field and clicking on the
  277. :hp2.Line No.:ehp2. button.
  278. :p.
  279. The actual positioning of the file to the specified offset occurs when
  280. the :hp2.Goto:ehp2. button is clicked or the :hp2.Enter:ehp2. key is
  281. pressed.  Clicking on the :hp2.Cancel:ehp2. button or pressing the
  282. :hp2.Esc:ehp2. key terminates the Goto dialog without performing any file
  283. positioning.
  284. :p.
  285. Shortcut key: :hp2.Ctrl-G:ehp2.
  286. .* ----------------------------------------------------------------------
  287. :h2 res=41.Configure
  288. :i2 refid=fvhelp.Configure
  289. Use :hp2.Display Configure...:ehp2. to open a dialog box to
  290. change and save various display
  291. characteristics, including the window text and background colors, font
  292. size, file display mode, number of characters between tab stops,
  293. whether or not scroll bars should be included in the display, and
  294. whether or not a file position status line should be displayed.
  295. :p.
  296. Pressing the :hp2.Enter:ehp2. key or clicking on the :hp2.OK:ehp2.
  297. button will change the display according to the selections in the
  298. dialog box.  If the :hp2.Save values to disk:ehp2. box is checked, the
  299. selections will also be saved to disk.  Then, each time
  300. :hp1.PM File View:ehp1. is started, the saved selections will be invoked.
  301. If the
  302. :hp2.Save window position:ehp2. box is checked, the current size and
  303. position
  304. of the :hp1.PM FIle View:ehp1. window will also be saved and then will
  305. be restored each time the program is started.
  306. :p.
  307. If the :hp2.Cancel:ehp2. button is clicked or the :hp2.Esc:ehp2. key is
  308. pressed, the display is not changed, and the settings are not saved to
  309. disk.
  310. :p.
  311. Shortcut key: :hp2.Ctrl-C:ehp2.
  312. .* ----------------------------------------------------------------------
  313. :h2 res=42.Display ASCII
  314. :i2 refid=fvhelp.Display ASCII
  315. Select the :hp2.Display Display ASCII:ehp2. pull-down menu item to view
  316. the file as characters and symbols.  This is the normal mode to view text
  317. files.  Non-text/ASCII files viewed with this selection will appear as
  318. gibberish and will likely not have meaningful line layouts; use one of
  319. the Hex display modes for these types of files.
  320. (see
  321. :link res=43 reftype=hd.Display Hex-ASCII:elink., and
  322. :link res=44 reftype=hd.Display Hex-EBCDIC:elink.).
  323. :p.
  324. Shortcut key: :hp2.Ctrl-A:ehp2.
  325. .* ----------------------------------------------------------------------
  326. :h2 res=43.Display Hex-ASCII
  327. :i2 refid=fvhelp.Display Hex-ASCII
  328. Select the :hp2.Display Display Hex-ASCII:ehp2. pull-down menu item to
  329. view the file as hexadecimal bytes with their corresponding ASCII
  330. characters and PC symbols.  Each line contains three sections: (1) an
  331. eight-digit byte file offset of the first byte on the line; (2) sixteen
  332. hexadecimal bytes of the file; and (3) the ASCII characters or PC
  333. symbols corresponding to the hexadecimal values.
  334. :p.
  335. This display format is most often used with non-text PC files.  For
  336. text/ASCII and IBM Host files, see
  337. :link res=42 reftype=hd.Display ASCII:elink., and
  338. :link res=44 reftype=hd.Display Hex-EBCDIC:elink..
  339. :p.
  340. Shortcut key: :hp2.Ctrl-H:ehp2.
  341. .* ----------------------------------------------------------------------
  342. :h2 res=44.Display Hex-EBCDIC
  343. :i2 refid=fvhelp.Display Hex-EBCDIC
  344. Select the :hp2.Display Display Hex-EBCDIC:ehp2. pull-down menu item to
  345. view the file as hexadecimal bytes with their corresponding EBCDIC
  346. characters.  Each line contains three sections: (1) an
  347. eight-digit byte file offset of the first byte on the line; (2) sixteen
  348. hexadecimal bytes of the file; and (3) the EBCDIC characters
  349. corresponding to the hexadecimal values.
  350. :p.
  351. This display format is most often used with IBM Host and DisplayWrite
  352. DOC and RFT files.  For text/ASCII and non-text PC files, see
  353. :link res=42 reftype=hd.Display ASCII:elink., and
  354. :link res=44 reftype=hd.Display Hex-ASCII:elink..
  355. :p.
  356. Shortcut key: :hp2.Ctrl-E:ehp2.
  357. .* ----------------------------------------------------------------------
  358. :h2 res=45.File Position
  359. :i2 refid=fvhelp.File Position
  360. Use the :hp2.Display File Position:ehp2. menu item to toggle the
  361. display of the line number or byte offset status line at the bottom of
  362. the display window.  If this item is not checked, selecting it will
  363. display the status line; if this item is checked, selecting it will
  364. remove the line.  Note: Displaying the File Position status line
  365. with :hp2.Display ASCII:ehp2. selected may
  366. slow down response, particularly with large files, as the
  367. lines are counted while loading and moving through the file.
  368. :p.
  369. With
  370. :link res=42 reftype=hd.Display ASCII:elink.
  371. selected, the status line will display the number of the line in the
  372. file currently displayed at the top of the display window, along with
  373. the total number of lines in the file.  The latter number may be one
  374. greater than similar line totals displayed in line editors, as
  375. :hp1.PM File View:ehp1. considers anything after the last line-feed,
  376. including the end-of-file (hex 1A) character, to be another line.
  377. The line number starts with 1.
  378. :p.
  379. With
  380. :link res=43 reftype=hd.Display Hex-ASCII:elink. or
  381. :link res=44 reftype=hd.Display Hex-EBCDIC:elink.
  382. selected, the status line will display in decimal format the offset
  383. into the file of the first byte displayed on the top line of the
  384. display window.  Thus the first byte of the file is numbered 0.  Also
  385. displayed on the status line, in both decimal and hexadecimal formats,
  386. is the offset number of the last byte in the file.  Therefore, this latter
  387. number is one less than the number of bytes in the file.
  388. :p.
  389. Shortcut key: :hp2.Ctrl-P:ehp2.
  390. .* ----------------------------------------------------------------------
  391. :h2 res=46.Scroll Bars
  392. :i2 refid=fvhelp.Scroll Bars
  393. Use the :hp2.Display Scroll Bars:ehp2. pull-down menu item to remove the
  394. the scroll bars from the :hp1.PM File View:ehp1.
  395. window if they are displayed, or to add scroll bars if they are not
  396. present.
  397. :p.
  398. Removing the scroll bars will allow more of the file to be displayed,
  399. but the keyboard (arrow, page, :hp2.Home:ehp2. and :hp2.End:ehp2. keys)
  400. must then be used to move through the file.
  401. :p.
  402. Shortcut key: :hp2.Ctrl-B:ehp2.
  403. .* ----------------------------------------------------------------------
  404. :h2 res=47.Font Size
  405. :i2 refid=fvhelp.Font Size
  406. Use the font size pull-down menu item to change the font used to display
  407. the file.  Selection of this item will then bring up the
  408. Font Size list box / dialog window, from which a font can be selected.
  409. :p.
  410. The :hp2.Display :ehp2.
  411. :link res=41 reftype=hd.Configure...:elink.
  412. menu item can also be used to set the font size for any display.
  413. :p.
  414. Shortcut key: :hp2.Ctrl-S:ehp2.
  415. .* ----------------------------------------------------------------------
  416. :h2 res=31001.Command Line Options
  417. :i2 refid=fvhelp.Command Line Options
  418. :hp1.PM File View:ehp1. is invoked with the following syntax
  419. (the parameters :hp2.must:ehp2. be separated by at least one space):
  420. :p.
  421. :hp2.PMVIEW:ehp2.
  422. [filename.ext]
  423. [:hp2./i:ehp2.]
  424. [:hp2./M:ehp2.]
  425. :p.
  426. where:
  427. :parml.
  428. :pt.filename.ext
  429. :pd.
  430. optionally is the name of a file to be
  431. displayed.  If a filename.ext is not given
  432. or contains wildcards,
  433. :hp1.PM File View:ehp1. displays the Open File dialog box on start-up.
  434. If wildcards are included in the filename.ext, only files which meet
  435. the wildcard criteria are listed in the dialog box.
  436. :pt.:hp2./i:ehp2.
  437. :pd.
  438. is an optional parameter which causes
  439. :hp1.PM File View:ehp1. to start up as an icon.
  440. Note that filename.ext must be given
  441. when this option is used.
  442. :pt.:hp2./M:ehp2.
  443. :pd.
  444. is an optional parameter which causes the Minimize button to be
  445. :hp2.excluded:ehp2. from the frame window.  This option is used only
  446. in special circumstances where it is necessary to prevent the inadvertent
  447. use of the Minimize button as a "Close" button.
  448. :eparml.
  449. :p.
  450. .* ----------------------------------------------------------------------
  451. :euserdoc.
  452.  
  453.