1QTCSH(1)                   Grid Engine User Commands                  QTCSH(1)
2
3
4

NAME

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

SYNTAX

9       qtcsh [ tcsh options | -ABLR ]
10

DESCRIPTION

12       Qtcsh  is an extension to the popular csh(1) derivative tcsh. It allows
13       the transparent remote execution commands entered in  qtcsh  controlled
14       via  Grid Engine.  Qtcsh can be used as interactive command interpreter
15       as well as for the processing of tcsh shell scripts.
16
17       When invoked, qtcsh identifies which commands are to  be  run  remotely
18       and  which  are  not.  For this purpose the files <ge_root>/<cell>/com‐
19       mon/qtask and ~/.qtask are processed. Each line in these files  defines
20       a command that is intended to be run remotely (see qtask(5) for a defi‐
21       nition of the file format). The .qtask file in the user's  home  direc‐
22       tory  contains  the user's remote task specification, while the file in
23       the common directory is maintained by the administrator and  defines  a
24       cluster-wide  default behavior.  The contents of the administrator sup‐
25       plied qtask(5) file are completely  overridden  in  case  there  is  an
26       appropriate  entry  in  the  users qtask(5) file.  This is prevented in
27       case an exclamation mark is prefixed to the command name in the  admin‐
28       istrators qtask file.
29
30       Qtcsh  always  attempts  to  start  the  designated  tasks remotely via
31       qrsh(1).  Exceptions are
32
33       ·  if the user enters such commands via a relative or absolute pathname
34          instead  of  the  stand-alone  command  name  (see qtask(5) for more
35          information).
36
37       ·  if the environment variable JOB_ID is set  and  thus  qtcsh  assumes
38          that execution already happens remotely within a Grid Engine job and
39          thus executes tasks locally. This avoids unwanted recursions but can
40          be overridden by the command-line option -R and the built-in command
41          qrshmode -R (see corresponding descriptions below).
42
43       ·  if qtcsh cannot establish a connection of Grid Engine during  start-
44          up.  This  allows  to use qtcsh as login shell without the danger of
45          being blocked when no Grid Engine service is available.
46
47       Qtcsh can operate in three different modes determining whether
48
49       ·  tasks are executed remotely.
50
51       ·  immediate or batch execution is requested.
52
53       ·  status output is verbose or only in case of any errors.
54
55       These modes either can  be  controlled  by  the  command-line  switches
56       described  below  during  qtcsh invocation or within an executing qtcsh
57       via the built-in command qrshmode as described in section BUILT-IN COM‐
58       MANDS.
59

OPTIONS

61       The  options  enlisted below are special to qtcsh. The user is referred
62       to the tcsh(1) documentation for the explanation of further options.
63
64
65       -A     Switches qtcsh in verbose mode causing diagnostic output in case
66              of remote execution.
67
68       -B     Switches remote task execution to batch mode. Tasks submitted to
69              Grid Engine will be queued if they cannot start immediately.  As
70              a  consequence,  qtcsh  may  block  until the queued task can be
71              started by Grid Engine. While this behavior probably is undesir‐
72              able  during  an  interactive session, it may be very useful for
73              execution of shell scripts through qtcsh as it avoids failure of
74              the scripts due to temporarily unavailable resources for partic‐
75              ular tasks.
76
77       -L     Switches off default behavior of remote execution  of  commands.
78              Causes all commands to be executed locally even if they are con‐
79              tained in one of the qtask(5) files.
80
81       -R     Enforces remote execution of commands even if JOB_ID is  set  as
82              environment variable.
83

BUILT-IN COMMANDS

85       This section only describes additional shell builtin commands which are
86       not available in standard tcsh(1).
87
88
89       qrshmode [-ANBILR]
90              Without options, the current operational mode of qtcsh  is  dis‐
91              played. The options have the following effect:
92
93              -A   switch to verbose output mode
94              -N   switch to non-verbose output mode
95              -B   switch to batch execution mode
96              -I   switch to immediate execution mode
97              -L   always execute commands locally
98              -R   execute configured commands remotely
99
100

ENVIRONMENTAL VARIABLES

102       GE_ROOT        Specifies  the location of the Grid Engine standard con‐
103                      figuration files.
104
105       GE_CELL        If set, specifies  the  default  Grid  Engine  cell.  To
106                      address  a  Grid Engine cell qtcsh uses (in the order of
107                      precedence):
108
109                             The name of the cell specified in the environment
110                             variable GE_CELL, if it is set.
111
112                             The name of the default cell, i.e. default.
113
114
115       GE_DEBUG_LEVEL If set, specifies that debug information should be writ‐
116                      ten to stderr. In addition the level of detail in  which
117                      debug information is generated is defined.
118
119       GE_QMASTER_PORT
120                      If set, specifies the tcp port on which ge_qmaster(8) is
121                      expected to listen  for  communication  requests.   Most
122                      installations will use a services map entry for the ser‐
123                      vice "sge_qmaster" instead to define that port.
124
125       JOB_ID         If set when starting qtcsh the local operation  mode  is
126                      activated implicitly as if the -L option was specified.
127

FILES

129       ~/.qtask       user qtask file.
130       <ge_root>/<cell>/common/qtask
131                      cluster qtask file.
132

SEE ALSO

134       ge_intro(1),    qrsh(1),    qtask(5)   as   well   as   tcsh(1)   under
135       <ge_root>/3rd_party/qtcsh.
136
138       Qtcsh contains portions of tcsh which is copyrighted by The Regents  of
139       the  University  of California.  Therefore, the following note applies:
140       This product includes software developed by the University of  Califor‐
141       nia, Berkeley and its contributors.
142
143       See     ge_intro(1)     and     the     information     provided     in
144       <ge_root>/3rd_party/qtcsh for a statement of further rights and permis‐
145       sions.
146
147
148
149GE 6.2u5                 $Date: 2004/11/12 15:40:03 $                 QTCSH(1)
Impressum