~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman1/sge_types.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
ImportĀ upstreamĀ versionĀ 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     sge_types - Grid Engine type descriptions
 
7
 
 
8
DESCRIPTION
 
9
     The Grid Engine user interface consists of several  programs
 
10
     and  files.  Some  command-line  switches  and  several file
 
11
     attributes  are  types.  The  syntax  for  these  types   is
 
12
     explained in this page.
 
13
 
 
14
TYPES
 
15
     The syntax of Grid Engine types in alphabetic order:
 
16
 
 
17
  expression
 
18
     The wildcard expression is a regular boolean expression that
 
19
     consists  of  a couple of <I>pattern</I>'s joined by boolean opera-
 
20
     tors and priority brackets. When ever  expression  are  used
 
21
     the following definition applies:
 
22
 
 
23
     expression= ["!"] ["("] valExp [")"] [ AND_OR expression  ]*
 
24
     valExp  = pattern | expression AND_OR  = "&amp;" | "|"
 
25
 
 
26
     where:
 
27
 
 
28
     "!"     not operator negate the following pattern or expresion
 
29
     "&amp;"     and operator logically and with the following expression
 
30
     "|"     or operator logically or with the following expression
 
31
     "("     open bracket begin the priority evaluated expression. The close bracket is required
 
32
     ")"     close bracket ends the priority evaluated expression.
 
33
     "pattern"see the <I>pattern</I> definition
 
34
 
 
35
     The wildcard expresion itself should  be  put  into  '"'  to
 
36
     ensure, that the clients get the expression.
 
37
 
 
38
     e.g.
 
39
          "!(lx*|sol*)&amp;*64*"not begin with lx or sol, but contain
 
40
          64 "(rh_3*|suse_[89]*)&amp;!rh_3.1"attribute rh_3*, suse_8*
 
41
          or suse_9*, but do not on a rh_3.1
 
42
 
 
43
 
 
44
  pattern
 
45
     When  ever  patterns  are  used  the  following   definition
 
46
     applies:
 
47
 
 
48
     "*"     matches any character and any number of characters
 
49
             (between 0 and inv).
 
50
     "?"     matches any character. It cannot be no character
 
51
     "."     is the character ".". It has no other meaning
 
52
     "\"     escape character. "\\" = "\", "\*" = "*", "\?" = "?"
 
53
     "[...]" specifies an array or a range of allowed
 
54
             characters for one character at a specific position.
 
55
             Character ranges may be specified using the a-z notation.
 
56
             The caret symbol (^) is not interpreted as a logical
 
57
             not; it is intrepreted literally.
 
58
 
 
59
     For more details please see
 
60
     <B><A HREF="../htmlman5/fnmatch.html">fnmatch(5)</A></B>
 
61
 
 
62
 
 
63
     The pattern itself should be put into '"'  to  ensure,  that
 
64
     the clients get the pattern. The or '|' operator is not sup-
 
65
     ported.
 
66
 
 
67
  range
 
68
     The task range specifier has the form
 
69
 
 
70
     n[-m[:s]][,n[-m[:s]], ...] or n[-m[:s]][ n[-m[:s]] ...]
 
71
 
 
72
     and thus consists of a comma  or  blank  separated  list  of
 
73
     range  specifiers  n[-m[:s]]. The ranges are concatenated to
 
74
     the complete task id range.  Each  range  may  be  a  single
 
75
     number,  a  simple  range  of the form n-m or a range with a
 
76
     step size.
 
77
 
 
78
  wc_host
 
79
     A  wildcard  host  specification  (<I>wc</I>_<I>host</I>)  is  a  wildcard
 
80
     expression  which  might match one or more hosts used in the
 
81
     cluster.  The first character of that  string  never  begins
 
82
     with  an  at-character  ('@'), even if the expression begins
 
83
     with a wildcard character.
 
84
 
 
85
     e.g.
 
86
          *            all hosts
 
87
          a*           all host beginning with an 'a'
 
88
 
 
89
  wc_hostgroup
 
90
     A wildcard hostgroup specification (<I>wc</I>_<I>hostgroup</I>) is a wild-
 
