home *** CD-ROM | disk | FTP | other *** search
/ Complete Linux / Complete Linux.iso / docs / devel / tcl / tclx7_31.z / tclx7_31 / tcldev / tclX7.3a-p1 / tclhelp / help next >
Encoding:
Text File  |  1994-01-25  |  2.8 KB  |  67 lines
  1.        The  help  facility allows one to look up help pages which
  2.        where extracted from the standard Tcl manual pages and Tcl
  3.        scripts  during  Tcl  installation.  Help files are struc-
  4.        tured as a multilevel tree of  subjects  and  help  pages.
  5.        Help  files  are found by searching directories named help
  6.        in the directories listed in the auto_path variable.   All
  7.        of  the  files in the list of help directories form a vir-
  8.        tual root of the help tree.  This method  allows  multiple
  9.        applications  to  provide  help  trees  without having the
  10.        files reside in the same directory.
  11.  
  12.        The help facility can be accessed in two ways, as interac-
  13.        tive  commands in the Extended Tcl shell or as an interac-
  14.        tive Tk-based program (if you have built Extended Tcl with
  15.        Tk).
  16.  
  17.        To run the Tk-based interactive help program:
  18.  
  19.            tclhelp ?addpaths?
  20.        Where  addpaths  are  additional  paths to search for help
  21.        directories.  By  default,  only  the  auto_path  used  by
  22.        tclhelp  is  search.   This  will  result  in help on Tcl,
  23.        Extended Tcl and Tk.
  24.  
  25.        The following interactive Tcl  commands  and  options  are
  26.        provided with the help package:
  27.  
  28.        help
  29.               Help, without arguments, lists of all the help sub-
  30.               jects and pages under the current help subject.
  31.  
  32.        help subject
  33.               Displays all of help pages and lower level subjects
  34.               (if any exist) under the subject subject.
  35.  
  36.        help subject/helppage
  37.               Display  the  specified help page.  The help output
  38.               is passed through a simple pager if output  exceeds
  39.               23  lines,  pausing  waiting  for  a  return  to be
  40.               entered.  If any other character  is  entered,  the
  41.               output is terminated.
  42.  
  43.        helpcd ?subject?
  44.               Change  the current subject, which is much like the
  45.               Unix current directory.  If subject is  not  speci-
  46.               fied,  return  to  the  top-level of the help tree.
  47.               Help subject path names  may  also  include  ``..''
  48.               elements.
  49.  
  50.        helppwd
  51.               Displays the current help subject.
  52.  
  53.        help help | ?
  54.               Displays help on the help facility at any directory
  55.               level.
  56.  
  57.        apropos pattern
  58.               This command locates subjects  by  searching  their
  59.               one-line  descriptions  for  a pattern.  Apropos is
  60.               useful when you can remember part of  the  name  or
  61.               description  of  a  command,  and  want  to  search
  62.               through the one-line summaries for matching  lines.
  63.               Full  regular expressions may be specified (see the
  64.               regexp command).
  65.  
  66.               These procedures are provided by Extended Tcl.
  67.