← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/man/man1/qrstat.1

  • 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:
doc/man/man1/qrstat.1
 
1
'\" t
 
2
.\"___INFO__MARK_BEGIN__
 
3
.\"
 
4
.\" Copyright: 2004-2007 by Sun Microsystems, Inc.
 
5
.\"
 
6
.\"___INFO__MARK_END__
 
7
.\"
 
8
.\" $RCSfile$     Last Update: $Date$     Revision: $Revision$
 
9
.\"
 
10
.\"
 
11
.\" Some handy macro definitions [from Tom Christensen's man(1) manual page].
 
12
.\"
 
13
.de SB          \" small and bold
 
14
.if !"\\$1"" \\s-2\\fB\&\\$1\\s0\\fR\\$2 \\$3 \\$4 \\$5
 
15
..
 
16
.\"
 
17
.de T           \" switch to typewriter font
 
18
.ft CW          \" probably want CW if you don't have TA font
 
19
..
 
20
.\"
 
21
.de TY          \" put $1 in typewriter font
 
22
.if t .T
 
23
.if n ``\c
 
24
\\$1\c
 
25
.if t .ft P
 
26
.if n \&''\c
 
27
\\$2
 
28
..
 
29
.\"
 
30
.de M           \" man page reference
 
31
\\fI\\$1\\fR\\|(\\$2)\\$3
 
32
..
 
33
.TH QRSTAT 1 "$Date$" "xxRELxx" "xxQS_NAMExx User Commands"
 
34
.SH NAME
 
35
qrstat \- show the status of xxQS_NAMExx Advance Reservations (AR)
 
36
.\"
 
37
.\"
 
38
.SH SYNTAX
 
39
.B qrstat
 
40
.B [\-ar ar_id,...]
 
41
.B [\-help]
 
42
.B [\-u user,...]
 
43
.B [\-explain]
 
44
.\"
 
45
.\"
 
46
.SH DESCRIPTION
 
47
.I qrstat
 
48
shows the current status of the available xxQS_NAMExx ARs.
 
49
The selection option \fB\-ar\fP allows you to get information about 
 
50
specific AR.
 
51
.PP
 
52
The administrator and the user may define files
 
53
which can contain any of the options described below. A cluster-wide sge_qrstat
 
54
file may be placed under
 
55
$xxQS_NAME_Sxx_ROOT/$xxQS_NAME_Sxx_CELL/common/sge_qrstat
 
56
The user private  file is searched at the location
 
57
$HOME/.sge_qrstat.
 
58
The home directory request file has the highest precedence over
 
59
the cluster global file.
 
60
Command line can be used to override the flags contained in the files.
 
61
.\"
 
62
.SH OPTIONS
 
63
.IP "\fB\-ar ar_id,...\fP"
 
64
Prints various information about the ARs identified by given ar_id list.
 
65
.\"
 
66
.IP "\fB\-explain\fP"
 
67
Displays the reason for the error state of an AR. Possible reasons 
 
68
are the unknown state of a host or queue instance.
 
69
.sp
 
70
The output format for the alarm reasons is one line per reason.
 
71
.\"
 
72
.IP "\fB\-help\fP"
 
73
Prints a listing of all options.
 
74
.\"
 
75
.IP "\fB\-u user,...\fP"
 
76
Display information only for those ARs 
 
77
created by the users from the given user list.
 
78
.sp
 
79
The string
 
80
\fB\ $user\fP
 
81
is a placeholder for the current username. An asterisk "*" can be used 
 
82
as username wildcard to request that all users' ARs be displayed. The
 
83
default value for this switch is "\fB-u $user\fP".
 
84
\"
 
85
.IP "\fB\-xml\fP"
 
86
This option can be used with all other options and changes the output to XML. The used
 
87
schemas are referenced in the XML output. The output is printed to stdout.
 
88
.br
 
89
.\"
 
90
.\"
 
91
.SH "OUTPUT FORMATS"
 
