home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / c / ch134_e.lha / CHELP_SW.DOC < prev    next >
Text File  |  1992-09-17  |  14KB  |  427 lines
  1. ****************************************************************************
  2. *                                                                          *
  3. * Chelp V1.31 by Robert Wahlström, Mathias Widman         92-Sept-17       *
  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-Sep-17)   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.     
  100. I fältet Path to .doc ange pathen till var dina autodocsfiler finns. Om
  101. fältet är skuggat tryck på rutan efter fältet. Om du ej har autodocs-
  102. filer låt skuggningen vara kvar, eftersom programmet då slipper söka
  103. efter dessa.
  104.  
  105. ex work:lc/autodocs
  106.  
  107. I fältet Path to .h ange pathen till dina includefiler. Samma saker 
  108. enligt ovan angående skuggning av fältet.
  109.  
  110. ex work:lc/compiler_headers
  111.  
  112. OBS!! Du måste ange pathen till de icke kompakterade includefilerna,
  113. inte till de kompakterade som man normalt har i INCLUDE: 
  114.  
  115.  
  116. I fältet Path to .ref anger du var referensfilerna som byggs upp av chelp
  117. ska lagras. Ex RAM: eller s:. Använder du RAM: måste du skapa om
  118. referensfilerna efter varje ombootning. 
  119.  
  120. Tryck på SAVE.
  121.  
  122.  
  123. För att skapa referensfilerna som chelp behöver, skriv Chelp -b från CLI
  124. eller tryck på BUILD-gadgeten om du har startat chelp från Workbench 
  125. eller med Chelp -i. Detta tar några minuter.
  126.  
  127.  
  128.  
  129. 4 Starta från CLI
  130.   ===============
  131.  
  132. Från CLI skriver du: Chelp [Flag] [Keyword] [Subheader]
  133.  
  134. Chelp -b/B          - Bygger referensfiler. Du måste göra detta om du
  135.                     ändrar pathen till include/autodocs, eller får nya
  136.                     include/referensfiler. Vi rekommenderar att du kör
  137.                     Chelp -b varje gång du får en ny version av Chelp.
  138.  
  139. Chelp -l <keyword>  - Listar alla funktioner/strukturer som börjar på
  140.                     keyword.
  141.  
  142.  
  143. Chelp [keyword] [subheader]
  144.  
  145.                     - Listar alla funktioner/strukturer/definitioner som
  146.                     matchar [keyword].
  147.  
  148.               ex:   Chelp addappicon - ger dig information om funktionen
  149.                     AddAppIcon
  150.  
  151.               ex:   Chelp window - ger dig info om structuren Window
  152.  
  153.               ex:   Chelp GA_ToggleSelect     
  154.  
  155.                     Om keyword slutar på * eller + så får man alla
  156.                     funk/strukt som börjar på keyword Se wildcards för
  157.                     mer information.
  158.  
  159.               ex:   chelp exec - visar hela exec.h includefilen
  160.  
  161.               ex:   Chelp create* - ger dig info om alla funk/strukt som
  162.                     börjar på create 
  163.  
  164.                     Om 'subheader' finns visas bara de stycken som har
  165.                     rubriken subheader.
  166.  
  167.               ex:   Chelp addappicon name - ger texten som finns i stycket
  168.                     NAME
  169.  
  170.                     NAME                                                                       
  171.                         AddAppIcon - add an icon to workbench's list of 
  172.                         appicons.
  173.  
  174.               ex:   Chelp Create* synopsis - ger dig inforamation om allt som
  175.                     finns under stycket synopsis i alla funktioner som
  176.                     börjar på create.   
  177.  
  178. Chelp -c [keyword]  Samma som CHelp [keyword] förutom att små och stora
  179.                     bokstäver inte är samma.
  180.  
  181.               ex:   Chelp -c Open - hittar Open men inte open
  182.         
  183.               ex:   Chelp -c open* - hittar alla som börjar på open, men inte
  184.                     de som börjar på Open 
  185.  
  186. Chelp -d [keyword] [subheader]
  187.  
  188.                     Söker enbart i autodocs
  189.  
  190. Chelp -h [keyword]  Söker enbart i includefilerna.
  191.  
  192. Chelp -i            Se Intuition interface.
  193.  
  194. Chelp -s            Startar igång chelp i bakgrunden. Chelp tar emot arexx-
  195.                     kommandon och man kan hotkeya fram intuitionfönstret
  196.                     (samma som man får genom chelp -i) 
  197.  
  198.  
  199. 5 Starta från Workbench
  200.   =====================
  201.  
  202.   Chelp startas från Workbench genam att man dubbelklickar på chelps ikon.
  203.   Om HIDE i tooltype inte är YES så kommer ett fönster upp (ntuition
  204.   interfacet)
  205.   Om HIDE i toolstypes är YES så kommer inget fönster upp utan chelp körs i
  206.   bakgrunden och väntar på att hotkeyas fram eller ta emot kommandon via
  207.   arexx. 
  208.  
  209.   TOOLTYPES:
  210.   Genom att klicka på chelps ikon en gång så den blir markerad och sedan
  211.   välja 'Information' från workbenchmenyn så kan man ändra de verktygs-
  212.   typer (tooltypes) som chelp använder. 
  213.  
  214.   TOOLTYPES som chelp känner till:
  215.  
  216.     HIDE:
  217.   
  218.         Om HIDE=YES så öppnas inte chelps fönster när man startar chelp
  219.         utan chelp kommer att köras i bakgrunden.
  220.         
  221.         Om HIDE=NO eller inte finns så kommer chelps fönster upp vid start.
  222.  
  223.     HOTKEY:
  224.  
  225.         Om hotkey ej finns så väljs den som som är sparad i konfigurationen.
  226.  
  227.         Om hotkey finns så startas chelp med den valda hotkeykombinationen
  228.         OBS! Den hotkeykombinationen som är sparad i konfigurationen kommer
  229.         att ersättas med denna. 
  230.  
  231.     DONOTWAIT:
  232.  
  233.         Om Chelp skall startas från WbStartup bilioteket så måste denna
  234.         vara med.
  235.  
  236.  
  237.  
  238. 6 INTUITION INTERFACE
  239.   ===================
  240.  
  241. Om du startar Chelp med 'chelp -i' eller från Workbench genom att dubbel-
  242. klicka på Chelp-ikonen öppnas ett intuitionfönster. I fönstret finns det 
  243. tre gadgets BUILD, HIDE och QUIT. 
  244.  
  245. 6.1 Build
  246.  
  247.     Bygger referensfiler för Chelp. Detta bör göras varje gång pathen
  248.     till include/autodocs ändras eller om nya include/referencefiler har
  249.     installerats. Om man vill avbryta, tryck på build en gång till.
  250.     
  251. 6.2 HIDE
  252.  
  253.     Stänger Chelps intuition fönster. Chelp körs fortfarande och tar emot 
  254.     kommandon via arexx. Fönstret kan öppnas igen via hotkeys
  255.     (shift+ctrl+c) eller det man har skrivit in i rutan efter hotkey.
  256.  
  257. 6.3 Quit
  258.  
  259.     Avslutar Chelp.  
  260.  
  261.  
  262. 6.4 Preferences
  263.  
  264.     I den nedre halvan av intuitionfönstret finns det Gadgets för inställning
  265.     av programmet.
  266.  
  267.     I mitten av fönstret finns det 5 textfält. 
  268.  
  269.     I det första 'Path to .doc' anges pathen till var autodocsfilerna
  270.     finns. Om dessa ej finns eller ej önskas, tryck på checkboxgadgeten till
  271.     höger om fältet så att fältet blir 'skuggat'.
  272.  
  273.     ex work:lc/autodocs_2.04/
  274.  
  275.     'Path to .h': Ange här pathen till dina ICKE kompakterade includefiler. 
  276.     Om du anger pathen till de kompakterade includefilerna som normalt
  277.     finns i INCLUDE: så kommer chelp inte att hitta några strukturer.
  278.     
  279.     ex work:lc/compiler_headers/
  280.  
  281.     I fältet Path to .ref anges var referensfilerna som byggs upp av chelp
  282.     ska lagras. Ex RAM: eller s:. Använder du RAM: måste du skapa om
  283.     referensfilerna efter varje ombootning. 
  284.  
  285.     I fältet 'Arexx outpath:' anges path till den filen som skapas genom 
  286.     lookup via arexx. Filen kommer heta chelp.lup.
  287.  
  288.     ex ram:
  289.  
  290.     I fältet 'Hotkey' anges vilken tangentkombination som skall användas
  291.     för att öppna chelp's fönster om chelp körs dolt i bakgrunden.
  292.     
  293.     ex 'shift ctrl c'  
  294.     
  295.     Build Define: Med hjälp av denna gadgeten bestämmer man om man vill skapa
  296.     referensfiler för #define vid build. Om man ej har 'build define' på så 
  297.     kan man inte söka efer defines, men referensfilerna blir mycket kortare om
  298.     man har platsbrist.
  299.     
  300.     Checkboxgadgeten TYPEDEF:
  301.  
  302.     Med hjälp av denna gadgeten kan man välja om man vill ha med typedef
  303.     från includefilerna. 
  304.  
  305.     ex: chelp printf   med TYPEDEF på ger
  306.  
  307.        Function: printf   Includefile: stdio.h
  308.  
  309.        (int) printf(char*,...)
  310.  
  311.     
  312.     SAVE   - spara alla ändringar i konfigurationsfilen. Även fönster-
  313.              positionerna för intution-, preferences-fönstret sparas.
  314.  
  315.     UNDO   - Laddar in de senaste sparade inställningarna.
  316.  
  317.  
  318.     Om chelp.cfg finns i det lokala biblioteket används den istället
  319.     för s:chelp.cfg.
  320.  
  321.  
  322.  
  323.  
  324. 7 WILDCARDS
  325.   =========
  326.  
  327. Keyword kan anges med Wildcard. Wildcard betyder vilda kort och fungerar
  328. som ersättningstecken, (vad som helst tecken). Ex: Anges #?window så
  329. betyder det att allt som slutar på window är överensstämmande med sök-
  330. strängen. #?window är lika med openwindow och closewindow osv.
  331.  
  332. Vad betyder då alla wildcard tecken?:
  333.  
  334. ?  = Ett valfritt tecken 
  335. ?? = Två valfria tecken.
  336. #? = Vad som helst (flera tecken)
  337. |  = Eller i kombination med paranteser
  338. (  = Start av wildcards jämförelselista 
  339. )  = Slut på wildcards jämförelselista 
  340. *  = Samma som #? 
  341. +  = Samma som #?
  342.  
  343. Ex: #?gadget#? ger alla keywords som har gadget i namnet, tex: 
  344.     ActivateGadget, AddGadget, CreateGadget, GT_SetGadgetAttrs osv        
  345.  
  346.  
  347. 8 AREXX
  348.   =====
  349.  
  350.  
  351. om chelp startas med 'chelp -i' eller 'chelp -s' så öppnas en arexxport CHELP1
  352. om det är första CHELP2 för andra osv.
  353.  
  354.  
  355. Arexx kommandon:
  356.  
  357. OPENWINDOW  - Öppnar 'intuitionfönstret'
  358.  
  359. CLOSEWINDOW - stänger fönstret.  chelp körs fortfarande och tar emot 
  360.               kommandon från arexx.
  361.  
  362. BUILD       - Skapar referensfiler. Om fönstret är stängt så öppnas det 
  363.               under build för att stängas efteråt  
  364.  
  365. LOOK xxxxx  - Söker efter keywordet xxxxx  utfil yyy:chelp.lup 
  366.               Där yyy är pathen som är inställd i 'Arexx outpath'
  367.  
  368.     ex:   Look Openwindow så sparas allt om funktionen OpenWindow i filen
  369.               yyy:chelp.lup   
  370.  
  371.     ex:   LOOK window*  
  372.  
  373. CLOOK       - Case sensitive lookup.
  374.  
  375.     ex:  CLOOK Open    will give you Open, not open.
  376.  
  377.  
  378.  
  379. VERSION     - returnerar version i result ex: 'Chelp v1.21'
  380.  
  381. GETVAR x    - returnerar för x=
  382.  
  383.              1 - Path to autodocs
  384.              2 - Path to include files
  385.              3 - Path to references files
  386.              4 - Path to arexx output
  387.              5 - Hotkey combination
  388.              6 - Hotkey combination for lookup in CED
  389.              7 - Number of keywords in autodocs
  390.              8 - Number of keywords in includefiles
  391.              9 - Search/build Autodocs (ON = 1 / OFF = 0)
  392.             10 - Search/build Includes (ON = 1 / OFF = 0)
  393.             11 - 'Typedef' (ON = 1 / OFF = 0)
  394.             12 - Build #define (ON = 1 / OFF = 0)
  395.  
  396. DEBUG ON    - Arexx debugging mode. Debugg information i fönstertitelraden
  397.  
  398. DEBUG OFF   - Stänger av debugginfon.
  399.  
  400. QUIT        - Avslutar chelp
  401.  
  402.  
  403.  
  404. 9 Kommande versioner
  405.   ==================
  406.  
  407. Intuition interface för sökning.
  408. Stöd för direktsökning från editorer: Turbotext, Lse...
  409. Stöd för C++, klasser...
  410. Dina önskemål och idéer.
  411.  
  412.  
  413.  
  414. TACK!
  415. ----
  416.  
  417.  
  418. Tack för hjälpen:
  419.  
  420.     Kjell Cederfeldt
  421.     Mikael Berglund
  422.     Kjell Harnesk
  423.  
  424.  
  425.  
  426. /Robert Wahlström och Mathias Widman
  427.