home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume6 / help / part1 / README < prev   
Encoding:
Text File  |  1986-11-30  |  1.4 KB  |  44 lines
  1.  
  2.  Help is a facility for climbing a tree structure.
  3.  
  4.  Help comes in two types: a help topic with subtopics, or a help topic
  5.  without any subtopics.  
  6.  
  7.     Topics that have no subtopics reside in the directory they are
  8.     a subtopic of, with filenames `topicname.HLP'
  9.  
  10.     Topics that have subtopics of their own reside in directories
  11.     which are subdirectories of the help topic of which they are
  12.     subtopics, and have filenames `.HLP'  Thier subtopics have the
  13.     filenames `topicname.HLP'.  A directory for a subtopic just
  14.     has the subtopic's name as its directory name.
  15.  
  16.     For instance, if you had a help topic "ls" with some subtopics,
  17.     /usr/help/ls would be a directory, containing the files
  18.  
  19.         /usr/help/ls/.HLP    main help text
  20.         /usr/help/ls/.MANUAL    shell script for accessing man page
  21.         /usr/help/ls/options.HLP    help for ls options
  22.         /usr/help/ls/output.HLP        help for ls output format
  23.  
  24.     If you had a simple help for the who command, "who", it would comprise
  25.     the following files at the top level:
  26.  
  27.         /usr/help/who.HLP    help text for who(1)
  28.         /usr/help/who.MANUAL    script for accessing who(1) man page
  29.  
  30. To make help, cd to the directory, and type: 
  31.  
  32.     % make help
  33.  
  34. or
  35.  
  36.     % make install
  37.  
  38. if you are ambitious.  The source for help is one C module, help.c, with a 
  39. header file, help.h.
  40.  
  41. Help uses the more(1) program to read help texts.  Make sure that more
  42. resides on the path specified by the VIEWPROGRAM defined symbol in help.h.
  43.  
  44.