home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / languages / tcl / !tcldoc / !Help < prev    next >
Encoding:
Text File  |  1996-01-28  |  1.1 KB  |  30 lines
  1. TclDoc - shade demonstration program
  2.  
  3. This program displays the Tcl online documentation.
  4.  
  5. Files can be reached from the icobar menu.
  6.  
  7. The documentation is in UNIX nroff format, using the macros in the file 
  8.  
  9. <!tcldoc$Dir>.man/macros. The program understands sufficient of this format
  10. to read the files provided. It is definitely not a general purpose nroff or
  11. man reader. 
  12.  
  13. ================================================================================
  14.  
  15. The program gives a example of how to use the w_text colour and font change
  16. sequences in shade.
  17.  
  18. Notice that the command
  19.  
  20.    regsub -all {\|} $text || text 
  21.  
  22. in the "process" procedure is used to prevent "|" characters in the text from
  23. confusing these sequences.
  24.  
  25. ================================================================================
  26.  
  27. The main tcldoc program includes a file called "index". This defines the 
  28. menu structure. This is created automatically by the program "makeindex"
  29. to reflect the contents of the files in the "doc" subdirectory. If you add
  30. to or rearrange these files you should run makeindex to update the index.