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



NNAAMMEE
       qtcsh - tcsh v6.09 with transparent remote execution by use of qrsh.

SSYYNNTTAAXX
       qqttccsshh [ ttccsshh ooppttiioonnss | --AABBLLRR ]

DDEESSCCRRIIPPTTIIOONN
       _q_t_c_s_h  is an extension to the popular _c_s_h(1) derivative _t_c_s_h. It allows
       the transparent remote execution commands entered in  _q_t_c_s_h  controlled
       via  Grid Engine.  _q_t_c_s_h can be used as interactive command interpreter
       as well as for the processing of _t_c_s_h shell scripts.

       When invoked, _q_t_c_s_h identifies which commands are to  be  run  remotely
       and  which are not. For this purpose the files $SGE_ROOT/$SGE_CELL/com-
       mon/qtask and ~/.qtask are processed. Each line in these files  defines
       a command that is intended to be run remotely (see _q_t_a_s_k(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 _q_t_a_s_k(5) file are completely  overridden  in  case  there  is  an
       appropriate  entry  in  the  users _q_t_a_s_k(5) file.  This is prevented in
       case an exclamation mark is prefixed to the command name in the  admin-
       istrator's qtask file.

       _q_t_c_s_h  always  attempts  to  start  the  designated  tasks remotely via
       _q_r_s_h(1).  Exceptions are

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

       +o  if the environment variable JOB_ID is set  and  thus  _q_t_c_s_h  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 --RR and the built-in command
          _q_r_s_h_m_o_d_e _-_R (see corresponding descriptions below).

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

       _q_t_c_s_h 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  _q_t_c_s_h invocation or within an executing _q_t_c_s_h
       via the built-in command _q_r_s_h_m_o_d_e as described in section BBUUIILLTT--IINN CCOOMM--
       MMAANNDDSS.

OOPPTTIIOONNSS
       The  options listed below are special to _q_t_c_s_h. The user is referred to
       the _t_c_s_h(1) documentation for the explanation of further options.


       --AA     Switches _q_t_c_s_h in verbose mode causing diagnostic output in case
              of remote execution.

       --BB     Switches remote task execution to batch mode. Tasks submitted to
              Grid Engine will be queued if they cannot start immediately.  As
              a  consequence,  _q_t_c_s_h  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 _q_t_c_s_h as it avoids failure of
              the scripts due to temporarily unavailable resources for partic-
              ular tasks.

       --LL     Switches 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 _q_t_a_s_k(5) files.

       --RR     Enforces remote execution of commands even if JOB_ID is  set  as
              environment variable.

BBUUIILLTT--IINN CCOOMMMMAANNDDSS
       This section only describes additional shell builtin commands which are
       not available in standard _t_c_s_h(1).


       qqrrsshhmmooddee [--AANNBBIILLRR]
              Without options, the current operational mode of _q_t_c_s_h  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


EENNVVIIRROONNMMEENNTTAALL VVAARRIIAABBLLEESS
       SSGGEE__RROOOOTT       Specifies  the location of the Grid Engine standard con-
                      figuration files.

       SSGGEE__CCEELLLL       If set, specifies  the  default  Grid  Engine  cell.  To
                      address  a  Grid Engine cell _q_t_c_s_h uses (in the order of
                      precedence):

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

                             The name of the default cell, i.e. ddeeffaauulltt.


       SSGGEE__DDEEBBUUGG__LLEEVVEELL
                      If 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.

       SSGGEE__QQMMAASSTTEERR__PPOORRTT
                      If  set,  specifies the tcp port on which _s_g_e___q_m_a_s_t_e_r(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.

       JJOOBB__IIDD         If set when starting _q_t_c_s_h the local operation  mode  is
                      activated  implicitly as if the --LL option was specified.

FFIILLEESS
       _~_/_._q_t_a_s_k       user qtask file.
       _$_S_G_E___R_O_O_T_/_$_S_G_E___C_E_L_L_/_c_o_m_m_o_n_/_q_t_a_s_k
                      cluster qtask file.

SSEEEE AALLSSOO
       _s_g_e___i_n_t_r_o(1),   _q_r_s_h(1),   _q_t_a_s_k(5)   as   well   as   _t_c_s_h(1)    under
       $SGE_ROOT/3rd_party/qtcsh.

CCOOPPYYRRIIGGHHTT
       _q_t_c_s_h  contains portions of _t_c_s_h 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    _s_g_e___i_n_t_r_o(1)     and     the     information     provided     in
       $SGE_ROOT/3rd_party/qtcsh for a statement of further rights and permis-
       sions.



GE 6.1                   $Date: 2007/06/26 22:21:08 $                 QTCSH(1)
