home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / editor / pminfo / readme < prev    next >
Text File  |  1994-01-31  |  4KB  |  96 lines
  1.  
  2. This file describes release 1.0 of PMINFO
  3.  
  4. **** What is PMINFO? ****
  5.  
  6. PMINFO is a program for reading GNU "info" files.
  7.  
  8. Info is a hypertext manual format that is difficult to read with a plain
  9. text editor.
  10.  
  11. The GNU project creates manuals in a format called texinfo.  Either
  12. the makeinfo program or the GNU-Emacs editor can be used to create an
  13. info manual out of the texinfo source code.  The TeX program can be
  14. used to create a hardcopy manual out of the texinfo source code.
  15.  
  16. Both Emacs and the info program can be used to view info files.
  17. My copy of info no longer seems to work under OS/2 2.0.  Emacs
  18. does work.
  19.  
  20. The PMINFO program is designed to be a small, efficient means of reading
  21. info files.   Users of gcc who have not downloaded a copy of Emacs,
  22. will hopefully benefit from this program.
  23.  
  24.  
  25. **** How to use PMINFO ****
  26.  
  27. Start PMINFO in a directory containing your info manuals.
  28. There must be an info file called "dir" in this directory.
  29.  
  30. Each page of an info file is referred to as a node.  When you start
  31. up pminfo, it will default to view the "Top" node of the dir file.
  32. [Top nodes in an info file usually denote the starting node in a file]
  33.  
  34. Some nodes, including the top node of the dir file, will contain a 
  35. "menu" of other nodes you may view.  This "menu" does not appear in
  36. the menu bar!  Somewhere in the node, there will be a line that
  37. starts with "* Menu:".  Following this line will be several cross-references
  38. to other nodes such as "* GCC: (gcc.info)" or somesuch.  Click on the cross-
  39. reference line to see info about the reference.
  40.  
  41. You can return to the directory node at any time by selecting Node/Directory.
  42. You can go back to the most recently viewed node by selecting Node/Last Node.
  43.  
  44. Be aware that some info files can span multiple files.  For example,
  45. the Gcc info manual is composed of a file "gcc.info" and several
  46. files called "gcc.info-nn" where nn is some number.  You need *all*
  47. of these files in order to read the gcc manual. I will be providing 
  48. an info-format manual for users of gcc2.1 that will be in this format.
  49.  
  50. As of today, the Emacs for OS/2 that is availible contains a directory
  51. emacs/info which is an excellent place to run pminfo from if you want info
  52. about emacs and gcc.
  53.  
  54. **** About this release ****
  55.  
  56. This release is in *many* ways premature.  These is no end to the new
  57. and exciting ways you can get this program to crash!   Just kill it off
  58. and don't do whatever you did again :-).
  59.  
  60. I promise this will get better.  But since many people have asked for
  61. a way to view the gcc manual, and this release is now stable enough for
  62. use, I will release it now.  I apologize in advance for the frustration
  63. this may cause.
  64.  
  65. WARNING:  Due to the defectiveness of IBM I do not have a version
  66. of OS/2 2.0 GA to test this program on.  But it works great on
  67. my beta 6.177.  Of course, my 30 day license for the beta has expired
  68. so technically I can't even run OS/2 2.0, never mind test this software
  69. on it.
  70.  
  71.  
  72. **** Future directions ****
  73.  
  74. Expect another release of this software within a month.
  75.  
  76. Desired features (not in order)
  77. 1. The ability to select a different font.
  78. 2. The ability to copy text from the manual to the clipboard.
  79. 3. Multiple windows (when desired)
  80. 4. Load a file other than "dir" as default on the fly
  81. 5. Real error messages
  82. 6. Keyboard interface
  83. 7. Allow following cross-references, not just menu items
  84.  
  85. **** About the Programmer ****
  86.  
  87. The programmer of pminfo is Colin Jensen.  I can be reached
  88. though Email as cjensen@ampex.com or ljensen@netcom.netcom.com
  89. As a last resort, try USMAIL at: 4902 Esguerra Terrace, 
  90. Fremont CA, 94555.
  91.  
  92. I will try to help out anyone who needs help with this program, but
  93. no promises.  I would also be *delighted* to hear from happy users.
  94. If you like this program, please let me know.  It will encourage me
  95. to write more useful programs again in the future.
  96.