home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / ch137_e.lha / CHELP_EN.DOC < prev    next >
Text File  |  1992-11-08  |  14KB  |  408 lines
  1. ****************************************************************************
  2. *                                                                          *
  3. * Chelp V1.36 by Robert Wahlström, Mathias Widman         92-Oct-20        *
  4. *                                                                          *
  5. * Copyright (C) 1992 by R Wahlström, M Widman. All rights reserved.        *
  6. *                                                                          *
  7. * Search for functions in autodocs and structs & defines in c-includefiles *
  8. *                                                                          *
  9. * Written in Lattice C 5.10b with CygnusED Pro and CHELP on Amiga 3000.    *
  10. *                                                                          *
  11. *  Robert Wahlström                                                        *
  12. *  Enehagsg 197                                                            *
  13. *  S-441 57  ALINGSÅS   SWEDEN                                             *
  14. *                                                                          *
  15. *  Usenet:  d0robert@dtek.chalmers.se                                      *
  16. *  Fidonet: Robert Wahlstrom@2:203/316                                     *
  17. *                                                                          *
  18. *                                                                          *
  19. *  Mathias Widman                                                          *
  20. *  Tegelbruksg 77                                                          *
  21. *  S-441 56 ALINGSÅS    SWEDEN                                             *
  22. *                                                                          *
  23. *  Usenet:  d0omega@dtek.chalmers.se                                       *
  24. *  Fidonet: Mathias Widman@2:203/316                                       *
  25. *                                                                          *
  26. *  Support BBS:  UTILITYBASE  +46-322-17877  (14.4k HST)  2:203/316        *
  27. *                                                                          *
  28. ****************************************************************************
  29. $VER: Chelp.doc  V1.31 (92-Oct-20)   by R Wahlström, Mathias Widman 1992
  30.  
  31.  
  32. Chelp is Shareware, and may be distributed in a non-commercial way (you may
  33. copy, spread, and use it but don't make money out of it).
  34. The programmers take no responsibility for eventual errors that the program
  35. may create in any way. You run it on your own risk. We have done everything
  36. we can to assure that it functions correctly. Many hours of testing and
  37. debugging have been done. (If you still find any bugs, please report).
  38.  
  39.  
  40. *** REGISTRATION ***********************************************************
  41.  
  42. If you find Chelp useful, please register by sending US$20 to either of the
  43. above addresses. (In Sweden you can use POSTGIRO: 641 57 17-5, 100 SEK).
  44. Please state your full name and address, machinetype, BBS (if you run one)
  45. so that we can send you the registered version.
  46.  
  47. ****************************************************************************
  48.  
  49.  
  50. 1 What is Chelp?
  51.   ==============
  52.  
  53. Chelp is a program that will make life easier for programmers. Everybody
  54. knows how timeconsuming and boring it is to lookup things in the RKRM
  55. Includes & autodocs.
  56.  
  57. With Chelp you can now do all this on the computer right at your fingertips. 
  58.  
  59. ex. What does the Gadget struct look like?
  60.     Type Chelp gadget   - and it will show up on your screen.
  61.  
  62.     RemoveAppIcon, I need to know all about it!
  63.     Type Chelp removeappicon    - and it will give you what you need to know
  64.         about RemoveAppIcon (That exists in the Autodocs + Includes)
  65.  
  66.     In what includefile is SELECTED defined?
  67.     Type Chelp SELECTED  
  68.  
  69.  
  70. 2 What is needed?
  71.   ===============
  72.  
  73. a)  If you want to lookup things in autodocs, you will need them (the program
  74.     works well without them, but you will miss a great part of the advantages
  75.     of Chelp).
  76.     If you don't have these files you can order them from CATS (Commodore
  77.     Applications and Technical Support) for some money probably.
  78.  
  79. b)  You will also need the C-Includes that came with your compiler software.
  80.  
  81. c)  System requirements: Chelp works on all Amigas with a harddisk that runs
  82.     Kickstart 2.04 (release v37). For those of you that haven't upgraded yet
  83.     there is a mini version included.
  84.  
  85. Address to CATS:    CATS-Information
  86.                     1200 Wilson Drive
  87.                     West Chester, PA 19380-4231
  88.  
  89.  
  90. 3 Installation
  91.   ============
  92.  
  93.  
  94. Start Chelp from Workbench by doubleclicking the Chelp-Icon, or type Chelp -i
  95. from th CLI.
  96. You will then see a requester telling you that s:chelp.cfg doesn't exist.
  97. There you will choose 'default'.
  98.  
  99. If you don't want the config file in s:, you can create an environment variable
  100. named CHELP and there put your path.
  101.  
  102. ex: setenv CHELP Work:config
  103.     
  104. Enter the path to where your autodocs are in the field 'Path to .doc'.
  105. There is a checkbox to the right that enables Chelp to process the autodocs.
  106. If you don't wish to use the autodocs (or if you don't have them), disable.
  107.  
  108. ex. work:lc/autodocs
  109.  
  110. Enter the path to where your includes are in the field 'Path to .h'.
  111. There is a checkbox to the right that enables Chelp to process the includes.
  112. If you don't wish to use the autodocs (or if you don't have them), disable.
  113.  
  114. ex. work:lc/compiler_headers
  115.  
  116. IMPORTANT!! You must specify the path to the non-compacted include files,
  117. not to the compacted ones that you normally have in INCLUDE:
  118.  
  119. Enter the path to where you want the referencefiles to be built in the field
  120. 'Path to ref'. Ex RAM: or s:. If you use RAM: you must rebuild each time you
  121. have rebooted. 
  122.  
  123. Now press SAVE.
  124.  
  125. To create the referencefiles that Chelp needs, press the BUILD button (or if
  126. in CLI mode type chelp -b). This will take a few minutes depending on the
  127. speed of your hardware.
  128.  
  129.  
  130. 4 Start from CLI
  131.   ==============
  132.  
  133. Syntax: Chelp [Flag] [Keyword] [Subheader]
  134.  
  135. Chelp -B            - Builds the referencefiles. You must do this if you
  136.                     change the path to includes/autodocs, or you install
  137.                     new includes/autodocs. We recommend that you run
  138.                     Chelp -b every time you get a new version of Chelp.
  139.  
  140. Chelp -l <keyword>  - Lists all functions/structs/defines that matches
  141.                     the pattern [keyword].
  142.  
  143.  
  144. Chelp [keyword] [subheader]
  145.  
  146.                     - Looks up all functions/structs/defines that matches
  147.                     the pattern [keyword].
  148.  
  149.               ex:   Chelp addappicon - gives you info about AddAppIcon
  150.  
  151.               ex:   Chelp window - gives you info about the struct window
  152.  
  153.  
  154.               ex:   chelp exec - gives you includefile exec.h 
  155.  
  156.  
  157.               ex:   Chelp GA_* - gives you info about all GadgetAttributes
  158.  
  159.                     If [keyword] ends with * or + you will get all functions
  160.                     /structs that begins with 'keyword', see wildcards for
  161.                     more info.
  162.  
  163.                     If 'subheader' exists, you will only get that part of the
  164.                     autodoc that matches the subheader.
  165.  
  166.               ex:   Chelp addappicon name - gives you the text that is in the
  167.                     paragraph name.
  168.  
  169.                     NAME
  170.  
  171.                     NAME                                                                       
  172.                         AddAppIcon - add an icon to workbench's list of appicons.
  173.  
  174.               ex:   Chelp Create* synopsis - gives you info about everything in
  175.                     the paragraph synopsis of every fuction that matches Create*.
  176.  
  177. Chelp -C [keyword]  Samw as for CHelp [keyword] except that the keyword is case
  178.                     dependent.
  179.  
  180.               ex:   Chelp -c Open - find Open but not open
  181.         
  182.               ex:   Chelp -c open* - finds all that starts with open, but not
  183.                     those with Open 
  184.  
  185. Chelp -d [keyword] [subheader]
  186.  
  187.                     Search only in autodocs.
  188.  
  189. Chelp -h [keyword]  Search only in includes.
  190.  
  191. Chelp -i            See Intuition interface.
  192.  
  193. Chelp -s            Starts Chelp in the background (sleep mode). It will wait
  194.                     for either a hotkey to wake up or some Arexx messages.
  195.  
  196.  
  197. 5 Start from Workbench
  198.   ====================
  199.  
  200.   You can start Chelp from Workbench by doubleclicking on the Chelp-Icon.
  201.   If HIDE in tooltypes isn't YES, a window will open.
  202.   If HIDE in tooltypes is YES, no window will open, but Chelp will start in
  203.   sleep mode. 
  204.  
  205.   TOOLTYPES:
  206.  
  207.     HIDE:
  208.   
  209.         If HIDE=YES no window will open. (Sleep mode)
  210.         
  211.         If HIDE=NO or doesn't exist a window will open.
  212.  
  213.     HOTKEY:
  214.  
  215.         This tooltype describes the standard hotkey for Chelp to wake up from
  216.         sleep mode.
  217.         NOTICE! This hotkey will be used before the one in the configfile. 
  218.  
  219.         If hotkey doesn't exist, the one from the configfile will be used.
  220.  
  221.     DONOTWAIT:
  222.  
  223.         Include this if you put Chelp in your WBstartup drawer.
  224.  
  225.  
  226. 6 INTUITION INTERFACE
  227.   ===================
  228.  
  229. If you start chelp with the option -i, ie. 'chelp -i' or from workbench,
  230. a window will be opened with some gadgets: BUILD, HIDE, QUIT.
  231.  
  232. 6.1 Build
  233.  
  234.     This gadget starts the building procedure that examines your autodocs
  235.     and includes. This is to be done every time you have changed the path
  236.     to your includes/autodocs or if you have installed or altered some
  237.     includes/autodocs files. The building procedure can be aborted by
  238.     clicking on the build gadget again.
  239.     
  240. 6.2 Hide
  241.  
  242.     The hide gadget closes Chelps window while chelp is active in the
  243.     background, ready to receive command via arexx. The window can be
  244.     opened again thru hotkeys (default: shift+control+c). Clicking on the
  245.     windows close gadget has the same effect as hide.
  246.     
  247. 6.3 Quit
  248.  
  249.     Quits chelp.
  250.  
  251.  
  252. 6.4 Preferences
  253.  
  254.     The lower part of Chelps window is the preference part.
  255.     Here is a description of the diffrent options.
  256.  
  257.     [Path to doc.]: Here you should enter the path to where your autodocs
  258.     are. If you don't have or want to use them deselect this option with
  259.     the checkbox to the right.
  260.  
  261.     ex work:lc/autodocs_2.04/
  262.  
  263.     [Path to .h]: Here you should enter the path to your include files. It
  264.     is very important that this is the path to your NON-COMPACTED includes !
  265.     Chelp can only parse and examine the pure text ones. If you don't have
  266.     or want to use includes with chelp, deselect with the checkbox to the
  267.     right.
  268.     
  269.     ex work:lc/compiler_headers/
  270.  
  271.     [Path to .ref]: This path is to the place where chelp will build its
  272.     reference files. A good place to have them in is in the S: directory.
  273.     You can speed up the build procedure by setting this path to ram:
  274.     and then build. After build is finished, move the reference files:
  275.     Chelp.href, Chelp.dref to S: and change the path to S:
  276.  
  277.     [Arexx outpath]: This is the path to where chelp will send its output
  278.     to when commanded through arexx. The outfile is named 'chelp.lup' 
  279.  
  280.     ex ram:
  281.  
  282.     [Hotkey]: The hotkey definition (standard OS 2.04 def.) that chelp will
  283.     use. default: shift control c
  284.     
  285.     ex   'shift control c'  
  286.     
  287.     [Build Define]: If you select this option chelp will also create references
  288.     to all defined values in the includefiles. Deselecting this option will
  289.     make a lot smaller referencefiles (but no lookup on defines).
  290.     
  291.     [Typedef]: This gadget selected, will also give you the form of output as
  292.     shown below when looking up functions that are typedef'd.
  293.  
  294.     ex: chelp printf    (with Typedef selected)
  295.  
  296.        Function: printf   Includefile: stdio.h
  297.  
  298.        (int) printf(char*,...)
  299.  
  300.     
  301.     Save   - Save the configuration.
  302.  
  303.     Undo   - Load the last saved configuration.
  304.  
  305.     If chelp.cfg exists in the local directory it will be used instead of
  306.     s:chelp.cfg.
  307.  
  308.  
  309.  
  310. 7 WILDCARDS
  311.   =========
  312.  
  313. Keywords can be given with wildcards. These are the following valid wildcards:
  314.  
  315. ?  = One character
  316. #? = Anything (matching several characters)
  317. |  = 'Or' in combination with parenthesis.
  318. (  = Start of wildcard comparelist.
  319. )  = End of wildcard comparelist.
  320. *  = Same as #?
  321. +  = Same as #?
  322.  
  323. Ex: #?gadget#? give you all words that contains gadget. 
  324.     ActivateGadget, AddGadget, CreateGadget, GT_SetGadgetAttrs etc.
  325.  
  326.  
  327. 8 AREXX
  328.   =====
  329.  
  330.  
  331. If Chelp is started with the options -i or -s or from the workbench, then an
  332. Arexx port will be opened with the name CHELP1 for the first, CHELP2 for the
  333. second and so on. 
  334.  
  335. Arexx commands:
  336.  
  337. OPENWINDOW  - Opens the intuinion interface (window)
  338.  
  339. CLOSEWINDOW - Closes the intuition interface (window)
  340.  
  341. BUILD       - Will open the window (if closed) and start the building
  342.                procedure.
  343.  
  344. LOOK xxxxx  - Performs a lookup on the keyword 'xxxxx'.
  345.                Outfile is path:chelp.lup
  346.                Where path is the path you have entered in the Arexx outpath
  347.                gadget.
  348.  
  349.              ex: Look printf
  350.  
  351.              ex: LOOK window*  
  352.                                       
  353. CLOOK       - Case sensitive lookup.
  354.  
  355.     ex:  CLOOK Open    will give you Open, not open.
  356.  
  357.  
  358. VERSION     - returns version in result ex 'Chelp v1.21'
  359.  
  360. GETVAR x    - returns for x=
  361.  
  362.             1 - Path to autodocs
  363.             2 - Path to include files
  364.             3 - Path to references files
  365.             4 - Path to arexx output
  366.             5 - Hotkey combination
  367.             6 - Hotkey combination for lookup in CED
  368.             7 - Number of keywords in autodocs
  369.             8 - Number of keywords in includefiles
  370.             9 - Search/build Autodocs (ON = 1 / OFF = 0)
  371.            10 - Search/build Includes (ON = 1 / OFF = 0)
  372.            11 - 'Typedef' (ON = 1 / OFF = 0)
  373.            12 - Build #define (ON = 1 / OFF = 0)
  374.  
  375.  
  376. DEBUG ON    - Arexx debugging mode. Debugging info in windowtitle.
  377.  
  378. DEBUG OFF   - guess!
  379.  
  380.  
  381. QUIT        - Quits chelp.
  382.  
  383.  
  384.  
  385. 9 Future versions
  386.   ===============
  387.  
  388. Intuition interface for lookup.
  389. Support for 'one key lookup' in editors: Turbotext, Lse...
  390. Support for C++, classes...
  391. Your wishes and ideas.
  392.  
  393.  
  394.  
  395. THANKS!
  396. -------
  397.  
  398.  
  399. Thanks for you help with this project:
  400.  
  401.     Kjell Cederfeldt
  402.     Mikael Berglund
  403.     Kjell Harnesk
  404.  
  405.  
  406.  
  407. /Robert Wahlström and Mathias Widman
  408.