1mNAME0m
       tclsh - Simple shell containing Tcl interpreter

1mSYNOPSIS0m
       1mtclsh 22m?4mfileName24m 4marg24m 4marg24m 4m...24m?


1mDESCRIPTION0m
       1mTclsh  22mis  a  shell-like  application  that reads Tcl commands from its
       standard input or from a file and evaluates them.  If invoked  with  no
       arguments  then  it runs interactively, reading Tcl commands from stan-
       dard input and printing command results and error messages to  standard
       output.   It runs until the 1mexit 22mcommand is invoked or until it reaches
       end-of-file on its standard input.  If there exists a file 1m.tclshrc 22m(or
       1mtclshrc.tcl  22mon  the  Windows  platforms)  in the home directory of the
       user, 1mtclsh 22mevaluates the file as a Tcl script just before reading  the
       first command from standard input.


1mSCRIPT FILES0m
       If  1mtclsh 22mis invoked with arguments then the first argument is the name
       of a script file and any additional arguments are made available to the
       script  as  variables  (see  below).   Instead of reading commands from
       standard input 1mtclsh 22mwill read Tcl commands from the named file;  1mtclsh0m
       will exit when it reaches the end of the file.  The end of the file may
       be marked either by the physical end of the medium, or by  the  charac-
       ter, '\032' ('\u001a', control-Z).  If this character is present in the
       file, the 1mtclsh 22mapplication will read text up to but not including  the
       character.  An application that requires this character in the file may
       safely encode it as ``\032'', ``\x1a'', or ``\u001a''; or may  generate
       it  by use of commands such as 1mformat 22mor 1mbinary22m.  There is no automatic
       evaluation of 1m.tclshrc 22mwhen the name of a script file is  presented  on
       the  1mtclsh  22mcommand  line,  but the script file can always 1msource 22mit if
       desired.

       If you create a Tcl script in a file whose first line is
              1m#!/usr/local/bin/tclsh0m
       then you can invoke the script file directly from  your  shell  if  you
       mark  the  file  as  executable.   This  assumes  that  1mtclsh  22mhas been
       installed in the default location in /usr/local/bin;  if it's installed
       somewhere  else  then  you'll  have  to modify the above line to match.
       Many UNIX systems do not allow the 1m#! 22mline to exceed about  30  charac-
       ters  in  length,  so be sure that the 1mtclsh 22mexecutable can be accessed
       with a short file name.

       An even better approach is to start your script files with the  follow-
       ing three lines:
              1m#!/bin/sh0m
              1m# the next line restarts using tclsh \0m
              1mexec tclsh "$0" "$@"0m
       This  approach  has  three advantages over the approach in the previous
       paragraph.  First, the location of the 1mtclsh 22mbinary doesn't have to  be
       hard-wired  into  the  script:  it can be anywhere in your shell search
       path.  Second, it gets around the 30-character file name limit  in  the
       previous  approach.   Third,  this  approach will work even if 1mtclsh 22mis
       itself a shell script (this is done on some systems in order to  handle
       multiple  architectures or operating systems:  the 1mtclsh 22mscript selects
       one of several binaries to run).  The three lines  cause  both  1msh  22mand
       1mtclsh  22mto  process the script, but the 1mexec 22mis only executed by 1msh22m.  1msh0m
       processes the script first;  it treats the second line as a comment and
       executes  the  third  line.  The 1mexec 22mstatement cause the shell to stop
       processing and instead to  start  up  1mtclsh  22mto  reprocess  the  entire
       script.   When  1mtclsh 22mstarts up, it treats all three lines as comments,
       since the backslash at the end of the second line causes the third line
       to be treated as part of the comment on the second line.

       You  should  note that it is also common practise to install tclsh with
       its version number as part of the name.   This  has  the  advantage  of
       allowing  multiple versions of Tcl to exist on the same system at once,
       but also the disadvantage of making it harder  to  write  scripts  that
       start up uniformly across different versions of Tcl.


1mVARIABLES0m
       1mTclsh 22msets the following Tcl variables:

       1margc           22mContains  a  count  of the number of 4marg24m arguments (0 if
                      none), not including the name of the script file.

       1margv           22mContains a Tcl list whose elements  are  the  4marg24m  argu-
                      ments,  in order, or an empty string if there are no 4marg0m
                      arguments.

       1margv0          22mContains 4mfileName24m if it was specified.  Otherwise,  con-
                      tains the name by which 1mtclsh 22mwas invoked.

       1mtcl_interactive0m
                      Contains  1  if 1mtclsh 22mis running interactively (no 4mfile-0m
                      4mName24m was specified and standard input is a terminal-like
                      device), 0 otherwise.


1mPROMPTS0m
       When  1mtclsh  22mis invoked interactively it normally prompts for each com-
       mand with ``1m% 22m''.  You can change the prompt by setting  the  variables
       1mtcl_prompt1  22mand  1mtcl_prompt222m.   If variable 1mtcl_prompt1 22mexists then it
       must consist of a Tcl script to output a prompt;  instead of outputting
       a  prompt  1mtclsh 22mwill evaluate the script in 1mtcl_prompt122m.  The variable
       1mtcl_prompt2 22mis used in a similar way when a newline is  typed  but  the
       current  command  isn't  yet complete; if 1mtcl_prompt2 22misn't set then no
       prompt is output for incomplete commands.


1mSTANDARD CHANNELS0m
       See 1mTcl_StandardChannels 22mfor more explanations.


1mSEE ALSO0m
       fconfigure(n), tclvars(n)


1mKEYWORDS0m
