home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / languages / c / helpgen / _help next >
Encoding:
Text File  |  1993-02-07  |  1.9 KB  |  72 lines
  1. CHelpGen
  2.  
  3. version 1.00                                               last update 07/04/93
  4.  
  5. (C)1993 Jason O'Broin
  6.  
  7.  
  8. This program lets you create !SrcEdit compatable help files from the Desktop C
  9. Risc_Oslib header files.
  10.  
  11. Currently, !SrcEdit only comes with the header files for the Shared C library
  12. headers. This is useful, but it annoying that the Risc_Oslib files aren't
  13. also provided. 
  14.  
  15. However, Desktop C release comes with the header files for Risc_Oslib, fully
  16. commented (equivalent to the printed manual). This program produces a help file
  17. from these headers.
  18.  
  19. Usage:
  20.  
  21.  * Ensure that C$Path is set as it uses this path to find the header files
  22.    (typically = $.DDE.Libraries.Clib.,$.DDE.Libraries.Risc_Oslib.)
  23.    So, search path is C:^.risc_oslib.h
  24.  
  25.  * Ensure that !SrcEdit has been 'seen', so that it's path is known.
  26.    CHelpGen places the resulting help file in !SrcEdit.help.chelp
  27.  
  28.  * Run CHelpGen
  29.  
  30.  * CHelpGen displays a list of header files and prototypes found whilst running
  31.  
  32.  * Goto !SrcEdit.help.clib and combine the old 'C' help file with the new
  33.    'helptext' file, and resave as 'C'
  34.  
  35.  * See if it works!!
  36.  
  37.  
  38. Final comments : This program is *extremely* 'quick and dirty', and I knocked
  39.                  it up last night in a fit of insomnia. However, it does the
  40.                  job. I disown the programming style completely :-)
  41.  
  42.  
  43. Update Information
  44.  
  45.  
  46. version 1.00
  47. ------------
  48.  
  49. * Release version
  50.  
  51.  
  52. Known bugs : None             
  53.  
  54.  
  55. Any problems/improvements etc. contact :
  56.  
  57.                         Jason O'Broin
  58.                         31 High Street
  59.                         Brampton
  60.                         Cambs
  61.                         PE18 8TG
  62.  
  63.                         (0480) 453376
  64.  
  65. or email to :
  66.  
  67.                         J.P.OBroin@uk.ac.newcastle
  68.                     OR  job@uk.ac.dur.johnson
  69.  
  70.  
  71.                                                     Jason O'Broin, 07/02/93
  72.