91
     card  expression  which  might match one or more hostgroups.
 
92
     The first character of that string is always an at-character
 
93
     ('@').
 
94
 
 
95
     More information concerning hostgroups can be found in <I>host-</I>
 
96
     <B><A HREF="../htmlman5/group.html">group(5)</A></B>
 
97
 
 
98
     e.g.
 
99
          @*           all hostgroups in the cluster
 
100
          @solaris     the @solaris hostgroup
 
101
 
 
102
  wc_job
 
103
     The wildcard job specification is a placeholder for job ids,
 
104
     job  names  include job name pattern. A job id always refer-
 
105
     ences one job, while the names and pattern  might  reference
 
106
     multiple jobs.
 
107
 
 
108
     wc_job := job-id | job-name | pattern
 
109
 
 
110
  wc_job_range
 
111
     The wildcard job range  specification  allows  to  reference
 
112
     specific  array  tasks  for  one or multipe jobs. The job is
 
113
     referenced via wc_job and in addition gets a range specifier
 
114
     for the array tasks.
 
115
 
 
116
     wc_job_range := wc_job [ -t range]
 
117
 
 
118
  wc_job_list
 
119
     The wildcard job list specification allows to reference mul-
 
120
     tiple jobs with one command.
 
121
 
 
122
     wc_job_list := wc_job [ , wc_job , ...]
 
123
 
 
124
  wc_job_range_list
 
125
     The wildcard job range list (<I>wc</I>_<I>job</I>_<I>range</I>_<I>list</I>) is specified
 
126
     by one of the following forms:
 
127
 
 
128
         <I>wc</I>_<I>job</I>[ -<I>t</I> <I>range</I>][{, }<I>wc</I>_<I>job</I>[ -<I>t</I> <I>range</I>]{, }...]
 
129
 
 
130
     If present, the <I>task</I>_<I>range</I> restricts the effect of the  <I>qmod</I>
 
131
     operation to the array job task range specified as suffix to
 
132
     the job id (see the -t option to <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> for further details
 
133
     on array jobs).
 
134
 
 
135
  wc_qdomain
 
136
     <I>wc</I>_<I>qdomain</I> := <I>wc</I>_<I>cqueue</I> "@" <I>wc</I>_<I>hostgroup</I>
 
137
 
 
138
     A   wildcard   expression   queue    domain    specification
 
139
     (<I>wc</I>_<I>qdomain</I>) starts with a wildcard expression cluster queue
 
140
     name (<I>wc</I>_<I>cqueue</I>) followed by an at-character '@' and a wild-
 
141
     card expression hostgroup specification (<I>wc</I>_<I>hostgroup</I>).
 
142
 
 
143
     <I>wc</I>_<I>qdomain</I> are used to address a group of  queue  instances.
 
144
     All  queue  instances  residing  on a hosts which is part of
 
145
     matching hostgroups will be  addressed.  Please  note,  that
 
146
     <I>wc</I>_<I>hostgroup</I> always begins with an at-character.
 
147
 
 
148
     e.g.
 
149
          *@@*         all queue instances whose underlying
 
150
                       host is part of at least one hostgroup
 
151
          a*@@e*       all queue instances begins with a whose underlying
 
152
                       host is part of at least one hostgroup begin with e
 
153
          *@@solaris   all queue instances on hosts part of
 
154
                       the @solaris hostgroup
 
155
 
 
156
  wc_cqueue
 
157
     A   wildcard   expression   cluster   queue    specification
 
158
     (<I>wc</I>_<I>cqueue</I>)  is  a wildcard expression which might match one
 
159
     or more cluster queues used in  the  cluster.   That  string
 
160
     never contains an at-character ('@'), even if the expression
 
161
     begins with a wildcard character.
 
162
     e.g.
 
163
          *            all cluster queues
 
164
          a*           all cluster queues beginning with an 'a'
 
165
          a*&amp;!adam     all cluster queues beginning with an 'a',but not adam
 
166
 
 
167
  wc_qinstance
 
168
     <I>wc</I>_<I>qinstance</I> := <I>wc</I>_<I>cqueue</I> "@" <I>wc</I>_<I>host</I>
 
