home *** CD-ROM | disk | FTP | other *** search
/ norge.freeshell.org (192.94.73.8) / 192.94.73.8.tar / 192.94.73.8 / pub / computers / pdp10 / tops-10 / hlpsqz.hlp < prev    next >
Text File  |  1995-04-05  |  5KB  |  103 lines
  1.                             HELP for HLPSQZ
  2.  
  3.      HLPSQZ is  a  program  to  maintain  a  collection  of  small  HELP
  4. messages.   These messages are ADDed into a file called HLP:HELP.SQZ and
  5. an index entry for each  message  is  recorded  in  HLP:HELP.INX.   This
  6. allows many small HELP messages to occupy a small space on the disk.  To
  7. add a help message to HELP.SQZ  ,first  create  a  file  containing  the
  8. message.  The file name should correspond to the help topic name.  Then,
  9. run HLPSQZ to add this file  to  HELP.SQZ  as  explained  for  the  /ADD
  10. command.   If  you  want  your little file deleted after it is copied to
  11. HELP.SQZ, you should use the /PURGE switch after the file name.  In  the
  12. following  list,  "filename" stands for a full file specification, which
  13. can usually contain standard DEC wildcards.  "topicname"  stands  for  a
  14. single name which can also usually contain wildcards.
  15.  
  16.      A list of commands and switches for HLPSQZ follows.
  17.  
  18. /ADD filename           Adds index entry for a topic to
  19.                         HELP.INX. Also sets a flag to copy
  20.                         the file called "filename" into
  21.                         HELP.SQZ when you exit by typing
  22.                         /QUIT
  23.  
  24. /ALIAS:topicname        Use is "ADD topic1/ALIAS:topic2".
  25.                         This will add "topic1" to the
  26.                         index, but will give user help for
  27.                         "topic2" when he asks for "topic1".
  28.                         e.g. "ADD ME/ALIAS:HELP" will add
  29.                         "ME" to the index.  When a user
  30.                         types "HELP ME", he will get help
  31.                         for HELP instead.
  32.  
  33. /DDT                    If DDT is loaded, this command runs
  34.                         it.
  35.  
  36. /DECIDE                 Switch which says you want to
  37.                         decide about each file in a wild
  38.                         card operation.  This switch may
  39.                         appear after a file spec, in which
  40.                         case it has a local effect, or it
  41.                         may appear alone on a command line,
  42.                         in which case it remains in effect
  43.                         until turned off by /NODECIDE
  44.  
  45. /DELETE topicname       Deletes topic from index and makes
  46.                         free space available in HELP.SQZ
  47.  
  48. /DIRECT topicname       Types a list of topics in the index
  49.                         which match "topicname".
  50.  
  51. /EXTRACT filename=      Copies a message called "topicname"
  52.         topicname       out of HELP.SQZ into file called
  53.                         "filename".
  54.  
  55. /FAST                   Indicates that directory listing
  56.                         should only contain topic names.
  57.  
  58. /FREE                   Types a list of free blocks in
  59.                         HELP.SQZ
  60.  
  61. /PURGE                  Flag to delete the little help file
  62.                         after it is copied to HELP.SQZ.
  63.                         This switch will apply to all files
  64.                         if it is typed alone on a command
  65.                         line  Turned off by /NOPURGE
  66.  
  67. /QUIT                   Terminates session and does all
  68.                         real copying of files into
  69.                         HELP.SQZ.  If you want to abort
  70.                         without making any changes, use ^C.
  71.  
  72. /ROUTINE                Flag that says to add topic name to
  73.                         index without copying anything into
  74.                         HELP.SQZ.  Used to give name of an
  75.                         internal subroutine for HELP to
  76.                         run.  (e.g.  HELP COMMAND)
  77.  
  78. /SQUEEZE                Rewrite entire HELP.SQZ eliminating
  79.                         any free space.  Used to compress
  80.                         HELP.SQZ if there are a lot of
  81.                         scattered free blocks.
  82.  
  83. /SUPERSEDE:ASK          Ask about superseding any existing topic.
  84.           :ALWAYS       Always supersede existing topic.
  85.           :OLDER        Supersede older topic with newer one.
  86.           :NEVER        Never supersede existing topic.
  87.  
  88. /TYPE topicname         If message is part of HELP.SQZ, type it out.
  89.  
  90. /WHAT                   Types out current status of HLPSQZ
  91.  
  92. /WIDTH:n                Causes directory listing to be
  93.                         typed with given page width.  If n
  94.                         is omitted, the default width for
  95.                         your terminal is used.
  96.  
  97. /WRITE                  Causes an immediate copying of all
  98.                         topics that have been ADDed into
  99.                         HELP.SQZ
  100.  
  101. .KJOB
  102. .
  103.