home *** CD-ROM | disk | FTP | other *** search
/ vsiftp.vmssoftware.com / VSIPUBLIC@vsiftp.vmssoftware.com.tar / FREEWARE / FREEWARE40.ZIP / flistfrontend / doc / m1.rno < prev    next >
Encoding:
Text File  |  1985-01-27  |  23.3 KB  |  454 lines
  1. .; $Id: m1.rno,v 1.2 1985/01/27 20:06:12 tom Exp $
  2. .ch Introduction to BROWSE
  3. .; introduction
  4. .; screen manipulation and command entry
  5. .req "d0.req"
  6. The BROWSE program permits you, the user, to browse a VMS file,
  7. scrolling up, down, left or right.
  8. By using cursor- and screen-update optimization,
  9. BROWSE provides you with rapid response.
  10. BROWSE is superior to the EDT screen editor
  11. for applications which require examination, rather than modification.
  12.  
  13. .hl    Special Features
  14. Besides the basic scrolling functions, BROWSE provides you with other
  15. powerful screen-oriented functions:
  16. .lm+8
  17. .b.i-4
  18. o    BROWSE always shows the current position of the display-page
  19. in the file, as well as the filename.
  20. .b.i-4
  21. .x Highlighting>Overstruck text
  22. o    Text which is underlined or overstruck is shown in the display
  23. by highlighting.
  24. .b.i-4
  25. .x Highlighting>Searching
  26. o    You may search for a string, either forward or backward.
  27. Text matching the search-string is highlighted (instead of underlined text).
  28. .b.i-4
  29. o    You may interrupt a search, so that if you
  30. accidentally begin a search while examining a
  31. very large file, you can regain control of your terminal.
  32. .b.i-4
  33. o    You may alter the format of the display, causing characters
  34. which normally are used for carriage control (and are invisible) to
  35. become visible.
  36. .b.i-4
  37. .x Ruler-mode
  38. o    BROWSE provides you with a "ruler" command which shows you the
  39. line number and column of any point in the file.
  40. .lm-8
  41.  
  42. .hl    Command Entry
  43. Most commands recognized by BROWSE are single-keystroke.
  44. It maps all alphabetic characters to the set of control characters
  45. (e.g., "F", "f" and "CTRL/F" are equivalent).
  46. .b
  47. Commands which require more information than a single keystroke
  48. prompt you in the status line for the required information.
  49. There are two types of command which result in a prompt:
  50. .ls
  51. .le;Searches.
  52. BROWSE accepts any combination of ^&printing\& characters for a search
  53. target.
  54. The DELETE key and CTRL/U, CTRL/X have their normal meaning (delete or cancel).
  55. .le;Numeric arguments.
  56. Certain commands (e.g., left/right scrolling) accept an optional numeric
  57. argument.
  58. If you type a numeric digit, BROWSE enters numeric-argument mode,
  59. echoing this digit as the first character of your input and
  60. listing in the prompt the letters which it will accept as a command.
  61. If you type a number followed by one of these (alphabetic) characters,
  62. BROWSE will then execute the command.
  63. For example, if you typed "12R", BROWSE would scroll right by 12 columns.
  64. .b
  65. If you type a digit but do not wish to perform a command,
  66. type CTRL/X or CTRL/U.
  67. .els
  68.  
  69. .hl    Searches
  70. BROWSE performs searches and displays their result in an unusual manner:
  71. .lm+8
  72. .b.i-4
  73. o    The search string may contain only printable ASCII characters.
  74. This restriction is made to eliminate the keypad-dependency of EDT.
  75. The search itself is case-independent.
  76. .b.i-4
  77. o    Blanks within the search string are matched by any type of
  78. blank in the file itself (e.g., space, TAB, RETURN, LINE-FEED and FORM-FEED).
  79. Multiple blanks are treated as a single blank.
  80. .b.i-4
  81. o    Search-matches may not span a display-line.
  82. (A display-line is normally synonymous with a record in the file).
  83. .b.i-4
  84. .x Highlighting>Searching
  85. o    All positions on the display screen which match the search string
  86. are highlighted.
  87. Thus, you may see all matches at a glance, rather than by cursor movement.
  88. .b.i-4
  89. o    Positions which lie to the left or right of the screen cause the
  90. corresponding end of the line to be highlighted.
  91. BROWSE does not automatically scroll left/right to the search target.
  92. .b.i-4
  93. o    A search remains in effect until canceled (by searching for
  94. an empty string).
  95. If you scroll about with an active search, BROWSE will continue to
  96. highlight locations in the file which match the search string.
  97. .b.lm-8
  98. Thus, rather than simply duplicate conventional searches (such as that
  99. provided by EDT), BROWSE provides you with a powerful examination tool.
  100. By treating all white-space the same, BROWSE allows you to ignore the
  101. exact amount of spacing.
  102. .x Highlighting>Searching
  103. The highlighting makes searches simpler by showing you all occurrences,
  104. rather than each one, one at a time.
  105.  
  106. .hl    Screen Organization
  107. BROWSE reserves the last line of the screen for status display.
  108. It uses the remainder of the screen to display your file.
  109. .b
  110. Figure#1 shows a typical screen using BROWSE.
  111. .x Highlighting>Overstruck text
  112. Overstruck text (e.g., the title "FLIST#-#Directory#Editor") is highlighted.
  113. The file name is given in the status line,
  114. as is the range of line numbers shown in the screen (i.e., "1:23").
  115. The range of columns "1:69" is obtained from the current screen-width
  116. (for this example, 70), and the amount by which the screen is shifted.
  117. The length, in columns, of the longest line on the display is given
  118. in parentheses, "(77)".
  119.  
  120. .tp30.b2.lm+3.k.nf.nj
  121. Screen dumped: 21-JAN-1985 07:11:44
  122. Image top: 0  bottom: 22
  123.  
  124. +---------------------------------------------------------------------+
  125. |^&FLIST - Directory Editor\&                                             |
  126. |                                                                     |
  127. |  FLIST (directory editor) permits the  user  to  sort  directories, |
  128. |  files,  delete  rename  or  alter  the  protection code on files, a|
  129. |  dynamic display.                                                   |
  130. |                                                                     |
  131. |  Format:                                                            |
  132. |                                                                     |
  133. |        FLIST [_*._*;_*]                                                |
  134. |                                                                     |
  135. |                                                                     |
  136. |^&Options:\&                                                             |
  137. |                                                                     |
  138. |  /NOALL         Suppress filename if no privilege for other data    |
  139. |  /ALL (D)       Read  directory  entries  for  all  filenames,   eve|
  140. |                 insufficient privilege.                             |
  141. |  /DBACKUP       Show backup dates instead of creation dates         |
  142. |  /NODATE        Suppress creation-date+time                         |
  143. |  /FAST          Suppress all fields other than the filename (_*3 fast|
  144. |  /NOFAST        Open each file  to  obtain  auxiliary  information  |
  145. |                 date, size).                                        |
  146. |  /NOOWNER       Suppress display of owner code                      |
  147. |  /NOPROTECTION  Suppress display of protection mask                 |
  148. |^&FL.HLP;   Lines 1:23  Cols 1:69 (77)\&                                 |
  149. +---------------------------------------------------------------------+
  150. .b.c;Figure#1##Sample Screen
  151. .;.stc2,1,Sample Screen
  152. .b2.lm.nk.f.j
  153.  
  154. You may direct BROWSE to display the same screen shifted to the right by
  155. typing R.
  156. Scrolling and shifting are single-keystroke commands in BROWSE.
  157. .tp30.b2.lm+3.k.nf.nj
  158. Screen dumped: 21-JAN-1985 07:12:03
  159. Image top: 0  bottom: 22
  160.  
  161. +---------------------------------------------------------------------+
  162. |                                                                     |
  163. |                                                                     |
  164. |the  user  to  sort  directories,  examine                           |
  165. |  the  protection code on files, all via a                           |
  166. |                                                                     |
  167. |                                                                     |
  168. |                                                                     |
  169. |                                                                     |
  170. |                                                                     |
  171. |                                                                     |
  172. |                                                                     |
  173. |                                                                     |
  174. |                                                                     |
  175. |if no privilege for other data                                       |
  176. |ntries  for  all  filenames,   even   if                             |
  177. |lege.                                                                |
  178. |instead of creation dates                                            |
  179. |date+time                                                            |
  180. |s other than the filename (_*3 faster)                                |
  181. |  obtain  auxiliary  information  (e.g.,                             |
  182. |                                                                     |
  183. |f owner code                                                         |
  184. |f protection mask                                                    |
  185. |^&FL.HLP;   Lines 1:23  Cols 36:104 (77)\&                               |
  186. +---------------------------------------------------------------------+
  187. .b.c;Figure#2##Sample Screen, Shifted Right
  188. .;.stc2,2,Sample Screen, Shifted Right
  189. .b2.lm.nk.f.j
  190.  
  191. BROWSE permits you to change the display dynamically.
  192. The overstruck text is composed by backspace-overstrikes.
  193. .x Toggle-commands>O, overstrikes
  194. By toggling the O-command, you may see these backspaces (i.e., "_^H"
  195. is a CTRL/H, or backspace).
  196. .tp30.b2.lm+3.k.nf.nj
  197. Screen dumped: 21-JAN-1985 07:11:51
  198. Image top: 0  bottom: 22
  199.  
  200. +---------------------------------------------------------------------+
  201. .nfl uppercase
  202. |D^HDI^HIR^HRE^HED^HD -^H- D^HDi^Hir^Hre^Hec^Hct^Hto^Hor^Hry^Hy E^HEd^|
  203. |^M                                                                   |
  204. |  FLIST (directory editor) permits the  user  to  sort  directories, |
  205. |  files,  delete  rename  or  alter  the  protection code on files, a|
  206. |  dynamic display.^M                                                 |
  207. |^M                                                                   |
  208. |  Format:^M                                                          |
  209. |^M                                                                   |
  210. |        FLIST [_*._*;_*]^M                                              |
  211. |^M                                                                   |
  212. |^M                                                                   |
  213. |O^HOp^Hpt^Hti^Hio^Hon^Hns^Hs:^H:^M                                   |
  214. |^M                                                                   |
  215. |  /NOALL         Suppress filename if no privilege for other data^M  |
  216. |  /ALL (D)       Read  directory  entries  for  all  filenames,   eve|
  217. |                 insufficient privilege.^M                           |
  218. |  /DBACKUP       Show backup dates instead of creation dates^M       |
  219. |  /NODATE        Suppress creation-date+time^M                       |
  220. |  /FAST          Suppress all fields other than the filename (_*3 fast|
  221. |  /NOFAST        Open each file  to  obtain  auxiliary  information  |
  222. |                 date, size).^M                                      |
  223. |  /NOOWNER       Suppress display of owner code^M                    |
  224. |  /NOPROTECTION  Suppress display of protection mask^M               |
  225. .fl uppercase
  226. |^&FL.HLP;   Lines 1:23  Cols 1:69 (89)\&                                 |
  227. +---------------------------------------------------------------------+
  228. .b.c;Figure#3##Sample Screen with Expanded Carriage Control
  229. .;.stc2,3,Sample Screen with Expanded Carriage Control
  230. .b2.lm.nk.f.j
  231.  
  232. Even more detail is possible.
  233. You may direct BROWSE to show the file-address (cumulative character count)
  234. of each display line, and the line number (modulo 100) before each line:
  235. .;
  236. .tp30.b2.lm+3.k.nf.nj
  237. Screen dumped: 21-JAN-1985 07:12:36
  238. Image top: 0  bottom: 22
  239.  
  240. +---------------------------------------------------------------------+
  241. |        0.01:^&FLIST - Directory Editor\&                                |
  242. |       70.02:                                                        |
  243. |       74.03:  FLIST (directory editor) permits the  user  to  sort  |
  244. |      156.04:  files,  delete  rename  or  alter  the  protection cod|
  245. |      238.05:  dynamic display.                                      |
  246. |      260.06:                                                        |
  247. |      264.07:  Format:                                               |
  248. |      278.08:                                                        |
  249. |      282.09:        FLIST [_*._*;_*]                                   |
  250. |      308.10:                                                        |
  251. |      312.11:                                                        |
  252. |      316.12:^&Options:\&                                                |
  253. |      344.13:                                                        |
  254. |      348.14:  /NOALL         Suppress filename if no privilege for o|
  255. |      418.15:  /ALL (D)       Read  directory  entries  for  all  fil|
  256. |      498.16:                 insufficient privilege.                |
  257. |      542.17:  /DBACKUP       Show backup dates instead of creation d|
  258. |      606.18:  /NODATE        Suppress creation-date+time            |
  259. |      654.19:  /FAST          Suppress all fields other than the file|
  260. |      730.20:  /NOFAST        Open each file  to  obtain  auxiliary  |
  261. |      810.21:                 date, size).                           |
  262. |      844.22:  /NOOWNER       Suppress display of owner code         |
  263. |      896.23:  /NOPROTECTION  Suppress display of protection mask    |
  264. |^&FL.HLP;   Lines 1:23  Cols 1:56 (77):79\&                              |
  265. +---------------------------------------------------------------------+
  266. .b.c;Figure#4##Sample Screen Showing File-Address
  267. .;.stc2,4,Sample Screen Showing File-Address
  268. .b2.lm.nk.f.j
  269.  
  270. Another keystroke transforms the file-address into record lengths:
  271. .;
  272. .tp30.b2.lm+3.k.nf.nj
  273. Screen dumped: 21-JAN-1985 07:12:43
  274. Image top: 0  bottom: 22
  275.  
  276. +---------------------------------------------------------------------+
  277. |       68.01:^&FLIST - Directory Editor\&                                |
  278. |        2.02:                                                        |
  279. |       79.03:  FLIST (directory editor) permits the  user  to  sort  |
  280. |       79.04:  files,  delete  rename  or  alter  the  protection cod|
  281. |       20.05:  dynamic display.                                      |
  282. |        2.06:                                                        |
  283. |       11.07:  Format:                                               |
  284. |        2.08:                                                        |
  285. |       23.09:        FLIST [_*._*;_*]                                   |
  286. |        2.10:                                                        |
  287. |        2.11:                                                        |
  288. |       26.12:^&Options:\&                                                |
  289. |        2.13:                                                        |
  290. |       67.14:  /NOALL         Suppress filename if no privilege for o|
  291. |       77.15:  /ALL (D)       Read  directory  entries  for  all  fil|
  292. |       42.16:                 insufficient privilege.                |
  293. |       62.17:  /DBACKUP       Show backup dates instead of creation d|
  294. |       46.18:  /NODATE        Suppress creation-date+time            |
  295. |       74.19:  /FAST          Suppress all fields other than the file|
  296. |       77.20:  /NOFAST        Open each file  to  obtain  auxiliary  |
  297. |       31.21:                 date, size).                           |
  298. |       49.22:  /NOOWNER       Suppress display of owner code         |
  299. |       54.23:  /NOPROTECTION  Suppress display of protection mask    |
  300. |^&FL.HLP;   Lines 1:23  Cols 1:56 (77):79\&                              |
  301. +---------------------------------------------------------------------+
  302. .b.c;Figure#5##Sample Screen Showing Record-Lengths
  303. .;.stc2,5,Sample Screen Showing Record-Lengths
  304. .b2.lm.nk.f.j
  305.  
  306. .x Ruler-mode
  307. By selecting "ruler-mode", you may use BROWSE to determine the
  308. column and line number of any point in your file.
  309. .x Highlighting>Column-scale (see Ruler-mode)
  310. The ruler is highlighted to make it more readable.
  311. .;
  312. .tp30.b2.lm+3.k.nf.nj
  313. Screen dumped: 21-JAN-1985 07:13:27
  314. Image top: 0  bottom: 22
  315.  
  316. +---------------------------------------------------------------------+
  317. |^&FLIST - Directory Editor\&                                             |
  318. |                                                                     |
  319. |  FLIST (directory editor) permits the  user  to  sort  directories, |
  320. |  files,  delete  rename  or  alter  the  protection code on files, a|
  321. |  dynamic display.                                                   |
  322. |                                                                     |
  323. |  Format:                                                            |
  324. |                                                                     |
  325. |        FLIST [_*._*;_*&]                                                |
  326. |                                                                     |
  327. |                                                                     |
  328. |^&Options:\&                                                             |
  329. |                                                                     |
  330. |  /NOALL         Suppress filename if no privilege for other data    |
  331. |  /ALL (D)       Read  directory  entries  for  all  filenames,   eve|
  332. |                 insufficient privilege.                             |
  333. |  /DBACKUP       Show backup dates instead of creation dates         |
  334. |  /NODATE        Suppress creation-date+time                         |
  335. |  /FAST          Suppress all fields other than the filename (_*3 fast|
  336. |  /NOFAST        Open each file  to  obtain  auxiliary  information  |
  337. |                 date, size).                                        |
  338. |  /NOOWNER       Suppress display of owner code                      |
  339. |  /NOPROTECTION  Suppress display of protection mask                 |
  340. |^&....+...10....+...20\&.^&...+...30....+...40....+...50....+...60....\&    9|
  341. +---------------------------------------------------------------------+
  342. .b.c;Figure#6##Sample Screen Showing Line/Column "Ruler"
  343. .;.stc2,6,Sample Screen Showing Line/Column "Ruler"
  344. .b2.lm.nk.f.j
  345.  
  346. Though BROWSE is designed primarily to browse ^&text\& files,
  347. you may also examine ^&binary\& files with it.
  348. Figure#7 was obtained by setting the qualifiers "/OVER:2" and "/MARK".
  349. This causes all control characters to be shown as ".",
  350. and the record-address and line numbers as a display-prefix.
  351. .b
  352. Note that unlike Figures 4 and 5, there are now four columns of numbers
  353. shown in the prefix area.
  354. BROWSE normally displays one file-record on each display line.
  355. However, if a LINE-FEED is found embedded within a record,
  356. BROWSE begins a new display line.
  357. In Figure#7, the first column shows the ^&record file address\&,
  358. and the second the offset of the new display-line within the
  359. record.
  360. Because the display lines and records are not synonymous,
  361. the record number (third column) is shown separately,
  362. from the line number (fourth column).
  363. .tp30.lm+3.k.nf.nj
  364. Screen dumped: 21-JAN-1985 07:14:33
  365. Image top: 0  bottom: 22
  366.  
  367. +---------------------------------------------------------------------+
  368. .nfl
  369. |        0......01.01:..0.@.L.....0204....................;#Qv........|
  370. |         .0141....02:......... .#.......$.......C.......D.......G... |
  371. |         .0189....03:...H.......l.?....}$.......!...........         |
  372. |         .0229....04:VMSRTL_001.....$.                               |
  373. |         .0247....05:.....!.......T...                               |
  374. |         .0265....06:SCRSHR_001......................................|
  375. |      512......02.07:all.date.dbackup.drevised.fast.owner.protection.|
  376. |         .0273....08:%s%s                                            |
  377. |         .0278....09:..HLP.FLIST.more...... %s. ...Terminal must be V|
  378. |         .0345....10:..>..=..[0m.[20l..[?4l.?[%d;%d?....             |
  379. |         .0381....11:....-.%s: \%.8s\.$.%s                           |
  380. |         .0403....12:. 00:00:00.00.no.%d%c.%s: %s.%s: %s             |
  381. |         .0439....13:. .Reading: %3d files.Working.....Command failed|
  382. |     1024......03.14:ontinue.?help.?columns.?date.?level.?quota.?size|
  383. |     1536......04.15:inspect.more.next.nfind.print..LIS.protect.purge|
  384. |     2048......05.16:.%d.locked.  .  .  .%%-%ds.%-6s. .%6.6d.%-6s. .%|
  385. |     2560......06.17:licable.Repeated display-field: %s.%c., . (%s).D|
  386. |     3072......07.18:u cannot view this file.EDIT.HOME.%s%s.HOME.EDTI|
  387. |     3584......08.19:.OQ.Q.OR.R.OS.Op.?p.Oq.?q.Or.?r.Os.?s.Ot.?t.Ou.?|
  388. |         .0180....20:....;%d.r...You are not the file's owner.(NO Pri|
  389. |     4096......09.21:roll .Up/.Down 1/2 screen (arrow)..    R,L  - sc|
  390. |     4608......10.22: or arrow keys.Special:.    K   - Copy screen to|
  391. |         .0483....23:.  Lines %d:%d  Cols %d:%d (%                   |
  392. .fl
  393. |^&FL.EXE;   Lines 1:23  Cols 1:56 (512):512  Records 1+\&                |
  394. +---------------------------------------------------------------------+
  395. .b.c;Figure#7##Sample Screen Showing Binary File
  396. .;.stc2,7,Sample Screen Showing Binary File
  397. .b2.lm.nk.f.j
  398. .;
  399. The status line is extended to account for the additional information.
  400. The ":512" indicates the longest record length.
  401. The range of record numbers is shown "1+", because
  402. (like the prefix line-numbers),
  403. the prefix record-numbers are given modulo 100.
  404.  
  405. Scrolling and ruler mode work properly when record addresses and line
  406. numbers are shown.
  407. The prefix area is fixed on the screen;
  408. the content alone is shifted:
  409. .;
  410. .tp30.b2.lm+3.k.nf.nj
  411. Screen dumped: 21-JAN-1985 07:15:43
  412. Image top: 0  bottom: 22
  413.  
  414. +---------------------------------------------------------------------+
  415. |        0......01.01:06............_"....&.                            |
  416. .nfl
  417. |         .0141....02:                                                |
  418. |         .0189....03:                                                |
  419. |         .0229....04:                                                |
  420. |         .0247....05:                                                |
  421. |         .0265....06:................................................|
  422. |      512......02.07:el: %d.%s.Total blocks: %d (%d allocated).%s.%s.|
  423. |         .0273....08:                                                |
  424. |         .0278....09:                                                |
  425. |         .0345....10:                                                |
  426. |         .0381....11:                                                |
  427. |         .0403....12:                                                |
  428. |         .0439....13:                                                |
  429. |     1024......03.14:end./backward./home./middle./low./forward./colum|
  430. |     1536......04.15:fix is legal only on sort-command.+.-.<number> u|
  431. |     2048......05.16:;.%d.File '%s' is not a member of file-list.File|
  432. |     2560......06.17:LIS.LOG.LST.MAP.OBJ.TMP.TM0.TM1.TM2.TM3.TM4.TM5.|
  433. |     3072......07.18:ust be positive.Argument for QUIT must be '*' or|
  434. |     3584......08.19:d..[H.[J...Two control/C's in succession trigger|
  435. |         .0180....20:it..    ?    - display this message-screen.    _|
  436. |     4096......09.21:umn (in scale-mode, move cursor up too).    I,J |
  437. |     4608......10.22:   - Toggle .OVER mode (3 states if /OVER, else |
  438. |         .0483....23:                                                |
  439. .fl
  440. |                     ^&....+..130....+..14\&0^&....+..150....+..160...\&    1|
  441. +---------------------------------------------------------------------+
  442. .b.c;Figure#8##Sample Screen Showing Shifted Binary File
  443. .;.stc2,8,Sample Screen Showing Shifted Binary File
  444. .b2.lm.nk.f.j
  445.  
  446. .hl    Configuration Requirements
  447. BROWSE runs on any VT52, VT100 or other ANSI x3.64-compatible terminal.
  448. .b
  449. BROWSE is written in VMS-C, and requires approximately 50 kilobytes
  450. of memory.
  451. It has been tested under VMS versions 3.6, 3.7 and 4.0.
  452. .b
  453. You may use it to examine any sequential VMS disk file.
  454.