.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "oarstat 1"
.TH oarstat 1 "2016-03-31" "oarstat" "OAR commands"
.\" 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"
oarstat \- show information about jobs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBoarstat\fR [\-X|\-Y|\-J|\-D|\-f] [\-j jobid|\-\-array arrayid] [\-\-sql SQL_properties] [\-u user] [\-\-array] [\-\-compact] [\-\-format num]
.PP
\&\fBoarstat\fR [\-e|\-p] [\-j jobid | \-\-array arrayid]
.PP
\&\fBoarstat\fR \-s [\-X|\-Y|\-J|\-D] \-j jobid
.PP
\&\fBoarstat\fR [\-X|\-Y|\-J|\-D] \-\-gantt \*(L"YYYY-MM-DD hh:mm:ss, YYYY-MM-DD hh:mm:ss\*(R"
.PP
\&\fBoarstat\fR \-\-accounting \*(L"YYYY-MM-DD, YYYY-MM-DD\*(R"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to show information of jobs in \s-1OAR\s0 batch scheduler.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-f, \-\-full\fR" 4
.IX Item "-f, --full"
Very detailed display.
.IP "\fB\-j, \-\-job\fR job_id" 4
.IX Item "-j, --job job_id"
Print information from a specific job.
.IP "\fB\-e, \-\-events\fR" 4
.IX Item "-e, --events"
Print job events only.
.IP "\fB\-p, \-\-properties\fR" 4
.IX Item "-p, --properties"
Print job properties in the same format as in the \f(CW$OAR_RESOURCE_PROPERTIES_FILE\fR file on the nodes.
.IP "\fB\-s, \-\-state\fR" 4
.IX Item "-s, --state"
Print only the state of a specified job. It makes a minimal query to the database. It is optimized to allow scripting for example. Must be used with \-j.
.IP "\fB\-u, \-\-user\fR [login]" 4
.IX Item "-u, --user [login]"
Print information for the current user or the one given.
If used with \-\-accounting, print a more detailed accounting report for the user.
.IP "\fB\-\-array\fR [array_id]" 4
.IX Item "--array [array_id]"
Toggle the visualization of array information on.  If an array_id is provided, print information relative to the subjobs of the given array job.
.IP "\fB\-c, \-\-compact\fR" 4
.IX Item "-c, --compact"
Prints only one line for all the jobs belonging to a same array. The id is replaced by <N>@<id> where \*(L"N\*(R" is the number of jobs inside the array and \*(L"id\*(R" is the id of the array. The state is not relevant for an array of jobs (as some jobs may be waiting while others are running for example), so the state column always shows a dash.
.IP "\fB\-\-sql\fR" 4
.IX Item "--sql"
Restricts display with the \s-1SQL\s0 where clause on the table jobs (ex: \*(L"project = 'p1'\*(R")
.IP "\fB\-\-format\fR" 4
.IX Item "--format"
select the text output format. Available values are:
  1: default
  2: prints system messages
.Sp
The users can use the environment variable \s-1OAR_OARSTAT_OUTPUT_FORMAT\s0 to select the output format 1 or 2.
.IP "\fB\-D, \-\-DUMPER\fR" 4
.IX Item "-D, --DUMPER"
Print result in \s-1DUMPER\s0 format.
.IP "\fB\-X, \-\-XML\fR" 4
.IX Item "-X, --XML"
Print result in \s-1XML\s0 format.
.IP "\fB\-Y, \-\-YAML\fR" 4
.IX Item "-Y, --YAML"
Print result in \s-1YAML\s0 format.
.IP "\fB\-J, \-\-JSON\fR" 4
.IX Item "-J, --JSON"
Print result in \s-1JSON\s0 format.
.ie n .IP "\fB\-g, \-\-gantt\fR ""date_start,date_stop""" 4
.el .IP "\fB\-g, \-\-gantt\fR ``date_start,date_stop''" 4
.IX Item "-g, --gantt date_start,date_stop"
Print history of jobs and state of resources between two dates like \*(L"2006\-03\-30 13:49:27, 2006\-04\-30 13:49:27\*(R"
.ie n .IP "\fB\-\-accounting\fR ""date_start,date_stop""" 4
.el .IP "\fB\-\-accounting\fR ``date_start,date_stop''" 4
.IX Item "--accounting date_start,date_stop"
Shows accounting information between two dates like \*(L"2006\-03\-30, 2006\-04\-30\*(R".
 If \-\-user is also used, more details are shown for this particular user.
 Warning: the accounting table must be up to date. The update must be done at superuser level with the oaraccounting command.
.IP "\fB\-V, \-\-version\fR" 4
.IX Item "-V, --version"
Print \s-1OAR\s0 version number.
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Print help message.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIoarprint\fR\|(1), \fIoarsub\fR\|(1), \fIoardel\fR\|(1), \fIoarnodes\fR\|(1), \fIoarhold\fR\|(1), \fIoarresume\fR\|(1)
.SH "COPYRIGHTS"
.IX Header "COPYRIGHTS"
.Vb 1
\& Copyright 2003\-2016 Laboratoire d\*(AqInformatique de Grenoble (http://www.liglab.fr). This software is licensed under the GNU General Public License Version 2 or above. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.Ve