.\" For license: see LICENSE file at top-level
.TH oshcxx 1 "" "OSSS-UCX"
.SH NAME
\fBoshcxx | oshc++\fP \- compile an OpenSHMEM C++ program
.SH SYNOPSIS
\fBoshcxx | oshc++\fP
.RS 2
.br
[ underlying compiler flags ]
.br
file.cxx [file.cxx ...]
.RE
.SH DESCRIPTION
\fBoshcxx\fP is a wrapper in the vein of mpicxx/mpic++ that compiles
an OpenSHMEM program.  The wrapper hides implementation details from
the user.
.SH EXAMPLES
The command
.LP
.RS 2
$ oshcxx -g -o foo.exe foo.cxx
.RE
.LP
compiles C++ source code foo.cxx into the OpenSHMEM executable foo.exe.
.SH ENVIRONMENT
.IP \f(CROSH_CXX\fP 2
Overrides the underlying compiler/linker invoked by this wrapper.  The
default is determined when the OpenSHMEM library is built.
.RE
.LP
.SH NOTES
The OpenSHMEM specification does not say anything normative about how
OpenSHMEM programs are compiled, linked and launched.  These wrapper
programs are supplied as part of the Reference Library for
convenience.
.SH PKG-CONFIG
The underlying flags/options are accessible via pkg-config(1) with the
name \f(CRosss-ucx\fP.
.SH SEE ALSO
osh_intro(1),
pkg-config(1).
.SH OPENSHMEM
http://www.openshmem.org/