169
 
 
170
     A   wildcard   expression   queue   instance   specification
 
171
     (<I>wc</I>_<I>qinstance</I>)  starts  with  a  wildcard expression cluster
 
172
     queue name (<I>wc</I>_<I>cqueue</I>) followed by an at-character '@' and a
 
173
     wildcard expression hostname (<I>wc</I>_<I>host</I>).
 
174
 
 
175
     <I>wc</I>_<I>qinstance</I> expressions are used  to  address  a  group  of
 
176
     queue instances whose underlying hostname matches the given
 
177
     expression.  Please note that the first character of <I>wc</I>_<I>host</I>
 
178
     does never match the at-character '@'.
 
179
 
 
180
     e.g.
 
181
          *@*          all queue instances in the cluster
 
182
          *@b*         all queue instances whose
 
183
                       hostname begins with a 'b'
 
184
          *@b*|c*      all queue instances whose
 
185
                       hostname begins with a 'b' or 'c'
 
186
 
 
187
  wc_queue
 
188
     <I>wc</I>_<I>queue</I> := <I>wc</I>_<I>cqueue</I> | <I>wc</I>_<I>qdomain</I> | <I>wc</I>_<I>qinstance</I>
 
189
 
 
190
     A wildcard queue expression (<I>wc</I>_<I>queue</I>)  might  either  be  a
 
191
     wildcard  expression cluster queue specification (<I>wc</I>_<I>cqueue</I>)
 
192
     or  a  wildcard  expression   queue   domain   specification
 
193
     (<I>wc</I>_<I>qdomain</I>) or a wildcard expression queue instance specif-
 
194
     ication (<I>wc</I>_<I>qinstance</I>).
 
195
 
 
196
     e.g.
 
197
          big_*1           cluster queues which begin with
 
198
                           "big_" and end with "1"
 
199
          big_*&amp;!*1        cluster queues which begin with
 
200
                           "big_" ,but does not end with "1"
 
201
          *@fangorn        all qinstances residing on host
 
202
                           fangorn
 
203
 
 
204
  wc_queue_list
 
205
     <I>wc</I>_<I>queue</I>_<I>list</I> := <I>wc</I>_<I>queue</I> ["," <I>wc</I>_<I>queue</I> "," ...]
 
206
 
 
207
     Comma separated list of wc_queue elements.
 
208
 
 
209
     e.g.
 
210
          big, medium_*@@sol*, *@fangorn.sun.com
 
211
 
 
212
  wc_user
 
213
     A wildcard user name pattern is either a wildcard user  name
 
214
     specification or a full user name.
 
215
 
 
216
     wc_user := user_name | pattern
 
217
 
 
218
  wc_user_list
 
219
     A list of user names.
 
220
 
 
221
     wc_user_list := wc_user [ , wc_user , ...]
 
222
 
 
223
  wc_project
 
224
     A wildcard project name pattern is either a wildcard project
 
225
     name specification or a full project name.
 
226
 
 
227
     wc_project := project | pattern
 
228
 
 
229
  wc_pe_name
 
230
     A wildcard parallel environment name  pattern  is  either  a
 
231
     wildcard pe name specification or a full pe name.
 
232
 
 
233
     wc_pe_name := pe_name | pattern
 
234
 
 
235
SEE ALSO
 
236
     <B><A HREF="../htmlman1/qacct.html">qacct(1)</A></B>, <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B>, <B><A HREF="../htmlman1/qquota.html">qquota(1)</A></B>
 
237
 
 
238
COPYRIGHT
 
239
     Copyright: 2004-2007 by Sun Microsystems, Inc.
 
240
 
 
241
 
 
242
 
 
243
 
 
244
 
 
245
 
 
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
251
 
 
252
 
 
253
 
 
254
 
 
255
 
 
256
 
 
257
 
 
258
 
 
259
 
 
260
 
 
261
 
 
262
 
 
263
 
 
264
 
 
265
 
 
266
</PRE>
 
267
<HR>
 
268
<ADDRESS>
 
269
Man(1) output converted with
 
270
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
271
</ADDRESS>
 
272
</BODY>
 
273
</HTML>