TopWare Tools

home *** CD-ROM | disk | FTP | other *** search

/ TopWare Tools / TOOLS.iso / tools / top1017 / readme.1st < prev next >

Wrap

Text File | 1993-11-01 | 18.4 KB | 459 lines

╔═════════════════════════════════════════════════════════╗ ║ THIS DOCUMENTATION GOES WITH VERSION 2.0 OF LEGROOM(tm) ║ ╚═════════════════════════════════════════════════════════╝ _______ ____|__ | (R) --| | |------------------- Thanks, | ____|__ | Association of | | |_| Shareware Phil Grenetz |__| o | Professionals Ivden Technologies, Inc. -----| | |--------------------- |___|___| MEMBER ============================================================================== TABLE OF CONTENTS ───────────────── 1. SHAREWARE CONCEPT 2. ACKNOWLEDGMENTS 3. PACKING LIST 4. WHAT IS LEGROOM? 5. HOW TO USE LEGROOM 6. USAGE NOTES 7. DISCLAIMER 8. DISTRIBUTION POLICY AND LICENSE 9. ON-LINE, HYPERTEXT VERSION OF THIS README DOCUMENT 1. SHAREWARE CONCEPT ──────────────────── "Shareware" is a term used to describe a system for distribution of software. Under the shareware concept, software may be freely copied and passed along to others, or distributed through bulletin board systems, shareware distribution companies, etc. As a recipient of a shareware program, you may use the software for a short trial period to determine if it meets your needs. If it does, you pay the registration fee. By paying the fee, you are granted the right to retain the software for your use. If the software is not suitable, then you may discard it. The shareware system provides substantial benefits to the computing community (of which YOU are a member): a) You get to try out the software BEFORE you buy it so you know exactly what you're buying. b) Shareware is substantially less expensive than most commercial programs. You don't pay for costly marketing programs and fancy packaging. c) You get access to a MUCH broader base of available programs. Thousands of excellent programs have been written by expert programmers who would never consider marketing commercially. Through the concept of shareware, these people make their programs available to the community. Usually, all they ask in return is a small fee to reward them for the time and effort they've put into the program. The system is based entirely on the honor system, and generally works quite well. (Most people are honest and wouldn't violate the trust placed in them by the author of the software.) Shareware is NOT free software - the author counts on your integrity. Please register using the form in the file REGISTER.FRM. You are encouraged to copy this software and pass it along to others who may be interested in using it. In exchange for registering your copy of LegRoom(tm), you will receive the current version without the registration reminder and the next version of LegRoom (tm) when it is available. In addition, you will receive a listing of other Ivden products. 2. ACKNOWLEDGMENTS ────────────────── LegRoom(tm) was developed by Phil Grenetz and is published by Ivden Technologies, Inc. as part of a line of memory resident utilities. (c) Copyright 1992-93 Phil Grenetz The hypertext documentation was developed using the authoring system DeskTop Advisor(tm), also published by Ivden Technologies, Inc. 3. PACKING LIST ─────────────── LEGROOM.EXE Executable File REGISTER.FRM Registration Form README.1ST Conventional Documentation File UPDATE.DOC Release History (changes since initial version) VENDOR.DOC Shareware Vendor Distribution Policy Statement SUPPORT.DOC Tech Support Policy and ASP Ombudsman Statement DA_BROWS.EXE DeskTop Advisor (DA) Hypertext Browser DA_?.HLP DA help files (1 to 5) LROOM.DTA Hypertext Documentation File LROOM.MAP " " " LROOM.WDX " " " LROOM.XRF " " " LROOM.WLK " " " LROOM.TWX " " " LROOM.CWD " " " 4. WHAT IS LEGROOM? ─────────────────── LegRoom(tm) is published by Ivden Technologies, Inc. as part of its line of memory resident utilities. LegRoom was designed to solve two problems: a) shelling to DOS from programs that don't have a DOS shell function b) shelling from programs whose shell function gives too little memory at the DOS prompt to do any useful work. LegRoom(tm) allows you to Shell to DOS from any text and most graphic applications. It loads as a TSR (Terminate and Stay Resident) program and is triggered when you press a hot key. Version 2.0 now lets you make any program (even a DOS batch file) pop up as a TSR when you press the hot key. 5. HOW TO USE LEGROOM ───────────────────── LegRoom(tm) runs on any IBM compatible computer running MS-DOS, Version 2.0 and up, or 100% compatible operating system. Load LegRoom(tm) by entering the command LEGROOM from the directory where you installed it. You can also add that command to your AUTOEXEC.BAT file to load LEGROOM whenever you boot your computer. That way, it will stay in memory for use whenever you need it. LegRoom(tm) auto-detects the presence of extended and expanded memory and takes advantage of them. If available, it loads itself into expanded memory, taking up less than 2 KB of conventional memory. When you press the hot key, the current application is suspended. It is moved to a holding area in extended memory, expanded memory, or your hard disk, depending on which is available. The program, its data, video memory, mouse state, floating point coprocessor state, etc. are saved, as are your current drive and directory. When you are finished running other programs, type EXIT to return to the suspended application. Its state is restored to that saved prior to pressing the hot key. You needn't have an expanded memory board to have expanded memory. Memory managers such as EMM386, QEMM386, and 386MAX emulate expanded memory for applications which call for it. There are six command line parameters you can use to control the behavior of LegRoom(tm). These parameters are described below: LEGROOM [/D | /N] [/H=n] [/R=p] [/U] [/?], where: /D creates a temporary disk file for holding the current application, instead of using extended or expanded memory /N uses extended memory, if available, for holding the current application, but DOES NOT use expanded memory (this makes it run compatibly with QEMM in 'stealth' mode and the NetWare driver EMSNET) /H=n changes the default hot key from Ctrl-Shift-0 to Ctrl-Shift-n, where n is between 0 and 9 /R=p causes any program or DOS batch file to be run when the hot key is pressed (p is the complete path and file specification (including .exe, .com, or .bat extension) and optional command line /U unloads LegRoom(tm) from memory (you cannot unload it when you have shelled to DOS using it) /? displays help information without loading LegRoom(tm). To trigger LegRoom(tm), press the default hot key or the hot key you requested if you used the /H=n parameter as described above. Use the standard number keys on your keyboard, NOT THE NUMERIC KEYPAD. 6. USAGE NOTES ────────────── You can load LegRoom(tm) into upper memory with the "load high" facilities of a memory manager. This saves a small amount of conventional memory. The amount of the savings is greater when using the /N or /D switch. These switches prevent a 386 based memory manager from loading most of LegRoom(tm) into expanded memory. Ctrl-Break is disabled at the new DOS prompt after triggering LegRoom(tm). Use Ctrl-C instead of Ctrl-Break to break out of a process launched from the new DOS prompt. DON'T SHELL FROM A SHELL! If you loaded LegRoom without the /R= switch, you cannot trigger LegRoom(tm) when at the DOS prompt. This would be a waste of memory or disk space. However, LegRoom(tm) does not detect the presence of a DOS prompt created by using a program's built-in shell feature. Use one or the other, but not both. You can use LegRoom(tm) from multitasking environments such as DesqView and Microsoft Windows. The advantages of LegRoom(tm) are greatest in a single tasking DOS environment. If you decide to use LegRoom in a multitasking environment, be sure to load it from within a DOS 'box' or DOS 'window', NOT before entering the environment! Do not use LegRoom(tm) to shell from a communication program while transferring data. Shelling with LegRoom(tm) suspends the current application. It does NOT keep running in the background. Data will be lost if you use LegRoom(tm) to shell to DOS while performing a file transfer. You should, in general, not load a TSR into memory when you have shelled to DOS from an application. When you exit the application, your conventional memory pool has a 'hole' where the application was. This is called fragmentation. It reduces the largest block of memory available to programs. If you use LegRoom to make a batch file act as a TSR, add the following line to the end of the batch file: EXIT If it is necessary for LegRoom(tm) to create a swap file, it is identified by the LR_SWAP environment variable. It is recommended that you set this variable in your AUTOEXEC.BAT file so that it is set automatically whenever you boot your computer. Otherwise, the swap file is stored in a subdirectory named 'TEMP' under the directory where you installed LegRoom(tm). The swap file is stored with System and Read-Only attributes to reduce the risk of deletion or renaming while LegRoom(tm) is loaded. LegRoom(tm) supports any number of concurrent users on a network. Each user should be assigned a unique swap file in his/her LR_SWAP environment variable to avoid 'collisions'. Similarly, if you use LegRoom in multiple DOS sessions in DesqView or Microsoft Windows, and expect it to use disk space for swapping, set LR_SWAP to a different directory in each session before loading LegRoom. Each time LegRoom is loaded, the old swap file (if any) is replaced by a new one. The old swap file is also removed on unloading LegRoom. Rebooting or turning off the computer without first unloading LegRoom(tm) results in the current swap file remaining on the disk. LegRoom(tm) supports all standard graphic adapters and modes as well as Super VGA modes up to a maximum video memory requirement of 256 KB. 7. DISCLAIMER ───────────── IVDEN TECHNOLOGIES, INC. (IVDEN) HEREBY DISCLAIMS ALL WARRANTIES RELATING TO THIS SOFTWARE, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IVDEN WILL NOT BE LIABLE FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, INDIRECT OR SIMILAR DAMAGES DUE TO LOSS OF DATA OR ANY OTHER REASON, EVEN IF IVDEN OR AN AGENT OF IVDEN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL IVDEN'S LIABILITY FOR ANY DAMAGES EVER EXCEED THE PRICE PAID FOR THE LICENSE TO USE THE SOFTWARE, REGARDLESS OF THE FORM OF THE CLAIM. THE PERSON USING THE SOFTWARE BEARS ALL RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE. 8. DISTRIBUTION POLICY AND LICENSE ────────────────────────────────── Distribution Policy ─────────────────── ANYONE DISTRIBUTING LEGROOM FOR ANY KIND OF REMUNERATION MUST FIRST CONTACT IVDEN TECHNOLOGIES, INC. FOR AUTHORIZATION AT THE FOLLOWING ADDRESS: Ivden Technologies, Inc. 87 Arbor Road Churchville, PA 18966-1007 This authorization will be automatically granted to distributors recognized by the ASP as adhering to its guidelines for shareware distributors, and such distributors may begin offering LegRoom immediately. However, Ivden Technologies, Inc. must still be advised so that the distributor can be kept up-to-date with the latest version of LegRoom. License to Use LegRoom(tm) ────────────────────────── LegRoom(tm) is a copyrighted software package. It is being distributed as user supported shareware. By using or distributing this package, you agree to the following: You are granted a limited license to try this program, LegRoom(tm), for 30 days. If you find this software useful and wish to continue using it after the 30 day evaluation period, you must pay the registration fee. Registration for use on a single personal computer is $35.00. You may, instead, register for installation on a local area network (LAN) server. The LAN registration fee of $99 permits an unlimited number of concurrent users on the registered server. Register for each personal computer and each LAN server on which LegRoom(tm) is installed. To register, fill out the registration form (see REGISTER.FRM) and send it or a note with the registration fee. No other license or rights are granted by implication or otherwise. After evaluating LegRoom(tm), if you continue to use it, you MUST register. NOTE TO DEVELOPERS: If you would like to seamlessly integrate the LegRoom(tm) technology into programs you distribute for profit, Ivden Technologies, Inc. maintains an interrupt-triggered version. The developer version of LegRoom(tm) loads in advance of your program and resides in memory as an interrupt service routine dedicated to your program(s). You just call a specified interrupt and the DOS shell is triggered. No saving / restoring your screen. No worrying about how little memory will available for your 'child' program or at the DOS prompt. LegRoom(tm) takes care of everything. No link libraries to bother with. No memory models or compatibility issues to hassle with. Any language which has an interrupt call function is supported. Contact Ivden Technologies, Inc. for our very reasonable runtime license fee. 9. ON-LINE, HYPERTEXT VERSION OF THIS README DOCUMENT ───────────────────────────────────────────────────── A hypertext Readme document is also provided with this package. It was created using another Ivden product, DeskTop Advisor(tm), a hypertext document authoring system. In DeskTop Advisor(tm), information is organized in topics. From any topic, you can select other topics to explore by pressing Alt-T. To browse the DeskTop Advisor(tm) documentation, change to the directory on the disk where you installed LegRoom(tm). Then enter the command: DA_BROWS LROOM from the DOS prompt. The system will guide you from there. It is menu-driven and does not require a mouse. Every time you visit a new topic, a bookmark is placed at the current topic. No matter how deeply you go into the guide, you can retrace your steps, one topic at a time by pressing Ctrl-PgUp or pressing Alt-T and selecting ** PREVIOUS TOPIC **. To return to the beginning of this document from any topic, press Ctrl-Home or press Alt-T and select ** INTRODUCTION **. The Master Topic Index ────────────────────── You are not limited to using Alt-T for topic selection. You can access any topic wherever you are in the document. From any topic, you can view the master index of topics by pressing the Space Bar. Next, using the PgUp, PgDn, arrow keys, and keys for the first letter of a topic, you can highlight a topic of interest. Then, press Enter to proceed to the selected topic. As always, you can return to the previously visited topic by pressing Ctrl-PgUp or pressing Alt-T and selecting ** PREVIOUS TOPIC **. Hyperlinks ---------- On any screen there may be key words (called 'hyperlinks') about which you would like to get more information. By pressing the Tab key, you will make all such words appear highlighted. The first hyperlink on the screen is blinking, indicating it is currently selected. You can highlight a hyperlink in which you are interested by using the Tab, Home, and End keys. Press Enter and a menu of topics which reference the hyperlinked word appears. Select a topic which seems to be relevant to your needs. That topic will pop up in a window. Use the up and down arrow keys to view each page on which the word is used. When finished viewing the selected topic, return to the underlying topic by pressing Ctrl-PgUp. Select another related topic to explore or press ESCape to return to the underlying screen. Keyword Search -------------- You can perform a query from any topic to find all topics which relate to keywords of interest to you. Press Alt-F, then Q to select Query from the Files menu. As a shortcut, just press F2. Now enter up to three keywords which describe an area of interest to you. All topics which reference all the keywords will be retrieved, including the current topic. Each additional keyword beyond the first serves to narrow the search, filtering out more irrelevant topics. A menu of topics which satisfy your query will be presented. Select a topic and browse it using the PgUp and PgDn keys. When finished viewing the selected topic, return to the underlying topic by pressing Ctrl-PgUp. Select another related topic to explore or press ESCape to return to the underlying screen. Self-Promotion -------------- DeskTop Advisor(tm) has a few other features, not included here, such as graphic images and sound overlays. Sound Support(tm), a recorded voice supplement to the standard help screens, is also included with the product. In addition, a DeskTop Advisor(tm) document can be made memory resident, to be triggered by a hot key as needed. Closing Word ------------ That's all there is to it! We know LegRoom(tm) is so easy to use it doesn't really need hypertext documentation. But, we want as many computer users as possible to be exposed to the concept. We hope to make DeskTop Advisor(tm) a standard tool for publishing on-line documentation for software. Thanks for trying it. Your feedback is requested. Of course, we hope you find that LegRoom(tm) makes your DOS environment more productive. If you like the product, please register it. If you have comments -- positive or negative -- please share them with us.