home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / mint / mintman4.zoo / mintman / readme.txt < prev    next >
Encoding:
Text File  |  1992-12-15  |  2.7 KB  |  50 lines
  1. `man', `whatis', `apropos' and `catman' are simple-minded versions of the
  2. UN*X manual paging, manual search and manual maintenance programs.
  3. These versions were written by HPP Biersma (schuller@dutiag.tudelft.nl)
  4. and come under the GNU public license; see the file "copying" for details.
  5.  
  6. These programs were written to be used under MiNT. They have not been
  7. extensively tested under TOS. As the mintlib is used, it should work
  8. just fine under TOS; however, no guarantees are given.
  9.  
  10. To use these programs, you need an `nroff' program, the `tmac.an' macro 
  11. package for nroff, a pager like `less' or `more' and the `cat' program.
  12. Installation is easy:
  13. - Make sure `nroff' and `cat' are in the search path. For instance,
  14.   if these programs reside in /bin, make sure the environment variable
  15.   PATH includes /bin. If you can run these programs from your shell,
  16.   all should be fine.
  17. - Make sure `nroff' can find the tmac.an macro package. You may have
  18.   to set an environement variable to do this. The `nroff' I use
  19.   needs to have the searchpath set in the environment varaible TMACDIR.
  20. - Set the environment variable PAGER to the pager you want to use.
  21.   Do not forget to include parameters. The default is `less -r -e'.
  22.   Of course, your pager should be in the search path, or the name of
  23.   the pager must be set to an absolute path.
  24. - Set the environment variable MANPATH to the directories containing
  25.   manual pages. Directories must be separeted by a colon or semicolon.
  26.   The default is /usr/man.
  27. - Make sure the man?, cat? directories are properly set up.
  28.   An example: all MiNT manual pages are from section 2. So, create a directory
  29.   called `man2' within the man directory and copy all MiNT man pages there.
  30.   If you want to keep formatted versions, create the directory `cat2' too.
  31.  
  32. The (unformatted) manual files "man.1", "whatis.1", "apropos.1" and "catman.8"
  33. contain manuals for `man', `whatis', `apropos' and `catman'. Short info: `man'
  34. displays reference manual pages, `apropos' and `whatis' look up a command in
  35. the whatis database and `catman' formats manual pages and builds the whatis
  36. database.
  37.  
  38.  
  39. Notes:
  40. - man, whatis, apropos and catman were written for gcc version 2.3.1,
  41.   patchlevel 1, and the mintlib patchlevel 25. Thanks to Eric Smith
  42.   and Jhawar Bammi for gcc, mintlib and MiNT.
  43. - man, whatis, apropos and catman should work under MiNT and TOS.
  44. - source code is in the files `man.c', `whatis.c', `apropos.c' and `catman.c'.
  45. - man, whatis, apropos and catman come under the GNU public license. 
  46.   See the file "copying" for details.
  47. - bug reports, questions, comments: to schuller@dutiag.tudelft.nl
  48. - if anyone has got a good version of `more' running under MiNT
  49.   (one that doesn't drop lines), please mail me!
  50.