QTCSH(1)                   Grid Engine User Commands                  QTCSH(1)



[1mNAME[0m
       qtcsh - tcsh v6.09 with transparent remote execution by use of qrsh.

[1mSYNTAX[0m
       [1mqtcsh [22m[ [1mtcsh options [22m| [1m-ABLR [22m]

[1mDESCRIPTION[0m
       [4mQtcsh[24m  is an extension to the popular [4mcsh[24m(1) derivative [4mtcsh[24m. It allows
       the transparent remote execution commands entered in  [4mqtcsh[24m  controlled
       via  Grid Engine.  [4mQtcsh[24m can be used as interactive command interpreter
       as well as for the processing of [4mtcsh[24m shell scripts.

       When invoked, [4mqtcsh[24m identifies which commands are to  be  run  remotely
       and  which  are  not.  For this purpose the files <ge_root>/<cell>/com-
       mon/qtask and ~/.qtask are processed. Each line in these files  defines
       a command that is intended to be run remotely (see [4mqtask[24m(5) for a defi-
       nition of the file format). The .qtask file in the user's  home  direc-
       tory  contains  the user's remote task specification, while the file in
       the common directory is maintained by the administrator and  defines  a
       cluster-wide  default behavior.  The contents of the administrator sup-
       plied [4mqtask[24m(5) file are completely  overridden  in  case  there  is  an
       appropriate  entry  in  the  users [4mqtask[24m(5) file.  This is prevented in
       case an exclamation mark is prefixed to the command name in the  admin-
       istrators qtask file.

       [4mQtcsh[24m  always  attempts  to  start  the  designated  tasks remotely via
       [4mqrsh[24m(1).  Exceptions are

       +o  if the user enters such commands via a relative or absolute pathname
          instead  of  the  stand-alone  command  name  (see [4mqtask[24m(5) for more
          information).

       +o  if the environment variable JOB_ID is set  and  thus  [4mqtcsh[24m  assumes
          that execution already happens remotely within a Grid Engine job and
          thus executes tasks locally. This avoids unwanted recursions but can
          be overridden by the command-line option [1m-R [22mand the built-in command
          [4mqrshmode[24m [4m-R[24m (see corresponding descriptions below).

       +o  if [4mqtcsh[24m cannot establish a connection of Grid Engine during  start-
          up.  This  allows  to use [4mqtcsh[24m as login shell without the danger of
          being blocked when no Grid Engine service is available.

       [4mQtcsh[24m can operate in three different modes determining whether

       +o  tasks are executed remotely.

       +o  immediate or batch execution is requested.

       +o  status output is verbose or only in case of any errors.

       These modes either can  be  controlled  by  the  command-line  switches
       described  below  during  [4mqtcsh[24m invocation or within an executing [4mqtcsh[0m
       via the built-in command [4mqrshmode[24m as described in section [1mBUILT-IN COM-[0m
       [1mMANDS[22m.

[1mOPTIONS[0m
       The  options  enlisted below are special to [4mqtcsh[24m. The user is referred
       to the [4mtcsh[24m(1) documentation for the explanation of further options.


       [1m-A     [22mSwitches [4mqtcsh[24m in verbose mode causing diagnostic output in case
              of remote execution.

       [1m-B     [22mSwitches remote task execution to batch mode. Tasks submitted to
              Grid Engine will be queued if they cannot start immediately.  As
              a  consequence,  [4mqtcsh[24m  may  block  until the queued task can be
              started by Grid Engine. While this behavior probably is undesir-
              able  during  an  interactive session, it may be very useful for
              execution of shell scripts through [4mqtcsh[24m as it avoids failure of
              the scripts due to temporarily unavailable resources for partic-
              ular tasks.

       [1m-L     [22mSwitches off default behavior of remote execution  of  commands.
              Causes all commands to be executed locally even if they are con-
              tained in one of the [4mqtask[24m(5) files.

       [1m-R     [22mEnforces remote execution of commands even if JOB_ID is  set  as
              environment variable.

[1mBUILT-IN COMMANDS[0m
       This section only describes additional shell builtin commands which are
       not available in standard [4mtcsh[24m(1).


       [1mqrshmode [22m[[1m-ANBILR[22m]
              Without options, the current operational mode of [4mqtcsh[24m  is  dis-
              played. The options have the following effect:

              -A   switch to verbose output mode
              -N   switch to non-verbose output mode
              -B   switch to batch execution mode
              -I   switch to immediate execution mode
              -L   always execute commands locally
              -R   execute configured commands remotely


[1mENVIRONMENTAL VARIABLES[0m
       [1mGE_ROOT        [22mSpecifies  the location of the Grid Engine standard con-
                      figuration files.

       [1mGE_CELL        [22mIf set, specifies  the  default  Grid  Engine  cell.  To
                      address  a  Grid Engine cell [4mqtcsh[24m uses (in the order of
                      precedence):

                             The name of the cell specified in the environment
                             variable GE_CELL, if it is set.

                             The name of the default cell, i.e. [1mdefault[22m.


       [1mGE_DEBUG_LEVEL [22mIf set, specifies that debug information should be writ-
                      ten to stderr. In addition the level of detail in  which
                      debug information is generated is defined.

       [1mGE_QMASTER_PORT[0m
                      If set, specifies the tcp port on which [4mge_qmaster[24m(8) is
                      expected to listen  for  communication  requests.   Most
                      installations will use a services map entry for the ser-
                      vice "sge_qmaster" instead to define that port.

       [1mJOB_ID         [22mIf set when starting [4mqtcsh[24m the local operation  mode  is
                      activated  implicitly as if the [1m-L [22moption was specified.

[1mFILES[0m
       [4m~/.qtask[24m       user qtask file.
       [4m<ge_root>/<cell>/common/qtask[0m
                      cluster qtask file.

[1mSEE ALSO[0m
       [4mge_intro[24m(1),   [4mqrsh[24m(1),   [4mqtask[24m(5)   as   well   as    [4mtcsh[24m(1)    under
       <ge_root>/3rd_party/qtcsh.

[1mCOPYRIGHT[0m
       [4mQtcsh[24m  contains portions of [4mtcsh[24m which is copyrighted by The Regents of
       the University of California.  Therefore, the following  note  applies:
       This  product includes software developed by the University of Califor-
       nia, Berkeley and its contributors.

       See     [4mge_intro[24m(1)     and     the     information     provided     in
       <ge_root>/3rd_party/qtcsh for a statement of further rights and permis-
       sions.



GE 6.2u2                 $Date: 2004/11/12 15:40:03 $                 QTCSH(1)
