home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume7 / man.7300 / README < prev   
Encoding:
Text File  |  1989-07-21  |  2.2 KB  |  58 lines
  1. README file for man v1.0  -- Last updated 7/12/89
  2.  
  3. The following is my interpretation of the UNIX "man" command.  Although
  4. it isn't very robust, it does handle some very useful cases which occur
  5. when trying to get stored manual pages, such as:
  6.  
  7. [from the source]
  8.  
  9.     o  You can "man" compressed manual pages 
  10.     o  You don't have to know if the manual
  11.        pages are unformatted (/usr/man/man?)
  12.        or formatted (/usr/man/cat?).
  13.     o  You don't have to know what section
  14.        the manual page is in (and it tells you
  15.        which one)
  16.     o  You get automatic paging when you
  17.        invoke man from a tty
  18.  
  19.  
  20. I didn't bother with a makefile since there is only one source file
  21. here.  It compiles by:
  22.  
  23.     $ cc -O -o man man.c -ldirent -s
  24.  
  25. Use whatever other favorite options you like.  Install it in /usr/local/bin
  26. or /usr/lbin (whichever you use on your system).  It does not require any
  27. s-bits to be set.
  28.  
  29. IMPORTANT NOTE:  As noted above, this requires that Doug Gwyn's "dirent"
  30. subroutine library be installed.  I didn't include it with this distribution!
  31. If you require it, drop me a note.  If I get enough notes, I'll repost the
  32. source.
  33.  
  34. CONFIGURATION HINTS:  In the source there are 3 "#define"s which define
  35. the pager, compressed file "cat" program, and the name of your nroff
  36. program.  These should be defined however you like them, or undefined if
  37. you don't have them.  There are two "#define"s which define where the
  38. manual pages are located -- in /usr/man/man? and /usr/man/cat? .  Set
  39. these to the way your system is configured.
  40.  
  41. One more bit of background-- as you might notice from some of the code,
  42. this program was a bit of a hack.  I was tired of not having "man" work
  43. this way, so I hacked this up quickly.  There were several individuals
  44. interested in the program, so I decided to post it.  In any event, if
  45. you think it needs more functionality or should be modified to do a
  46. particular thing differently, don't complain to me about it.  Make the
  47. change and send me the diffs so I can get some patches on the net and
  48. everyone can benefit!
  49.  
  50. Also note that the code has only been tested and used on my UNIX-pc, but
  51. it seems that it should run under almost any Unix environment.
  52.  
  53. Hope this is of use to lots of you.
  54.  
  55.  
  56. Gil Kloepfer, Jr.   ICUS Software Systems
  57. ...!icus!limbic!gil
  58.