ReadRefs Version 1.1 (C) 1992 by H.P.G FreeWare Index: Index General Description Legal Stuff System Requirements Usage Technical Address List of Files General Description: ==================== ReadRefs is a support programm that searches for a template in an dme.refs (or autodoc) refs file and if it finds a match then it copies the reference to a file named t:Refs.dat .This file could then easily included by each macro editor which doesn`t otherwise support refs. I used a fairly fast search algorythm that is just a little bit faster than the one in DMe. But if you call this program via REXX or Batch scripts you have in each case trouble with the speed. I wrote this little program for using it with TurboText which doesn`t support yet any refs. Before using TTX I used DMe (Dillons famous Macro Editor). TTX is a much more professional editor but I won`t miss the refs of DME. So I wrote ReadRefs. for all other TTX users, I included the needed Macros for the Refs functions in the Rexx drawer on this disk. Easily you can use ReadRefs in an shell alias to put out the reference to the Cli Window. E.G (asuming you`re using the wonderful CShell and have a refs file in c: that`s called MyRefs ) ` alias Refs "%s ReadRefs c:MyRefs $s ; if -f t:Refs.dat ; cat t:Refs.dat;endif" ` If you`re still using the standart Shell its the best to write a batch file. E.G ---------------------- Start of File .key Word ReadRefs c:MyRefs if Exists t:Refs.dat type t:Refs.dat else echo "No refs for found" endif --------------------- End Of File Assuming you named this batch file `s:Refs' you can simply type in the CLI Refs NewWindow. And if there is a reference in the c:MyRefs file it will be printed to the cli window. Legal Stuff: ============ This program  and all files come with it, also the docfiles, are released as FREEWARE. this means: everybody may use ReadRefs, everybody may copy ReadRefs, if: 1. You copy all included files, see list at the end of the doc file. 2. No changes are made, this  means  the  program and all included files must stay in the original form. Exception: you may archieve it; but in this case you must also archieve the whole package. 3. If you recompile it, you have to include a notice to the original author. If you also want to (re)distribute in any new form you have to send me a copy. 4. You may not sell ReadRefs. Execption: you`re allowed to take a small copy fee which should not extend 5US$. 5. If you want to include ReadRefs or one of the included files as a part of a commercial package, you must have written permission of the author (address see below). I take no warranty or garanty for the function of this program. The whole risk of using ReadRefs stays only by the user. System Requirements: ==================== ReadRefs is OS 2.xx only tool. It takes the advantage of some useful new OS 2.xx features and cannot run under older kickstart versions. (sorry). Also kickstart version 36 may have trouble. Usage: ====== The Syntax of ReadRefs is very simple. Sytax: ReadRefs helpfile/A template/A with helpfile : this is the dme.refs etc. refs file in which ReadRefs should search template : this is the template ReadRefs should search for A notice to the refs.file. If you want to use this feature and you have no matter what this is a refs file etc., you should look for an old DMe release that can be found on several fish and other fd disks. You can use the autorefs program to generate a refs file. Autorefs is also a part of the DMe release that is copyrighted by Matt Dillon. Autorefs has two different refs file syntaxes. One for doc files and one for C header files. ReadRefs supports both. If you set up correctly the references and call autorefs, nothing should go wrong. If you call ReadRefs and compare the resulted t:Refs.dat file with the one Dme will generate you will found no differences between that two files. I have included two rexx scripts in the Rexx drawer on this disk. The first one is assumed to be used within TurboText. This one is called 'TX_Refs.ttx'. The second is a general example how invoking the ReadRefs program by AREXX. You can call this example simply by calling 'RX' and adding the name of the script. This script is calling 'RX_Refs.rexx'. I have also included two batch files in the Batch drawer on this disk. The first one is called 'DOSRefs.bat' is to be used with the standart AmigaDOS Shell. The second one is called CSHRefs.sh and is to be used with the CSH shell which is copyrighted by U. Dominik Mueller. (Thanks Dominik for the best Shell in the AMIGA world). If you`re using another Shell it should not be difficoult to translate it to the script language. I have realeased this program to give more programmers the power of refs files. So you can often use it instead of a hundred (millon ...) pages manual. Technical: ========== ReadRefs is written with the Manx Aztec C Compiler V5.2. ReadRefs uses a fast algorythm for searching. I searches casesensitive that means e.g. Newwindow is not equal NewWindow. So there was no need to use something starnge like strnicmp or etc. routins that are somtimes slowly and always big in size. First readRefs only compares the first char or the template with the includes of the refs file. If it finds a matching one it jumps to a subroutine. So the filtering is fairly fast. But I will recomment to use ReadRefs on a harddisk system. I used also the following programs to create ReadRefs: AutoRefs,Dme : (C) by Matt Dillon ARexx : (C) by Chris Hames TurboText : (C) by Oxxi Directory Opus : (C) by Jonathan Potter Address: ======== Hans-Peter Guenther Gruener Weg 5 D-3501 Fuldatal 2 Germany List of Files: ============== All this files should be included in this package. If you miss some of this files this release is incomplete and illegal. Please let me know. ReadRefs : The binary ReadRefs.info ReadRefs.doc : The english documentation ReadRefs.doc.info ReadRefs.dok : The german documentation ReadRefs.dok.info Rexx/TTX_Refs.ttx : A script file to be used within TTX Rexx/TTX_Refs.ttx.info Rexx/RX_Refs.rexx : A AREXX script file Rexx/RX_Refs.rexx.info Rexx.info Batch/DOSRefs.bat : A batch file to be used with the AmigaDOS shell Batch/DOSRefs.bat.info Batch/CSHRefs.sh : A batch file to be used with the CSH shell Batch/CSHRefs.sh.info Batch.info