home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / UTILS2 / SOS311.ZIP / SOS.DOC < prev    next >
Text File  |  1994-03-05  |  23KB  |  522 lines
  1.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  2.                          - All Rights Reserved -
  3.                              
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12. Save Our Screens (SoS) is distributed as SHAREWARE.  It is NOT free. 
  13. You are authorized to evaluate SoS for 15 days.  After the 15 days you
  14. will either pay for the product or completely remove it from your
  15. computer.  
  16.  
  17. An individual registration costs $20.00. This entitles you to the most
  18. current version of SoS.
  19.  
  20. Please send check or money order payable to:
  21.  
  22.  
  23.                            Gary J. Shapiro
  24.                            6 Scenic Court
  25.                            Marlboro NJ,  07746-1967
  26.  
  27.  
  28. Please include your name, address, and SoS version you are registering.
  29.  
  30. You are encouraged to make copies for others to evaluate, as well as for
  31. distribution on Bulletin Board Systems (BBS's).  However, you are not
  32. authorized to accept any payment for doing so.
  33.  
  34. SoS may NOT be used in a corporate, business, government, commercial
  35. organization or agency environment without a negotiated site license.  This
  36. includes the bundling of SoS with any other software for sale.  Please
  37. contact me for details on pricing and site license agreements.
  38.  
  39. Suggestions?  Problems?  Bugs?  Please let me know.  Your help will only
  40. improve SoS.  I can be contacted through America Online(GaryJay) or
  41. CompuServe(72164,1732).
  42.  
  43.  
  44.  
  45. DISCLAIMER
  46. ----------
  47.  
  48. You are completely responsible for determining the fitness or usability of
  49. this package.  I will not be liable for any damages, of any kind, arising
  50. from any failure of any programs in this package to perform as expected.
  51.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  52.  
  53.  
  54.  
  55. INTRODUCTION
  56. ------------
  57.  
  58. SoS is a Terminate and Stay Resident (TSR) program that allows you to save
  59. and restore text screens to memory and disk.  Memory saves are limited to a
  60. maximum of 9, while disk saves are only limited by the amount of disk
  61. space available.  SoS can be invoked within most text applications.  MDA,
  62. CGA, HGC, EGA, MCGA and VGA text modes are fully supported in 40 and 80
  63. column mode.  A maximum of 50 rows is supported for users of EGA, VGA and
  64. similar display adapters.
  65.  
  66. SoS has the additional capability to save screen images to disk in
  67. Text/ASCII format.  Screens saved in this manner can be processed by any
  68. Text or ASCII handling program, eg. editors, word processors etc.
  69.  
  70. All SoS information is presented via POP-UP windows activated by a series
  71. of HOTKEYS.
  72.  
  73.  
  74. SYSTEM REQUIREMENTS
  75. -------------------
  76.  
  77. SoS requires an IBM PC/XT/AT/PS1/PS2 or true compatible that has it's text
  78. display buffer at address 0b000h or 0b800h.  DOS 2.0 or later is required.
  79.  
  80. SoS with Extended Screen Support disabled, and a maximum of 1 screen will
  81. require approximately 13K.  Each additional screen will add 4K to this
  82. number.  The maximum total memory required is 44K with 9 screens requested.
  83.  
  84. With Extended Screen Support enabled add 8k to the above amounts.  The
  85. maximum total memory for this mode is 53K with 9 screens requested.
  86.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  87.   
  88.  
  89. INVOKING SoS
  90. ------------
  91.  
  92. SoS is invoked at the DOS command line or in a batch file as follows:
  93.  
  94.  C:>SOS [/P{d:}{path}] [/Sn] [/Rn] [/En] [/?] [/U] [/N]
  95.  
  96.      /P[d:][path]    Specifies the drive and/or path to which SoS will
  97.                      save its screen files.  If not specified the default 
  98.                      or current path will be used. 
  99.                      
  100.                      Examples: /PC:\SOS\FILES ;  /PC:\ ;  /PD:
  101.  
  102.      /Sn (n=1 to 9)  Maximum number of screen buffers to keep in memory.
  103.                      S4 is the default.  At most nine screens can be
  104.                      kept in memory at any one time.  Disk saves are
  105.                      limited only by available disk space.
  106.  
  107.      /Rn (n=0 or 1)  Enable(1) or Disable(0) CGA snow detection.
  108.                      R1 is the default.
  109.  
  110.      /En (n=0 or 1)  Enable(1) or Disable(0) Extended Screen Support.
  111.                      E0 is the default.
  112.  
  113.      /?              Display a summary of SoS options and functions.
  114.  
  115.      /U              Uninstall SoS from memory, if possible.  SoS MUST be
  116.                      the last TSR program loaded for this to work.
  117.                      
  118.      /N              Disable SoS startup messages.                
  119.  
  120. If no parameters are specified, the default is to allow a maximum of 4
  121. screens with CGA snow detection enabled and Extended Screen Support
  122. disabled.  Screen files will be saved to the current or default path.
  123. Just as if you specified SOS /S4 /R1 /E0.
  124.  
  125. The '/' must precede the parameter and at least one space must come
  126. between successive parameters.  The order of parameters is not important.
  127.  
  128. If you're using a display adapter that does not produce 'snow' you should
  129. specify /R0.  All IBM CGA users should specify /R1 or take the default.
  130. For all other adapters there is no need to specify this parameter.  SoS
  131. automatically assumes /R0 since these adapters do not produce 'snow'.  40
  132. column text, even with a CGA, doesn't produce 'snow', therefore /R0 is
  133. used for this mode.
  134.  
  135. Extended Screen Support (ESS) provides the ability to save and restore
  136. screens up to 80 columns by 50 rows in size.  This feature is designed for
  137. use with EGA, VGA and similar display adapters.  Please see the section on
  138. Extended Screen Support for a more detailed discussion of this feature.
  139.  
  140. If the /P option is specified a valid drive and/or pathname must be 
  141. entered.  If it's not valid you will receive an Invalid Path/Filename error
  142. message when saving your screen files.  A trailing backslash on the path
  143. name is optional.
  144.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  145.  
  146.  
  147.  
  148. If an invalid SoS parameter is entered, you will be informed and help
  149. information will be displayed.  Additionally, SoS will not let a second
  150. copy be loaded into memory.  If enough memory isn't available to load SoS,
  151. a message will be displayed.  In this case, you should decrease the number
  152. of screens requested by 1 until SoS successfully loads. If it still won't
  153. load with 1 screen, you need additional memory on your system.  If SoS
  154. fails to load, ERRORLEVEL will be set to 1.
  155.  
  156. COMPATIBILITY
  157. -------------
  158.  
  159. If you are using other TSR programs and SoS fails to function properly, or
  160. system problems are experienced, try changing the loading order of your
  161. programs.  While SoS was designed to 'behave well' some 'ill behaved'
  162. TSR's might cause problems.  Generally, if SoS is loaded first there
  163. should be no problems.  
  164.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  165.  
  166.  
  167.  
  168. ACTIVATING SoS
  169. --------------
  170.  
  171. I Save to Memory
  172.   --------------
  173. Pressing the Ctrl-LeftShift-S keys simultaneously will invoke the SoS Save
  174. to Memory window.  At the blinking cursor you enter a number from 1 to the
  175. maximum number of screens specified when SoS was loaded.  The range of
  176. valid numbers is provided.  Entering a valid number, followed by pressing
  177. the RETURN key, will save the screen image to memory under that number.
  178. You will then be returned to where you were.  SoS messages that appear will
  179. NOT be saved, only the original screen will be. If you press an invalid key
  180. or a number out of range, an SoS message will be displayed.  At this point
  181. you can enter a valid number or press F3 to exit SoS without a save.  A
  182. successful save will be be indicated by another SoS message.
  183.  
  184. Any existing memory images with the same screen number will be overlayed.
  185.  
  186.  
  187. II Save to Disk
  188.    ------------
  189. Pressing the Alt-LeftShift-S keys simultaneously will invoke the SoS Save
  190. to Disk window.  At the blinking cursor you enter a filename to which the
  191. screen image will be saved to.  Pressing the RETURN key will cause SoS to
  192. save the screen image to disk with that filename.  You will then be
  193. returned to where you were.  Filenames are limited to 8 characters and must
  194. be a valid DOS filename.  Invalid characters will be indicated by an SoS
  195. error message.  Pressing F3 will exit you from SoS without a save.
  196.  
  197. The screen images saved to disk will have the extension .SOS appended to
  198. the filename.  Disk screen images are always saved to the current or default
  199. path unless the /P option is specified.  In this case screen images will be
  200. saved to the drive and/or path specified.  If the file already exists you 
  201. will be asked (Y/N) if you want want to overwrite the file.
  202.  
  203. To save a screen image in Text/ASCII format press the F7 Function key. The
  204. word TEXT will appear in the SoS window.  Pressing the F7 key toggles
  205. between Text mode and non-Text mode.  Saving a screen image while in Text
  206. mode will produce a screen saved as a text file.  Screens saved in this
  207. manner can not be restored since they are not true screen images.  They are
  208. meant to be used by external programs that can process text files.  As in
  209. non-Text mode you will be prompted if the file exists.  However, an added
  210. response, 'A', allows you to append the screen to the existing file.
  211.  
  212. The screen images saved to disk in Text mode will have the extension .SOT
  213. appended to the filename entered.  Spaces and nulls at the end of each line
  214. are removed.  Each line ends with a Carriage Return/Line Feed.  All blank
  215. lines (spaces or nulls) at the end of the Text screen image are also
  216. removed.
  217.  
  218.  
  219. III Restore from Memory
  220.     -------------------
  221. Pressing the Ctrl-LeftShift-R keys simultaneously will invoke the SoS Save
  222. to Memory window.  At the blinking cursor you enter a number from 1 to the
  223. maximum number of screens specified when SoS was loaded.  The range of
  224. valid numbers is provided.  Entering a valid number, followed by pressing
  225. the RETURN key, will cause SoS to restore that screen image from memory.
  226. If you press an invalid key or a number out of range, an SoS message will
  227. be displayed.  Pressing F3 will exit SoS and return you to where you were.
  228.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  229.  
  230.  
  231.  
  232. If a valid number is specified, the saved screen image will appear.  At
  233. this point you can press F3 to exit SoS or press any other key to return to
  234. the Restore from Memory window.  Here you can select another screen number
  235. to restore.
  236.  
  237. Entering a valid screen number, but one that has not been previously saved
  238. to, will result in an SoS message indicating so.
  239.  
  240. Screen Cycling
  241. --------------
  242. You can cycle through your saved screens by pressing the SPACE BAR.  The
  243. cycling will start at screen 1 if SoS has just been activated, or at the
  244. next screen if a screen is already being displayed.  If cycling is begun
  245. when a screen number has been chosen but not restored, the screen number
  246. displayed will be the first screen restored.  Cycling and screen selection
  247. by number can be intermixed.
  248.  
  249.  
  250. IV Restore from Disk
  251.    -----------------
  252. Pressing the Alt-LeftShift-R keys simultaneously will invoke the SoS
  253. Restore from Disk window.  At the blinking cursor you enter the filename of
  254. the screen image to be restored from disk.  Filenames are limited to 8
  255. characters and must be a valid DOS filename.  Invalid characters will be
  256. indicated by an SoS error message.  Disk restores are always from the path
  257. specified on the /P option or, if not specified, from the current path.
  258.  
  259. In addition to choosing a filename, the screen number to save it to must be
  260. chosen.  Entering a screen number has already be discussed.  The TAB key is
  261. used to position the cursor between the FILEname and SCREEN number line.
  262. Once a filename and screen number have been entered, you press the RETURN
  263. key to restore the screen image.  At this point you can press F3 to exit
  264. SoS or press any other key to return to the Restore from Memory window.
  265. Here you can select another filename to restore.
  266.  
  267. If you fail to enter a filename and screen number SoS will remind you. If
  268. the filename entered is not in the path specified or in the current path
  269. if not specified, you will be informed.  You can then exit SoS via F3 or  
  270. select another filename.
  271.  
  272. As in a restore from memory, the disk image restored will overlay the
  273. corresponding screen image in memory with the same screen number.
  274.  
  275. Screen Cycling
  276. --------------
  277. You can cycle through your saved disk screens by repeatedly pressing the
  278. SPACE BAR.  There are two types of disk cycling available.  The first type
  279. is initiated when the SCREEN number field does not contain a number.  In
  280. this mode, only the filenames of the SoS files in the specified or current
  281. path are displayed.  They will be displayed, one at a time, with every
  282. press of the SPACE BAR.  They appear in the order in which they are stored
  283. in the specified or current path.  At anytime you can restore the filename by
  284. entering a valid screen number and pressing the RETURN key.
  285.  
  286. The second type of cycling is initiated when the SCREEN number field
  287. contains a number.  Every press of the SPACE BAR will restore, one at a
  288. time, all the disk screen images in the specified or current path to the
  289. screen number chosen.  This mode is like cycling through memory screens.
  290.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  291.  
  292.  
  293.  
  294. Depending on the type of cycling chosen, SoS will display or restore all
  295. SoS filenames it finds, from the specified or current path, if no filename
  296. was entered.  The DOS wildcard characters * and ? are allowed as part of the
  297. filename.  If used, all files that match will be displayed or restored.
  298. The filename can be changed at anytime in order to cycle through different
  299. files.
  300.  
  301. When the last SoS filename has been displayed or restored an SoS message
  302. will inform you.  Pressing the SPACE BAR at this point will repeat the
  303. cycling process.
  304.  
  305. NOTE
  306. ----
  307. Cycling for the current filename, or part of, will stay in affect until one
  308. of the following occurs:
  309.  
  310.          o  Restoring a disk screen image by using the RETURN key.
  311.          o  Altering the filename (even to the same name).
  312.  
  313. If cycling is then begun, the current filename will be used.
  314.  
  315.  
  316. EDITING
  317. -------
  318.  
  319. The following keys are available for editing both the filename and screen
  320. number:
  321.  
  322.   o BackSpace Key - Pressing this key will move the cursor one position to
  323.                     the left erasing what is on the line.
  324.  
  325.   o Esc Key - Pressing this key will erase the complete line.
  326.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  327.  
  328.  
  329.  
  330. SCREEN MANAGEMENT
  331. -----------------
  332.  
  333. It is up to you to keep track of all saved screen images.  Memory saves are
  334. fairly easy to manage since there are at most only 9.  Disk screen images
  335. are best managed by giving them meaningful filenames.
  336.  
  337.  
  338. SCREEN INFORMATION
  339. ------------------
  340.  
  341. When doing a screen restore from memory or disk you sometimes can't
  342. remember which screen number you are currently displaying.  This is
  343. especially true if you are cycling through many screens.
  344.  
  345. To determine which screen number is currently being displayed, press the F2
  346. Function key when in RESTORE mode.  The screen number you are currently
  347. viewing will then appear.  If a disk restore is being requested the
  348. filename will be displayed.  From here you can continue restoring other
  349. screens or return to the current screen by entering the ACTIVE screen
  350. number.
  351.  
  352. In SAVE mode this function is meaningless and pressing the F2 key is
  353. treated as an invalid key.
  354.  
  355.  
  356. CHANGING COLORS
  357. ---------------
  358.  
  359. The default colors for SoS's windows are black on white.  This appears as
  360. reverse video on monochrome monitors.  To alter this, use the F9 key to
  361. change the background color and the F10 key to change the foreground color.
  362. Changes are not permanent, they will last only until SoS is loaded again.
  363.  
  364. If you wish to change the default colors permanently, absolute offset 5F
  365. hex in SOS.COM is the color byte.  The default is 70 hex, black on white.
  366. You can use DEBUG to change this to whatever colors you desire.  Please
  367. refer to the IBM Technical Reference manual or any good DOS book that
  368. explains color values.
  369.  
  370.     Example debug session:
  371.  
  372.      c>debug sos.com      ;Enter at the DOS prompt.
  373.        -e cs:15f          ;Enter the edit command with the color address.
  374.        xxxx:15f  70._     ;Enter the color value you want and press enter.
  375.        -w                 ;Write out your new copy of SOS.COM.
  376.        -q                 ;Enter the quit command to exit debug.
  377.  
  378. If the SoS window disappears while setting colors with F9 and F10, you set
  379. the background and foreground colors to black.  Pressing either key will
  380. make the window reappear with a new color.
  381.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  382.  
  383.  
  384.  
  385. EXTENDED SCREEN SUPPORT
  386. -----------------------
  387.  
  388. Extended Screen Support (ESS) is the ability for SoS to save and restore
  389. screen images greater then 80 columns by 25 rows.  It is activated by
  390. specifying /E1 at SoS load time.  A maximum screen size of 80x50 is
  391. supported.  If a screen exceeds 80x50, only this amount is saved or
  392. restored.  Since most applications utilize an 80x25 screen size, the
  393. default is to disable ESS (/E0).  This provides saving/restoring a maximum
  394. screen image of 80x25 regardless of the actual screen size in affect.  If
  395. you can't or never plan on using extended screen sizes take the default,
  396. /E0, which will save you 8k of memory.
  397.  
  398. When using ESS please consider the following:
  399.  
  400. 1. As with any screen size, SoS restores screens from memory or disk based
  401.    on the CURRENT screen size, NOT the screen size that was active when
  402.    the image was saved.  Depending on the current screen size, you might
  403.    see less data or data remaining from the original screen.
  404.  
  405. 2. Any screen image greater then 80x25 will require two consecutive memory
  406.    screens.  This means for example, that saving to memory or restoring
  407.    from disk, a screen image to memory screen #1 will not only fill that
  408.    screen in memory but will also use the next consecutive screen, #2 in
  409.    this case. SoS will allow #2 to be restored from memory even though a
  410.    screen image was not saved under this number.  This is a feature only
  411.    applicable to ESS mode.  This is particularly useful when restoring an
  412.    80x50 screen image while in an 80x25 screen.  To see the entire 80x50
  413.    screen image just restore screens #1 and #2 from memory.
  414.  
  415.    Disk saves with ESS are the same as without ESS except that the
  416.    resulting files are larger.  Disk restores are processed in the same
  417.    way as memory saves, ie. two consecutive memory screens are used.
  418.  
  419.    Screens saved to the maximum screen number as specified at SoS load
  420.    time are possible.  There is an extra memory screen space available
  421.    beyond the highest screen.  It can not be referenced directly however.
  422.  
  423. 3. As a rule, if a screen image is restored to the same size screen in
  424.    which it was saved, it will be displayed as it originally appeared.
  425.  
  426. 4. Screen sizes greater then 80x50 can be processed by SoS.  However, only
  427.    the beginning 80x50 area will be saved and subsequently restored.
  428.  
  429. 5. Since extended screens occupy two memory screens, the number of screens
  430.    of this type, that can be saved or restored, is reduced.
  431.  
  432.  
  433. You will soon discover that restored extended screen images can result in
  434. some unexpected looking screens especially if a screen image is restored
  435. to a screen size that is different than the one in which it was saved
  436. from.  To get an idea of what this means, consider the following examples
  437. of screen saves to memory.  Note that these examples also apply to disk
  438. restores after they are in memory.
  439.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  440.  
  441.  
  442.  
  443. o  An 80x25 screen image is saved to #1.  Another 80x25 screen image is
  444.    saved to #2.  You now switch to an 80x50 screen size.  Screen #1 is
  445.    restored.  What you will see is screen #1 AND screen #2.  Remember,
  446.    data is restored to fit the current screen size.
  447.  
  448. o  You now restore screen #2.  You will see #2 on the upper portion and
  449.    empty space in the lower half.  Since SoS is restoring data to fit the
  450.    screen size, #3 is also restored.  Since #3 never had a screen saved to
  451.    it, it is blank.
  452.  
  453. o  Suppose you now save an 80x50 screen to #2.  Restoring #2 while in an
  454.    80x50 mode will display the screen as it originally appeared.  If you
  455.    now restored screen #1 you would see #1 in the top half of the screen
  456.    and #2 in the bottom.
  457.  
  458.  
  459. With a little practice you will quickly get the feel for processing
  460. extended screens.
  461.       Save Our Screens (SoS) v3.11  (c) 1987-1994  Gary J. Shapiro
  462.  
  463.  
  464.  
  465. ERRORS
  466. ------
  467.  
  468. Any errors that are encountered during SoS processing will be indicated by
  469. an error message and are self explanatory.  In most cases, you should try
  470. to correct the problem then retry the operation.  Entering F3 will
  471. immediately exit you from SoS back to where you were if all else fails.
  472.  
  473.  
  474. TIPS ON USING SoS
  475. -----------------
  476.  
  477. The more you use SoS, the more uses you will discover for it.  To help you
  478. along, consider some of these:
  479.  
  480. o  The ability to save important screen information from one application
  481.    to be referenced in another.
  482.  
  483. o  The ability to make customized HELP screens with the use of an editor.
  484.  
  485. o  Saved screens can provide an audit trail of past work.
  486.  
  487. o  Saved screens can be used to recover past work or even data in the
  488.    event of accidental loss due to machine failure or human error.
  489.  
  490. o  Saved screens can be used for tutorial purposes to aid in training.
  491.  
  492. o  Screens saved in Text mode can be incorporated into documents via a
  493.    word processor or editor.  Very helpful in creating manuals.
  494.  
  495.  
  496. MISCELLANEOUS
  497. -------------
  498.  
  499. Saves and restores within graphic modes are not supported.  If you try to
  500. activate SoS in a graphics mode, the request will be ignored.
  501.  
  502. All pages are supported within SoS.  SoS will always restore to the
  503. current page, not the one in which the screen image was saved.
  504.  
  505. Once a screen image is saved you can save any number of other screens
  506. under that same screen number.  Just keep in mind that the last one saved
  507. is what you will see when doing a restore function.
  508.  
  509. Disk screen images can be saved and used between sessions.  They are not
  510. tied to the session which created them.  Memory screen images on the
  511. otherhand cease to exist when the machine is turned off.
  512.  
  513. The .SOS and .SOT files can be deleted when not needed.  Each 80x25 .SOS
  514. file is 4000 bytes in length.  Each 40x25 .SOS file is 2000 bytes in
  515. length.  The size of an extended screen .SOS file can be determined by
  516. the following formula.
  517.  
  518.           ( Number of Screen Rows * Number of Screen Columns ) * 2
  519.  
  520. The .SOT files vary in size and are at most 1/2 the above lengths.
  521.  
  522.