.\" -*- 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 "oarprint 1"
.TH oarprint 1 2024-04-10 oarprint "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
oarprint \- pretty print of a job resources
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBoarprint\fR [options] <key property name>
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Print a sorted output of the resources of a job with regard to a key property, with a customisable format.
.SH OPTION
.IX Header "OPTION"
.IP "\fB\-f, \-\-file\fR" 4
.IX Item "-f, --file"
Input file, default is \f(CW$OAR_RESOURCE_PROPERTIES_FILE\fR (available within a job). See the EXAMPLES section below for more details.
.IP "\fB\-P, \-\-properties\fR" 4
.IX Item "-P, --properties"
Property to display separated by commas, default: key property.
.IP \fB\-F,\-\-format\fR 4
.IX Item "-F,--format"
Customised output format, default: "%" .
.IP "\fB\-T, \-\-token\fR" 4
.IX Item "-T, --token"
Substitution token to replace in the format string, default: % .
.IP "\fB\-C, \-\-comma\fR" 4
.IX Item "-C, --comma"
Separator to use when displaying lists, default: , .
.IP "\fB\-l, \-\-list\fR" 4
.IX Item "-l, --list"
List available properties and exit.
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Show help usage.
.SH EXAMPLES
.IX Header "EXAMPLES"
On the job connection node (where \f(CW$OAR_RESOURCE_PROPERTIES_FILE\fR is defined):
.PP
.Vb 1
\& oarprint host \-P host,cpu,core \-F "host: % cpu: % core: %" \-C+
.Ve
.PP
On the submission frontend:
.PP
.Vb 1
\& oarstat \-j 42 \-p | oarprint core \-P host,cpuset,mem \-F "%[%] (%)" \-f \-
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBoarstat\fR\|(1), \fBoarnodes\fR\|(1), \fBoarsub\fR\|(1), \fBoardel\fR\|(1), \fBoarhold\fR\|(1), \fBoarresume\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