*************************************************************************** * * * TDB v1.00 - Terminus DataBase utility * * * * Written by Robert Nottage * * * * Saturday 31/07/1993 * * * * Distribution and copyright statements inspired by Bob Rye :-) * * * *************************************************************************** Everything contained in this release of TDB v1.00 for the Amiga is USE-AT-OWN-RISK. I, the author, make no guarantee as to the fitness for use of this software. I accept no responsibility for possible damages incurred before, during or after execution of this software. *** * **** ** *** **** *** **** ** *** ***** * * * *** * * * * * * * * * * * * * * * * * * * * * * *** * *** **** **** *** *** *** **** * * * **** * **** * * * * * * * * * * * * * * * * * * * * * **** **** * * *** **** * * **** * * *** * * * * *** * ***************************************************************************** DID YOU PAY MONEY FOR THIS SOFTWARE? TDB is FREE This software is FREE. This software is "F R E E". If you have paid money for this software, then you have been ripped off. I have written this program for you, for free. If you paid for "support" from where you got this file, then you are also being ripped off. There is only one person who can fully help you with the operation of this program: me! (Rob Nottage, the guy who wrote this program.) You cannot obtain support from some unqualified desk-doofus hiding behind the facade of "a support specialist". All that these people are doing is making money from you, the innocent end-user, and ripping me off by immorally making money from *MY* programs. Please take a stand against these companies. Please don't buy *FREE* software from these companies. If you would like copies of any (or all) of the FREE software written by me, you can have them for *FREE*. That's right, for nothing. All I ask for is a blank disk(s), to copy the programs onto, and the cost of return postage (and your address!) or you can usually filerequest them from me at the FidoNet and AmigaNet addresses below. Then if you want "support" for my programs, send Netmail to me or snail-mail me and you'll get real support. STAND UP AND BE COUNTED. Say NO! to costly FREE software. ***************************************************************************** If you represent a PD/Shareware/Freeware library or electronic distribution system, then please feel free to contact me to gain written permission to allow you to legally include this software in your library, for distribution. The "ADS" electronic distribution system has my written permission to redistribute this software, as does Fred Fish. You may copy and transfer copies of this package to whoever you like, provided that this package is transferred completely intact, with all documentation and executables unmodified therein (modification of copyrighted works is called "contributory copyright infringement" and persons found infringing copyright are liable to legal action); however, if you represent a registered (or otherwise) company, and you wish to redistribute this package, you MUST obtain my written permission. The copyright to TDB, the documentation, the source-code, and the actual software remains the explicit property of Robert Nottage, (C) 1993. Distributors of this package must cease distributing this package, if and/or when, specifically requested to do so by the author(s). This request will be made in writing. ANY commercial distribution of this package without the prior written consent of the author is expressly prohibited. DISCLAIMER ¯¯¯¯¯¯¯¯¯¯ ALTHOUGH OUTSTANDING BUGS IN THE CODE HAVE BEEN ELIMINATED, THERE REMAINS THE POSSIBILITY OF UNFORESEEN PROBLEMS. I RESERVE THE RIGHT TO REFUTE THE EXISTENCE OF SUCH 'BUGS', BUT IF FOUND, I WILL ATTEMPT TO FIX SUCH PROBLEM(S). IF, HOWEVER, UNFORESEEN BUGS ARE FOUND TO CAUSE YOU MENTAL AND/OR PHYSICAL ANGUISH, THEN THAT IS AS THEY SAY IN THE CLASSICS, BAD LUCK! I ACCEPT NO BLAME FOR ANY LOSS OR INCONVENIENCE FOUND TO ARISE FROM THE (MIS)USAGE OF THIS PROGRAM. I RESERVE THE RIGHT TO WITHDRAW SUPPORT AND UPGRADES AT ANY TIME. I PROBABLY WON'T DO THIS, BUT I HAVE THIS RIGHT. ALL INSTANCES OF COMPANY AND/OR PRODUCT NAMES ARE (C), (R) AND (TM) RESPECTIVELY, WHERE APPLICABLE. "TDB" AND "TDB.DOC" ARE COPYRIGHT ROBERT NOTTAGE 1993. Minimum requirements -------------------- TDB has been extensively tested on: Amiga 2000/000 (vanilla PAL, 2.04 OS) Amiga 3000/030 (vanilla PAL, 2.04 OS) Amiga 4000/040 (vanilla PAL, 3.0 OS?) TDB will not work with OS version less than 2.xx nor with ReqTools less than v37. What is it? ----------- TDB is database program to make it easy looking up Terminus functions and variables. The minimum requirements are: - An Amiga with Kickstart 2.x or greater - gadtools.library (who doesn't have both of those together??? :-) - ReqTools.library v37 or greater - The supplied database file. TDB might not work with a modified database. How do I use it? ---------------- TDB will run from CLI or Workbench. The CLI commandline options and the Workbench tool-types are basically the same with the normal differences as noted. Tool-type keywords MUST be in uppercase. Options: If you type from the CLI 'TDB ?' you will see a template of arguments like this: FILE,PUBSCREEN,FONTNAME,FONTHEIGHT/N,ICONIFY/S,WINLEFT/N,WINTOP/N,ICONLEFT/N, ICONTOP/N,MAXHEIGHT/S,SORT/S: FILE: This allows you to specify the name of the database file. This may be as simple as 'database' if the file is in the current directory, or a full pathname. e.g: TDB FILE database or: TDB FILE MAIL:extra/tdbdatabase The FILE keyword may be omitted if you specify a filename as the first option. e.g. TDB s:terminusdatabase The WB tool-type would look like this: FILE=database PUBSCREEN: You can open the TDB window on any public screen. The iconified window and any requesters will also appear on the same screen. Ensure that you enter the correct case for the public screen name. e.g. TDB FILE database PUBSCREEN DOPUS.1 (not 'dopus.1') The WB tool-type would look like this: PUBSCREEN=TrapDoor FONTNAME: You may, to some degree, use any FIXEDWIDTH font of your choice. The font must be taller than 5 points and the window must be able to open to a predetermined number of characters wide and high. If you omit FONTNAME or the font cannot be used, then TDB will consider opening the window using the default screenfont. If this is also not usable then topaz 8 will be the font used. The '.font' extension is optional. e.g. TDB FILE database FONTNAME cleanibm The WB tool-type would look like this: FONTNAME=jrcibm.font FONTHEIGHT: The font height must be greater than 5 points. If you omit this option when using FONTNAME then the default will be 8 points. e.g. TDB FILE s:database FONTNAME cleanibm FONTHEIGHT 9 The WB tool-type would look like this: FONTHEIGHT=11 ICONIFY: This switch allows you to open directly into the iconified mode. e.g. TDB FILE database ICONIFY The WB tool-type would look like this: ICONIFY WINLEFT,WINTOP,ICONLEFT,ICONTOP: These options allow you to specify the initial position of the TDB window or iconified window on the screen. WINLEFT and WINTOP specify the TDB window left and top position. ICONLEFT and ICONTOP specify the iconified window left and top position. Each defaults to 0. e.g. TDB FILE database WINTOP 11 ICONLEFT 500 ICONTOP 0 The WB tool-types would look like this: WINLEFT=20 WINTOP=12 ICONLEFT=550 ICONTOP=1 MAXHEIGHT: Normally TDB will give you a textviewing area of 6 lines. You can force TDB to open a window to fit the maximum number of lines with this option. SORT: The Terminus functions and variables are listed separately in the database. You can have these mixed together and globally sorted with this option. The GUI ------- Once you have got TDB up and running, you should be viewing the first Terminus function/variable. Please consult the Terminus manual for the meanings of SCOPE, etc. Some functions and variables do not have defaults. Use the LISTVIEW gadget in the upper left corner to move about the list of functions and variables. Click on the required choice and you can now view the information. The large text area at the bottom gives you the syntax for the function in BOLD and an explanation of the usage below that. Use the scroll gadget to the right to view more text. Each Terminus function and variable can be used in different Terminus script and config files. The five boxes near the middle of the window will show a checkmark if you can use the currently viewed function in that type of script/config file. You may search for virtually any string of characters by selecting the SEARCH button. Just enter the string to search for in the requester that pops up. The string will be search for in ALL fields including 'scope' and 'default'. You can even enter '.con' as a search string and find any function or variable that is permitted in a '.con' console definition file. Search is CASE INSENSITIVE. Once you have found a match, you can then select the RESUME button and the next occurence will be found, if any. You can browse from one function to the next with the BROWSE button. This will start at the beginning once you reach the end. Help is also available. Use the menu item or press the HELP key. There are several hotkeys available. All menus have an associated hotkey indicated in the menu. Press the LEFT AMIGA key along with the indicated key. The UP and DOWN cursor keys are also available for use. Without pressing any qualifier keys, the cursor keys allow you to scroll the information text up and down. If you press SHIFT along with the cursor keys, you can jump from the top of the information text to the bottom and back. The cursor keys can also control the LISTVIEW gadget. If you press ALT with the cursor keys, you can scroll up and down the list. The information text will be updated as you go. Pressing CONTROL with the cursor keys allows you to jump to the top or bottom of the list. To save your current settings, select the 'PROJECT' menu, Save prefs... item. All settings will be saved in 'ENV:TDB.Prefs'. The next time you use TDB, these settings will be used, but will be overridden by any commandline arguments you use. If you run TDB from the workbench, the saved settings will be IGNORED. Use the tool-types instead. CREDITS & ACKNOWLEDGMENTS ------------------------- Terminus (C) John P. Radigan, the guy who knows how to get the best from your modem. ReqTools (C) Nico François, the man with the loaded requester. TDB is written in Amiga E (Amiga E by Wouter van Oortmerssen) (If you haven't tried Amiga E, you don't know what you're missing! It's even stealing some 'C' programmers :-) Thanx to Simon Richards for beta testing v1.00 and some of my other programs as well as finding any 68000 problems. Thanx to Dwayne Lindner for beta testing v1.00 and most of my other programs as well as finding any WB3 & 68040 problems, and mailing Jack R. Thanx to Jack Radigan for allowing me to include the database which is converted from the docs supplied with Terminus 2.0 & 2.0a Contacting me ------------- Rob Nottage Please don't use 'Robert', nothing recognizes that name, other than the copyright ownership and distribution restrictions (least of all me :-) Mail: 10 Chilver Street, Kewdale, Western Australia, 6105 Fax : +61 9 458-0154 Fido: 3:690/662.0 AmigaNet: 41:616/662.0 *Mail Only* BBS : +61 9 370-3333 @ 2400 370-3170 @ v.32/v.32bis/v.42bis (Only a user here) History ------- v1.00 31-Jul-93 (Added changes to DISPLAY and removed DISPID for v2.0a of Terminus)