.\" 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 "oarsh 1"
.TH oarsh 1 "2014-10-24" "oarsh" "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"
oarsh \- remote shell connector for OAR batch scheduler.
.PP
oarcp \- oarsh compagnon to copy files from a node or to a node.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBoarsh\fR [\s-1OPTIONS\s0] <\s-1NODENAME\s0> [\s-1COMMAND\s0]
.PP
\&\fBoarcp\fR [\s-1OPTIONS\s0] [\s-1NODENAME:\s0]<\s-1PATHNAME\s0> [\s-1NODENAME:\s0]<\s-1PATHNAME\s0>
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Connect a node from the submission frontal of the cluster or any node.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fBoarsh\fR uses \fIOpenSSH\fR client (the ssh command) underneath to perform the connection. Thus any OpenSSH option can be used.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\fB\s-1OAR_JOB_ID\s0\fR" 4
.IX Item "OAR_JOB_ID"
From the frontal of the cluster or any node, specify the Id of the job \fBoarsh\fR must connect to.
.IP "\fB\s-1OAR_JOB_KEY_FILE\s0\fR" 4
.IX Item "OAR_JOB_KEY_FILE"
Specify a job key oarsh must use, e.g. the one that was used for the submission of the job you want to connect to. This is mandatory when connecting to a node of a job from a host that does not belong to the nodes managed by the \s-1OAR\s0 server the job was submitted to. The \-i option may be used as well.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
In order to provide the user with the ability to use \fBoarsh\fR to connect both the nodes of his job or other hosts that live out of the scope of his job, \fBoarsh\fR tries to read two configuration files: first \fB~/.oarsh\-host\-include\fR then \fB~/.oarsh\-hosts\-exclude\fR.
.PP
If exist, those files must contain one regular expression matching a hostname per line.
.PP
At execution time, if \fBoarsh\fR finds in \fB~/.oarsh\-host\-include\fR a match for the hostname used in the command line, it continues with the execution of \fBoarsh\fR, skipping \fB~/.oarsh\-hosts\-exclude\fR file. If not, it tries to find a match in \fB~/.oarsh\-hosts\-exclude\fR and if one is found, then executes \fBssh\fR with the same command line. Finally, it no match is found (or for instance, if none of those files exists), it continues with the execution of \fBoarsh\fR.
.PP
For instance, if all nodes look like \fIname\-XXX.domain\fR, one may place \fI^[^\e.]+\-[[:digit:]]+\fR in \fB~/.oarsh\-host\-include\fR and \fI.*\fR in  \fB~/.oarsh\-hosts\-exclude\fR and then can use \fBoarsh\fR to connect any host.
.PP
The feature finally becomes really sexy when one considers placing a symlink to \fBoarsh\fR named \fBssh\fR, and then can always use the \fBssh\fR command to connect any host.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.IP "Connecting from within our job, from one node to another one (node23):" 4
.IX Item "Connecting from within our job, from one node to another one (node23):"
> oarsh node\-23
.IP "Connecting to a node (node23) of our job (Id: 4242) from the frontal of the cluster:" 4
.IX Item "Connecting to a node (node23) of our job (Id: 4242) from the frontal of the cluster:"
> OAR_JOB_ID=4242 oarsh node\-23
.IP "Connecting to a node (node23) of our job that was submitted using a job key:" 4
.IX Item "Connecting to a node (node23) of our job that was submitted using a job key:"
> OAR_JOB_KEY_FILE=~/my_key oarsh node\-23
.IP "Same thing but using OpenSSH-like \fI\-i\fR option:" 4
.IX Item "Same thing but using OpenSSH-like -i option:"
> oarsh \-i ~/my_key node\-23
.SH "NOTES"
.IX Header "NOTES"
All OpenSSH features should be inherited by \fBoarsh\fR, for instance X11 forwarding. However, one feature that \fBoarsh\fR does break is the \s-1SSH\s0 Agent.
.PP
None of OpenSSH user configuration files (within \fI~/.ssh\fR directory) are used by \fBoarsh\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIoarsub\fR\|(1), \fIoardel\fR\|(1) \fIoarstat\fR\|(1), \fIoarnodes\fR\|(1), \fIoarhold\fR\|(1), \fIoarresume\fR\|(1)
.SH "COPYRIGHTS"
.IX Header "COPYRIGHTS"
.Vb 1
\& Copyright 2003\-2013 Laboratoire d\*(AqInformatique de Grenoble (http://www.liglab.fr). This software is licensed under the GNU Library General Public License. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.Ve