home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / editor / man / readme.os2 < prev    next >
Encoding:
Text File  |  1994-01-23  |  3.8 KB  |  104 lines
  1. This archive contains a port to OS/2 1.x--2.x of John Eaton's
  2. <jwe@che.utexas.edu> man v1.1. Roughly speaking, man is a front-end to
  3. a *roff-style program and a pager, and displays Unix-style manual
  4. pages.
  5.  
  6. Kai Uwe Rommel <rommel@ars.muc.de> did a port of man 1.0. The major
  7. visible change in 1.1 is support for compressed formatted man pages
  8. (e.g., if man finds /man/man1/ls.1, then man will attempt to
  9. create the compressed formatted man page /man/cat1/ls.1.gz).
  10.  
  11.  
  12. Installation:
  13.  
  14. 1. Copy man.exe and manpath.exe to some directory in your PATH.  Copy
  15. manpath.cfg to some directory in INIT, DPATH, or PATH. Edit this file
  16. to match your directory structure (or use the MANPATH environment
  17. variable). Enter "manpath -d" to see where man will be hunting for
  18. man pages.
  19.  
  20. 2. If you have the necessary support programs (see below), edit the
  21. .cmd and .sh files and install in some directory in your path (the 
  22. default is c:/bin). Try the makewhatis program. For example, if you 
  23. have man pages in /man/man1/, then try
  24.    makewhatis /man
  25. If successful, ask "whatis" for info on some program in /man/man1, 
  26. as in
  27.    whatis ls
  28.  
  29.  
  30. Changes from the original sources:
  31.  
  32. 1. Support for OS/2 1.x--2.x and DOS with Microsoft C, and for OS/2
  33. 2.x and DOS 32-bit with Eberhard Mattes' emx/gcc, added in new
  34. Makefile.os2.
  35.  
  36. 2. New "-N" option and NROFF environment variable to permit selecting
  37. the nroff-style program.
  38.  
  39. 3. New code selects the default nroff-style program: groff under 
  40. OS/2 2.x, and cawf under OS/2 1.x or DOS.
  41.  
  42. 4. Added gzip support.
  43.  
  44. 5. apropos.sh, makewhatis.sh, and whatis.sh have been adapted from
  45. the corresonding files.
  46.  
  47.  
  48. Cheng-Yang Tan <cytan@tristan.tn.cornell.edu> reports:
  49.  
  50.    It seems that bash requires a .sh extension in shell scripts under
  51.    OS/2. It is documented in the README file that comes with bash. Also
  52.    you will have to change the #! part, backslashes and NOT forward
  53.    slashes MUST be used.
  54.  
  55. These comments apply to the older port of bash
  56.    11-16-92  23:21     290820           0  bash.exe
  57.  
  58. To use this version of bash, change the *.cmd files to use bash, and 
  59. change the first line of the *.sh files from
  60.    #!/bin/sh
  61. to
  62.    #!\bin\bash
  63.  
  64. Unfortunately, others have reported problems with this port of bash. I
  65. have not been able to get the newer port of bash to work properly with
  66. these scripts. Information on using bash or ksh with man would be
  67. appreciated.
  68.  
  69.  
  70. Bugs:
  71.  
  72. 1. If, say, both /man/man1/ls.1 and /man/cat1/ls.1 exist, man still
  73. attempts to create /man/cat1/ls.1.gz. Workaround: do "gzip *" on
  74. all existing cat* directories.
  75.  
  76. 2. No support for compressed files on FAT drives. It may be possible 
  77. to add
  78.   {"gz", "gzip -dc -Sgz"}
  79. to the list in config.h (and then re-compile) so that man could read 
  80. compressed files of the form /man/cat1/ls.1gz (created manually).
  81.  
  82.  
  83. A number of utility programs are needed. These include gawk, sed,
  84. Stewartson's sh or bash, less, and cawf or groff, all available at
  85. ftp-os2.cdrom.com.
  86.  
  87. The file "director.c" was originally from Michael Rendell
  88. <{uunet,utai}michael@garfield>, in 1897 [sic] according to the
  89. comments.  The enclosed version has been enhanced by Ian Stewartson
  90. <istewart@datlog.co.uk>. This file and those in include/ are from
  91. Stewartson's very nice shell for OS/2 and DOS.
  92.  
  93. cawf, from Vic Abell <abe@cc.purdue.edu>, is a C version of awf, Henry
  94. Spencer's Amazingly Workable (text) Formatter. "Cawf and awf provide a
  95. usable subset of raw nroff capabilities and the styles of the man(7),
  96. me(7) and ms(7) macro sets." Version 4.07 is available from
  97. ftp-os2.cdrom.com.
  98.  
  99. Thanks to John Eaton, Michael Rendell, Ian Stewartson, Vic Abell,
  100. and Kai Uwe Rommel. Thanks to Cheng-Yang Tan for the help on bash.
  101.  
  102. --
  103. Darrel Hankerson hankedr@mail.auburn.edu
  104. 7 January 1994, scripts updated 23-Jan-94