.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "QSTAT 1"
.TH QSTAT 1 2024-02-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
qstat \- display job/partition information in a familiar pbs format
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBqstat\fR [\fB\-f\fR] [\fB\-a\fR|\fB\-i\fR|\fB\-r\fR] [\fB\-n\fR [\fB\-1\fR]] [\fB\-G\fR|\fB\-M\fR] [\fB\-u\fR \fIuser_list\fR] [\fB\-? | \-\-help\fR] [\fB\-\-man\fR] [\fIjob_id\fR...]
.PP
\&\fBqstat\fR \-Q [\-f]
.PP
\&\fBqstat\fR \-q
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBqstat\fR command displays information about jobs.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-a\fR 4
.IX Item "-a"
Displays all jobs in a single-line format. See the STANDARD OUTPUT section for format details.
.IP \fB\-i\fR 4
.IX Item "-i"
Displays information about idle jobs. This includes jobs which are queued or held.
.IP \fB\-f\fR 4
.IX Item "-f"
Displays the full information for each selected job in a multi-line format. See the STANDARD OUTPUT section for format details.
.IP \fB\-G\fR 4
.IX Item "-G"
Display size information in gigabytes.
.IP \fB\-M\fR 4
.IX Item "-M"
Show size information, disk or memory in mega-words.  A word is considered to be 8 bytes.
.IP \fB\-n\fR 4
.IX Item "-n"
Displays nodes allocated to a job in addition to the basic information.
.IP \fB\-1\fR 4
.IX Item "-1"
In combination with \-n, the \-1 option puts all of the nodes on the same line as the job id.
.IP \fB\-r\fR 4
.IX Item "-r"
Displays information about running jobs. This includes jobs which are running or suspended.
.IP "\fB\-u\fR \fIuser_list\fR" 4
.IX Item "-u user_list"
Display job information for all jobs owned by the specified user(s). The format of \fIuser_list\fR is: \fIuser_name\fR[,\fIuser_name\fR...].
.IP "\fB\-? | \-\-help\fR" 4
.IX Item "-? | --help"
brief help message
.IP \fB\-\-man\fR 4
.IX Item "--man"
full documentation
.SH "STANDARD OUTPUT"
.IX Header "STANDARD OUTPUT"
Displaying Job Status
.PP
If the \-a, \-i, \-f, \-r, \-u, \-n, \-G, and \-M options are not specified, the brief single-line display format is used. The following items are displayed on a single line, in the specified order, separated by white space:
.IP "the job id" 4
.IX Item "the job id"
.PD 0
.IP "the job name" 4
.IX Item "the job name"
.IP "the job owner" 4
.IX Item "the job owner"
.IP "the cpu time used" 4
.IX Item "the cpu time used"
.IP "the job state" 4
.IX Item "the job state"
.PD
C \-  Job is completed after having run
E \-  Job is exiting after having run.
H \-  Job is held.
Q \-  job is queued, eligible to run or routed.
R \-  job is running.
T \-  job is being moved to new location.
W \-  job is waiting for its execution time
(\-a option) to be reached.
S \-  job is suspended.
.IP "the queue that the job is in" 4
.IX Item "the queue that the job is in"
.PP
If the \-f option is specified, the multi-line display format is used. The output for each job consists of the header line:
\&\fBJob Id\fR:  job identifier
followed by one line per job attribute of the form:
\&\fBattribute_name = value\fR
.PP
If any of the options \-a, \-i, \-r, \-u, \-n, \-G or \-M are specified, the normal single-line display format is used. The following items are displayed on a single line, in the specified order, separated by white space:
.IP "the job id" 4
.IX Item "the job id"
.PD 0
.IP "the job owner" 4
.IX Item "the job owner"
.IP "the queue the job is in" 4
.IX Item "the queue the job is in"
.IP "the job name" 4
.IX Item "the job name"
.IP "the session id (if the job is running)" 4
.IX Item "the session id (if the job is running)"
.IP "the number of nodes requested by the job" 4
.IX Item "the number of nodes requested by the job"
.IP "the number of cpus or tasks requested by the job" 4
.IX Item "the number of cpus or tasks requested by the job"
.IP "the amount of memory requested by the job" 4
.IX Item "the amount of memory requested by the job"
.IP "either the cpu time, if specified, or wall time requested  by the job, (in hh:mm)" 4
.IX Item "either the cpu time, if specified, or wall time requested by the job, (in hh:mm)"
.IP "the job state" 4
.IX Item "the job state"
.IP "The amount of cpu time or wall time used by the job (in hh:mm)" 4
.IX Item "The amount of cpu time or wall time used by the job (in hh:mm)"
.PD
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
On success, \fBqstat\fR will exit with a value of zero. On failure, \fBqstat\fR will exit with a value greater than zero.