home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / ch137_e.lha / CHELP_SW.DOC < prev    next >
Text File  |  1992-11-08  |  15KB  |  431 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.36 (92-Oct-20)   by R Wahlström, Mathias Widman 1992
  30.  
  31.  
  32. Chelp är Shareware, och får spridas i icke kommersiellt syfte (alltså
  33. kopiera, sprid det och använd det, men tjäna inte pengar på det).
  34. Progammerarna tar inget ansvar för felaktigheter som programmet skapar eller
  35. som skapas av programmet på något sätt. Du kör programmet på egen risk. Vi
  36. har dock gjort allt för att det skall fungera så säkert som det bara går.
  37. Vi har lagt lång tid på tester, men om några buggar (felaktigheter ändå
  38. skulle finnas meddela gärna oss).
  39.  
  40. *** REGISTRERING ***
  41.    
  42. Om du finner Chelp användbart, Registrera dig som användare genom att skicka
  43. in 100 SEK till:
  44.  
  45. Chelp
  46. Robert Wahlstöm
  47.  
  48. PG  641 57 17-5
  49.  
  50.  
  51. 1 VAD ÄR CHELP?
  52.   =============
  53.  
  54. Chelp är ett program för att göra livet lättare för programmerare. Alla vet
  55. hur jobbigt det är att slå i RKRM Includes & autodocs när man vill se
  56. efter vad en funktion gör/ser ut eller vad den där strukturen innehåller.
  57. Med hjälp av chelp kan man få den informationen direkt på datorn istället. 
  58.  
  59. ex. Hur ser Gadget strukturen ut?
  60.     Skriv Chelp gadget   så kommer allt upp i cli fönstret.
  61.  
  62.     RemoveAppIcon hur såg den ut nu igen?
  63.     Skriv Chelp removeappicon  - ger allt om RemoveAppIcon som finns i autodocs
  64.  
  65.     SELECTED var finns den definerad?
  66.     Skriv Chelp SELECTED  
  67.  
  68.  
  69. 2 VAD BEHÖVS?
  70.   ===========
  71.  
  72. Om man vill söka i autodocs så är det en fördel att ha dessa (programmet
  73. fungerar även bra utan, men då missar man en del av programmets fördelar.)
  74. Om du inte har autodocs på datorn och vill ha dessa så kan dessa beställas
  75. från CATS (Commodore Applications and Technical Support) för en mindre
  76. summa. Kan troligen köpas genom Svenska Commodore också.
  77.  
  78. C-Includefiler (okompakterade) som du fick med din kompilator.
  79.  
  80. Systemkrav: Fungerar på alla amigor med hårddisk. Chelp kräver Kickstart
  81. 2.04 (release v37). För de som inte ännu har kickstart 2.0 så finns en
  82. 'mini' chelp som fungerar på alla amigor. Läs om den i sw_mini.doc.
  83.  
  84. Adress CATS:    CATS-Information
  85.                 1200 Wilson Drive
  86.                 West Chester, PA 19380-4231
  87.  
  88.  
  89. 3 Installation
  90.   ============
  91.  
  92.  
  93. Starta Chelp från Workbench genom att dubbelklicka på Chelpikonen, eller
  94. genom att skriva chelp -i i CLI.
  95.  
  96.  
  97. Du får då en requester om att s:chelp.cfg ej finns. Välj default i så fall.
  98.  
  99. Om du ej vill ha config filen i s:, kan du skapa en environmentvariabel
  100. med namnet CHELP där du lägger pathen till.
  101.  
  102. ex: setenv CHELP Work:config
  103.     
  104. I fältet Path to .doc ange pathen till var dina autodocsfiler finns. Om
  105. fältet är skuggat tryck på rutan efter fältet. Om du ej har autodocs-
  106. filer låt skuggningen vara kvar, eftersom programmet då slipper söka
  107. efter dessa.
  108.  
  109. ex work:lc/autodocs
  110.  
  111. I fältet Path to .h ange pathen till dina includefiler. Samma saker 
  112. enligt ovan angående skuggning av fältet.
  113.  
  114. ex work:lc/compiler_headers
  115.  
  116. OBS!! Du måste ange pathen till de icke kompakterade includefilerna,
  117. inte till de kompakterade som man normalt har i INCLUDE: 
  118.  
  119.  
  120. I fältet Path to .ref anger du var referensfilerna som byggs upp av chelp
  121. ska lagras. Ex RAM: eller s:. Använder du RAM: måste du skapa om
  122. referensfilerna efter varje ombootning. 
  123.  
  124. Tryck på SAVE.
  125.  
  126.  
  127. För att skapa referensfilerna som chelp behöver, skriv Chelp -b från CLI
  128. eller tryck på BUILD-gadgeten om du har startat chelp från Workbench 
  129. eller med Chelp -i. Detta tar några minuter.
  130.  
  131.  
  132.  
  133. 4 Starta från CLI
  134.   ===============
  135.  
  136. Från CLI skriver du: Chelp [Flag] [Keyword] [Subheader]
  137.  
  138. Chelp -b/B          - Bygger referensfiler. Du måste göra detta om du
  139.                     ändrar pathen till include/autodocs, eller får nya
  140.                     include/referensfiler. Vi rekommenderar att du kör
  141.                     Chelp -b varje gång du får en ny version av Chelp.
  142.  
  143. Chelp -l <keyword>  - Listar alla funktioner/strukturer som börjar på
  144.                     keyword.
  145.  
  146.  
  147. Chelp [keyword] [subheader]
  148.  
  149.                     - Listar alla funktioner/strukturer/definitioner som
  150.                     matchar [keyword].
  151.  
  152.               ex:   Chelp addappicon - ger dig information om funktionen
  153.                     AddAppIcon
  154.  
  155.               ex:   Chelp window - ger dig info om structuren Window
  156.  
  157.               ex:   Chelp GA_ToggleSelect     
  158.  
  159.                     Om keyword slutar på * eller + så får man alla
  160.                     funk/strukt som börjar på keyword Se wildcards för
  161.                     mer information.
  162.  
  163.               ex:   chelp exec - visar hela exec.h includefilen
  164.  
  165.               ex:   Chelp create* - ger dig info om alla funk/strukt som
  166.                     börjar på create 
  167.  
  168.                     Om 'subheader' finns visas bara de stycken som har
  169.                     rubriken subheader.
  170.  
  171.               ex:   Chelp addappicon name - ger texten som finns i stycket
  172.                     NAME
  173.  
  174.                     NAME                                                                       
  175.                         AddAppIcon - add an icon to workbench's list of 
  176.                         appicons.
  177.  
  178.               ex:   Chelp Create* synopsis - ger dig inforamation om allt som
  179.                     finns under stycket synopsis i alla funktioner som
  180.                     börjar på create.   
  181.  
  182. Chelp -c [keyword]  Samma som CHelp [keyword] förutom att små och stora
  183.                     bokstäver inte är samma.
  184.  
  185.               ex:   Chelp -c Open - hittar Open men inte open
  186.         
  187.               ex:   Chelp -c open* - hittar alla som börjar på open, men inte
  188.                     de som börjar på Open 
  189.  
  190. Chelp -d [keyword] [subheader]
  191.  
  192.                     Söker enbart i autodocs
  193.  
  194. Chelp -h [keyword]  Söker enbart i includefilerna.
  195.  
  196. Chelp -i            Se Intuition interface.
  197.  
  198. Chelp -s            Startar igång chelp i bakgrunden. Chelp tar emot arexx-
  199.                     kommandon och man kan hotkeya fram intuitionfönstret
  200.                     (samma som man får genom chelp -i) 
  201.  
  202.  
  203. 5 Starta från Workbench
  204.   =====================
  205.  
  206.   Chelp startas från Workbench genam att man dubbelklickar på chelps ikon.
  207.   Om HIDE i tooltype inte är YES så kommer ett fönster upp (ntuition
  208.   interfacet)
  209.   Om HIDE i toolstypes är YES så kommer inget fönster upp utan chelp körs i
  210.   bakgrunden och väntar på att hotkeyas fram eller ta emot kommandon via
  211.   arexx. 
  212.  
  213.   TOOLTYPES:
  214.   Genom att klicka på chelps ikon en gång så den blir markerad och sedan
  215.   välja 'Information' från workbenchmenyn så kan man ändra de verktygs-
  216.   typer (tooltypes) som chelp använder. 
  217.  
  218.   TOOLTYPES som chelp känner till:
  219.  
  220.     HIDE:
  221.   
  222.         Om HIDE=YES så öppnas inte chelps fönster när man startar chelp
  223.         utan chelp kommer att köras i bakgrunden.
  224.         
  225.         Om HIDE=NO eller inte finns så kommer chelps fönster upp vid start.
  226.  
  227.     HOTKEY:
  228.  
  229.         Om hotkey ej finns så väljs den som som är sparad i konfigurationen.
  230.  
  231.         Om hotkey finns så startas chelp med den valda hotkeykombinationen
  232.         OBS! Den hotkeykombinationen som är sparad i konfigurationen kommer
  233.         att ersättas med denna. 
  234.  
  235.     DONOTWAIT:
  236.  
  237.         Om Chelp skall startas från WbStartup bilioteket så måste denna
  238.         vara med.
  239.  
  240.  
  241.  
  242. 6 INTUITION INTERFACE
  243.   ===================
  244.  
  245. Om du startar Chelp med 'chelp -i' eller från Workbench genom att dubbel-
  246. klicka på Chelp-ikonen öppnas ett intuitionfönster. I fönstret finns det 
  247. tre gadgets BUILD, HIDE och QUIT. 
  248.  
  249. 6.1 Build
  250.  
  251.     Bygger referensfiler för Chelp. Detta bör göras varje gång pathen
  252.     till include/autodocs ändras eller om nya include/referencefiler har
  253.     installerats. Om man vill avbryta, tryck på build en gång till.
  254.     
  255. 6.2 HIDE
  256.  
  257.     Stänger Chelps intuition fönster. Chelp körs fortfarande och tar emot 
  258.     kommandon via arexx. Fönstret kan öppnas igen via hotkeys
  259.     (shift+control+c) eller det man har skrivit in i rutan efter hotkey.
  260.  
  261. 6.3 Quit
  262.  
  263.     Avslutar Chelp.  
  264.  
  265.  
  266. 6.4 Preferences
  267.  
  268.     I den nedre halvan av intuitionfönstret finns det Gadgets för inställning
  269.     av programmet.
  270.  
  271.     I mitten av fönstret finns det 5 textfält. 
  272.  
  273.     I det första 'Path to .doc' anges pathen till var autodocsfilerna
  274.     finns. Om dessa ej finns eller ej önskas, tryck på checkboxgadgeten till
  275.     höger om fältet så att fältet blir 'skuggat'.
  276.  
  277.     ex work:lc/autodocs_2.04/
  278.  
  279.     'Path to .h': Ange här pathen till dina ICKE kompakterade includefiler. 
  280.     Om du anger pathen till de kompakterade includefilerna som normalt
  281.     finns i INCLUDE: så kommer chelp inte att hitta några strukturer.
  282.     
  283.     ex work:lc/compiler_headers/
  284.  
  285.     I fältet Path to .ref anges var referensfilerna som byggs upp av chelp
  286.     ska lagras. Ex RAM: eller s:. Använder du RAM: måste du skapa om
  287.     referensfilerna efter varje ombootning. 
  288.  
  289.     I fältet 'Arexx outpath:' anges path till den filen som skapas genom 
  290.     lookup via arexx. Filen kommer heta chelp.lup.
  291.  
  292.     ex ram:
  293.  
  294.     I fältet 'Hotkey' anges vilken tangentkombination som skall användas
  295.     för att öppna chelp's fönster om chelp körs dolt i bakgrunden.
  296.     
  297.     ex 'shift control c'  
  298.     
  299.     Build Define: Med hjälp av denna gadgeten bestämmer man om man vill skapa
  300.     referensfiler för #define vid build. Om man ej har 'build define' på så 
  301.     kan man inte söka efer defines, men referensfilerna blir mycket kortare om
  302.     man har platsbrist.
  303.     
  304.     Checkboxgadgeten TYPEDEF:
  305.  
  306.     Med hjälp av denna gadgeten kan man välja om man vill ha med typedef
  307.     från includefilerna. 
  308.  
  309.     ex: chelp printf   med TYPEDEF på ger
  310.  
  311.        Function: printf   Includefile: stdio.h
  312.  
  313.        (int) printf(char*,...)
  314.  
  315.     
  316.     SAVE   - spara alla ändringar i konfigurationsfilen. Även fönster-
  317.              positionerna för intution-, preferences-fönstret sparas.
  318.  
  319.     UNDO   - Laddar in de senaste sparade inställningarna.
  320.  
  321.  
  322.     Om chelp.cfg finns i det lokala biblioteket används den istället
  323.     för s:chelp.cfg.
  324.  
  325.  
  326.  
  327.  
  328. 7 WILDCARDS
  329.   =========
  330.  
  331. Keyword kan anges med Wildcard. Wildcard betyder vilda kort och fungerar
  332. som ersättningstecken, (vad som helst tecken). Ex: Anges #?window så
  333. betyder det att allt som slutar på window är överensstämmande med sök-
  334. strängen. #?window är lika med openwindow och closewindow osv.
  335.  
  336. Vad betyder då alla wildcard tecken?:
  337.  
  338. ?  = Ett valfritt tecken 
  339. ?? = Två valfria tecken.
  340. #? = Vad som helst (flera tecken)
  341. |  = Eller i kombination med paranteser
  342. (  = Start av wildcards jämförelselista 
  343. )  = Slut på wildcards jämförelselista 
  344. *  = Samma som #? 
  345. +  = Samma som #?
  346.  
  347. Ex: #?gadget#? ger alla keywords som har gadget i namnet, tex: 
  348.     ActivateGadget, AddGadget, CreateGadget, GT_SetGadgetAttrs osv        
  349.  
  350.  
  351. 8 AREXX
  352.   =====
  353.  
  354.  
  355. om chelp startas med 'chelp -i' eller 'chelp -s' så öppnas en arexxport CHELP1
  356. om det är första CHELP2 för andra osv.
  357.  
  358.  
  359. Arexx kommandon:
  360.  
  361. OPENWINDOW  - Öppnar 'intuitionfönstret'
  362.  
  363. CLOSEWINDOW - stänger fönstret.  chelp körs fortfarande och tar emot 
  364.               kommandon från arexx.
  365.  
  366. BUILD       - Skapar referensfiler. Om fönstret är stängt så öppnas det 
  367.               under build för att stängas efteråt  
  368.  
  369. LOOK xxxxx  - Söker efter keywordet xxxxx  utfil yyy:chelp.lup 
  370.               Där yyy är pathen som är inställd i 'Arexx outpath'
  371.  
  372.     ex:   Look Openwindow så sparas allt om funktionen OpenWindow i filen
  373.               yyy:chelp.lup   
  374.  
  375.     ex:   LOOK window*  
  376.  
  377. CLOOK       - Case sensitive lookup.
  378.  
  379.     ex:  CLOOK Open    will give you Open, not open.
  380.  
  381.  
  382.  
  383. VERSION     - returnerar version i result ex: 'Chelp v1.21'
  384.  
  385. GETVAR x    - returnerar för x=
  386.  
  387.              1 - Path to autodocs
  388.              2 - Path to include files
  389.              3 - Path to references files
  390.              4 - Path to arexx output
  391.              5 - Hotkey combination
  392.              6 - Hotkey combination for lookup in CED
  393.              7 - Number of keywords in autodocs
  394.              8 - Number of keywords in includefiles
  395.              9 - Search/build Autodocs (ON = 1 / OFF = 0)
  396.             10 - Search/build Includes (ON = 1 / OFF = 0)
  397.             11 - 'Typedef' (ON = 1 / OFF = 0)
  398.             12 - Build #define (ON = 1 / OFF = 0)
  399.  
  400. DEBUG ON    - Arexx debugging mode. Debugg information i fönstertitelraden
  401.  
  402. DEBUG OFF   - Stänger av debugginfon.
  403.  
  404. QUIT        - Avslutar chelp
  405.  
  406.  
  407.  
  408. 9 Kommande versioner
  409.   ==================
  410.  
  411. Intuition interface för sökning.
  412. Stöd för direktsökning från editorer: Turbotext, Lse...
  413. Stöd för C++, klasser...
  414. Dina önskemål och idéer.
  415.  
  416.  
  417.  
  418. TACK!
  419. ----
  420.  
  421.  
  422. Tack för hjälpen:
  423.  
  424.     Kjell Cederfeldt
  425.     Mikael Berglund
  426.     Kjell Harnesk
  427.  
  428.  
  429.  
  430. /Robert Wahlström och Mathias Widman
  431.