Short: ADHelp 1.0 - help system for programmers Type: dev/misc Author: muellerg@informatik.tu-muenchen.de Uploader: maurer@informatik.tu-muenchen.de TYPE dev/misc TITLE ADHelp - Powerful help system for programmers VERSION 1.0 - initial release (11-Jun-1994) COMPANY None AUTHOR Gerhard Müller internet: muellerg@informatik.tu-muenchen.de Fido : Gerhard Mueller @ 2:2480/3508.38 Z-Netz : GANDALF@AMC.ZER Klarweinstr. 32 81247 München GERMANY DESCRIPTION ADHelp integrates the search in autodoc files, include files (C or Assembler), man pages or SAS/C's sc_lib.guide in your favourite AREXX-capeable editor like CygnusED or EDGE. You can search after information with a single key. Imagine you want to use AllocMem, but you don't know what ADHelp needs as parameters. With a single key press, your editor will open a new "view" or "window", and you can see the autodoc page to AllocMem. There MEMF_FAST is explained. If you want to know how and where MEMF_FAST is defined, go with the cursor over the word MEMF_FAST and press the installed search key again. A new window is opened with exec/memory.h as contents. Very easy is also the browsing throuh structures! Just move the cursor over "ExecBase", for example, and a secound later you see the definition. Another thing that is very easy is searching for specific words. Imagine you know that there is a function or a define that starts with SetW*. Just enter this, press the help key, and you will get a list of entries, like graphics.library/SetWriteMask(AUTODOC:graphics.doc) intuition.library/SetWindowPointerA(AUTODOC:intuition.doc) intuition.library/SetWindowTitles(AUTODOC:intuition.doc) gfxmacros.h/SetWrMsk(gcc:os-include/graphics/gfxmacros.h) Just move your cursor to your wanted function, press the search key again, and, viola! Searching was never such easy. Sometimes you know not exactly how the function(definition etc..) is called, but you know where it should be defined, is is a man page from unix, is it a definition in a include file, or perhaps a function in , say, dos.library. With the extended help, you can spcify where ADHelp should look for you. Here some examples: *.0/* : a list of all functions/programs described in manpages is shown. strc*0*/* : strcasecmp.0/strcasecmp(gcc:man2/cat3/strcasecmp.0) strcat.0/strcat(gcc:man2/cat3/strcat.0) strchr.0/strchr(gcc:man2/cat3/strchr.0) strcmp.0/strcmp(gcc:man2/cat3/strcmp.0) strcoll.0/strcoll(gcc:man2/cat3/strcoll.0) strcpy.0/strcpy(gcc:man2/cat3/strcpy.0) strcspn.0/strcspn(gcc:man2/cat3/strcspn.0) [a-c]*.h/*Z* : A list of all defines/structures/typedefs... in include files which start with a, b or d is generated. dos*/GetP* : dos.library/GetProgramDir(AUTODOC:dos.doc) dos.library/GetProgramName(AUTODOC:dos.doc) dos.library/GetPrompt(AUTODOC:dos.doc) USAGE [some additional examples] int*/SetP* -> Help Key -> new "view" (Editor window): intuition.library/SetPointer(AUTODOC:intuition.doc) intuition.library/SetPrefs(AUTODOC:intuition.doc) intuition.library/SetPubScreenModes(AUTODOC:intuition.doc) AllocMem -> Help Key -> new view with: [Autodoc to AllocMem] MEMF_CLEAR -> Help Key -> new view with: [exec/memory.h, cursor stands on #define of MEMF_CLEAR] *.device/CMD_READ -> Help Key -> new view with: audio.device/CMD_READ(AUTODOC:audio.doc) clipboard.device/CMD_READ(AUTODOC:clipboard.doc) console.device/CMD_READ(AUTODOC:console.doc) narrator.device/CMD_READ(AUTODOC:narrator.doc) parallel.device/CMD_READ(AUTODOC:parallel.doc) serial.device/CMD_READ(AUTODOC:serial.doc) trackdisk.device/CMD_READ(AUTODOC:trackdisk.doc) narrator.device/CMD_READ(AUTODOC:narrator.doc) -> Help Key -> new view with autodoc page to CMD_READ of the narrator device. PRICE Suggested shareware/registration fee for keyfile is US$10 or DM 15. There is a discount if you order more than 2 keyfiles. Without keyfile a "shareware reminder requester" sometimes shows up. (ADHelp is not crippled in any way.) Please see the packet for exact payment instructions. SPECIAL REQUIREMENTS Requires AmigaOS 2.04 (V37), Commodores Installer Editor with AREXX-Interface like CygnusED, EDGE or GoldED Very useful is the Native Development Kit 3.1 (Includes & Autodocs) HOST NAME wuarchive.wustl.edu (128.252.135.4) [AmiNet] (and any other AmiNet mirror) DIRECTORY Aminet : /pub/aminet/dev/misc FILE NAME ADHelp10.lha (73914 bytes) DISTRIBUTABILITY ADHelp (C) 1994 Gerhard Müller, all rights reserved. This archive is freely distributable as long as the archive is intact and only a nominal fee is charged for its distribution. BACKGROUND ADHelp was written from a programmer for programmers. If you use ADHelp, you will fast not know how you could work without. OTHER XPK-support Support available direct from the author via EMail. ============================= Archive contents ============================= Original Packed Ratio Date Time Name -------- ------- ----- --------- -------- ------------- 34040 16426 51.7% 11-Jun-94 17:15:24 ADHelp10/ADhelp 43825 14524 66.8% 12-Jun-94 16:55:24 ADHelp10/ADhelp.guide 1553 634 59.1% 11-Jun-94 15:06:48 ADHelp10/ADhelp.guide.info 1024 809 20.9% 11-Jun-94 14:59:06 ADHelp10/GetAsmIncludeIndex 722 345 52.2% 11-Jun-94 14:59:38 ADHelp10/rexx/ADHelp.ced 1023 438 57.1% 11-Jun-94 14:59:38 ADHelp10/rexx/ADHelp.edge 1449 666 54.0% 11-Jun-94 14:59:38 ADHelp10/rexx/ADHelp.ged 1440 655 54.5% 11-Jun-94 14:59:38 ADHelp10/rexx/ADHelpAsk.ged 3992 741 81.4% 11-Jun-94 15:06:48 ADHelp10/ADHelp.info 7012 3908 44.2% 11-Jun-94 14:59:06 ADHelp10/ConvertTabsToSpaces 10620 5853 44.8% 12-Jun-94 16:19:22 ADHelp10/GetAutodocOffsets 11632 6247 46.2% 12-Jun-94 16:20:32 ADHelp10/GetIncludeStructsOffsets 10244 5749 43.8% 11-Jun-94 14:59:06 ADHelp10/GetManPagesOffsets 1830 766 58.1% 11-Jun-94 14:59:38 ADHelp10/rexx/enhanced/ADHelp.ged 1721 706 58.9% 11-Jun-94 14:59:38 ADHelp10/rexx/enhanced/ADHelpAsk.ged 2278 568 75.0% 11-Jun-94 15:56:14 ADHelp10.info 5260 3107 40.9% 11-Jun-94 14:59:06 ADHelp10/GetSCLibOffsets 20041 5495 72.5% 12-Jun-94 16:48:48 ADHelp10/Install ADHelp 733 363 50.4% 11-Jun-94 16:04:02 ADHelp10/Install ADHelp.info 2827 1153 59.2% 11-Jun-94 14:59:06 ADHelp10/Registration_form 6768 3719 45.0% 11-Jun-94 14:59:06 ADHelp10/RemoveAnsiFromManpages -------- ------- ----- --------- -------- 170034 72872 57.1% 16-Jun-94 08:50:24 21 files