92
Depending on the presence or absence of the \fB-ar\fP option there are two 
 
93
output formats need to be differentiated.
 
94
.\"
 
95
.SS "\fBAdvance Reservation Summary (without \-ar)\fP"
 
96
Following the header line, a section for each AR
 
97
is provided. The columns contain information for
 
98
.IP "\(bu" 3n
 
99
the AR id.
 
100
.IP "\(bu" 3n
 
101
the name of the AR.
 
102
.IP "\(bu" 3n
 
103
the current state of the AR. One of folloging states 'wWrEd".
 
104
.sp 1
 
105
.nf
 
106
.ta \w'|b|  'u
 
107
w - waiting without error
 
108
W - warning (effective - waiting with error)
 
109
r - running
 
110
E - error (effective - running with error)
 
111
d - deleted 
 
112
.fi
 
113
.IP "\(bu" 3n
 
114
the start time of the AR.
 
115
.IP "\(bu" 3n
 
116
the end time of the AR.
 
117
.IP "\(bu" 3n
 
118
the duration of the AR.
 
119
.SS "\fBDetailed Format (with \-ar)\fP"
 
120
The output contains two columns. The first one contains all AR attributes.
 
121
The second one the corresponding value.
 
122
.\"
 
123
.\"
 
124
.SH "ENVIRONMENTAL VARIABLES"
 
125
.\" 
 
126
.IP "\fBxxQS_NAME_Sxx_ROOT\fP" 1.5i
 
127
Specifies the location of the xxQS_NAMExx standard configuration
 
128
files.
 
129
.\"
 
130
.IP "\fBxxQS_NAME_Sxx_CELL\fP" 1.5i
 
131
If set, specifies the default xxQS_NAMExx cell. To address a xxQS_NAMExx
 
132
cell
 
133
.I qrstat
 
134
uses (in the order of precedence):
 
135
.sp 1
 
136
.RS
 
137
.RS
 
138
The name of the cell specified in the environment 
 
139
variable xxQS_NAME_Sxx_CELL, if it is set.
 
140
.sp 1
 
141
The name of the default cell, i.e. \fBdefault\fP.
 
142
.sp 1
 
143
.RE
 
144
.RE
 
145
.\"
 
146
.IP "\fBxxQS_NAME_Sxx_DEBUG_LEVEL\fP" 1.5i
 
147
If set, specifies that debug information
 
148
should be written to stderr. In addition the level of
 
149
detail in which debug information is generated is defined.
 
150
.\"
 
151
.IP "\fBxxQS_NAME_Sxx_QMASTER_PORT\fP" 1.5i
 
152
If set, specifies the tcp port on which
 
153
.M xxqs_name_sxx_qmaster 8
 
154
is expected to listen for communication requests.
 
155
Most installations will use a services map entry for the
 
156
service "sge_qmaster" instead to define that port.
 
157
.\"
 
158
.\"
 
159
.SH FILES
 
160
.nf
 
161
.ta \w'<xxqs_name_sxx_root>/     'u
 
162
\fI<xxqs_name_sxx_root>/<cell>/common/act_qmaster\fP
 
163
        xxQS_NAMExx master host file
 
164
.ta \w'<xxqs_name_sxx_root>/     'u
 
165
\fI<xxqs_name_sxx_root>/<cell>/common/xxqs_name_sxx_qrstat\fP
 
166
        cluster qrstat default options
 
167
\fI$HOME/.xxqs_name_sxx_qrstat\fP       
 
168
        user qrstat default options
 
169
.fi
 
170
.\"
 
171
.\"
 
172
.SH "SEE ALSO"
 
173
.M xxqs_name_sxx_intro 1 ,
 
174
.M qrsub 1 ,
 
175
.M qrdel 1 ,
 
176
.M qsub 1 ,
 
177
.\"
 
178
.\"
 
179
.SH "COPYRIGHT"
 
180
See
 
181
.M xxqs_name_sxx_intro 1
 
182
for a full statement of rights and permissions.