'\" te
.TH orbit-idl-2 1 "11 Jan 2003" "SunOS 5.11" "User Commands"
.SH "NAME"
orbit-idl-2 \- ORBit IDL compiler
.SH "SYNOPSIS"
.PP
\fBorbit-idl-2\fR [-\fB-define=\fIstring\fR\fR ] [-\fB-include=\fIstring\fR\fR] [-\fB-libIDL-version\fR] [-\fB-lang=\fIstring\fR\fR] [-\fB-debug=\fIint\fR\fR] [-\fB-idlwarnlevel=\fIint\fR\fR] [-\fB-imodule\fR] [-\fB-showcpperrors\fR] [-\fB-nostubs\fR] [-\fB-noskels\fR] [-\fB-nocommon\fR] [-\fB-noheaders\fR] [-\fB-noidata\fR] [-\fB-add-imodule\fR] [-\fB-skeleton-impl\fR] [-\fB-backenddir=\fIdir\fR\fR] [-\fB-c-output-formatter=\fIprogram\fR\fR] [-\fB-onlytop\fR] [-\fB-pidl\fR] [-\fB-nodefskels\fR] [-\fB-deps=\fIfilename\fR\fR] [-\fB-headerguardprefix=\fIstring\fR\fR] [-\fB-usage\fR] [-\fB-version\fR] [-\fB-help\fR] \fBidlfile\fR
.SH "DESCRIPTION"
.PP
\fBorbit-idl-2\fR is the ORBit Interface Definition Language
(IDL) compiler\&. It takes as input an IDL file, and produces as output a set
of source code files which you can use to develop an application that implements
and/or uses the CORBA interface defined in the IDL file\&.
.SH "OPTIONS"
.PP
The following options are supported:
.sp
.ne 2
.mk
\fB-\fB-add-imodule\fR\fR
.in +32n
.rt
Output an interface type data file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-backenddir=\fIdir\fR\fR\fR
.in +32n
.rt
Override the IDL backend library directory\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-c-output-formatter=\fIprogram\fR\fR\fR
.in +32n
.rt
Specify the program with which to format output (normally,
indent)\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBd\fR, -\fB-debug=\fIint\fR\fR\fR
.in +32n
.rt
Set the debug level\&. Valid values are in the range 0 to 4
inclusive\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBD\fR-\fB-define=\fIstring\fR\fR\fR
.in +32n
.rt
Define value in preprocessor\&. This option is passed directly
to \fBcpp\fR(1)\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-deps=\fIfilename\fR\fR\fR
.in +32n
.rt
Generate dependency information suitable for inclusion in
a Makefile\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-headerguardprefix=\fIstring\fR\fR\fR
.in +32n
.rt
Prefix for \fB#ifdef\fR header guards\&. Sometimes
useful to avoid conflicts\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB?\fR, -\fB-help\fR\fR
.in +32n
.rt
Show help
information on standard output, and exit\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-idlwarnlevel=\fIint\fR\fR\fR
.in +32n
.rt
Set the IDL warning level\&. Valid values are in the range 0
to 4 inclusive\&. The default value is 2\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBi\fR, -\fB-imodule\fR\fR
.in +32n
.rt
Output
only an interface type data file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBI\fR, -\fB-include=\fIstring\fR\fR\fR
.in +32n
.rt
Add search path for include files\&. This option is passed directly
to \fBcpp\fR(1)\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBl\fR, -\fB-lang=\fIstring\fR\fR\fR
.in +32n
.rt
Display the language (the default is C)\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-libIDL-version\fR\fR
.in +32n
.rt
Show version of \fBlibIDL\fR used\&. See \fBlibIDL-2\fR(3)\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-nocommon\fR\fR
.in +32n
.rt
Do not
output a common file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-nodefskels\fR\fR
.in +32n
.rt
Do
not output definitions for skeletals in header\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-noheaders\fR\fR
.in +32n
.rt
Do not
output a header file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-noidata\fR\fR
.in +32n
.rt
Do not
generate interface type data\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-noskels\fR\fR
.in +32n
.rt
Do not
output a skeletals file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-nostubs\fR\fR
.in +32n
.rt
Do not
output a stubs file\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-onlytop\fR\fR
.in +32n
.rt
Inhibit
inclusion of IDL files\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-pidl\fR\fR
.in +32n
.rt
Treat the
input as Pseudo IDL\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-showcpperrors\fR\fR
.in +32n
.rt
Show C preprocessor errors\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-skeleton-impl\fR\fR
.in +32n
.rt
Output a skeletal object implementation\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fB-usage\fR\fR
.in +32n
.rt
Display
brief usage information\&.
.sp
.sp 1
.in -32n
.sp
.ne 2
.mk
\fB-\fBv\fR, -\fB-version\fR\fR
.in +32n
.rt
Display
the compiler version and serial\&.
.sp
.sp 1
.in -32n
.SH "OPERANDS"
.PP
The following operands are supported:
.sp
.ne 2
.mk
\fB\fB\fIfilename\fR\fR\fR
.in +32n
.rt
The name of the input
IDL file to be processed by the compiler\&.
.sp
.sp 1
.in -32n
.SH "EXAMPLES"
.PP
\fBExample 1: Compiling an IDL file\fR
.PP
.PP
.nf
example% \fBorbit-idl-2 example\&.idl\fR
.fi
.PP
The following files are output:
.PP
.PP
.nf
\f(CWexample\&.h example-stubs\&.c example-skels\&.c example-common\&.c\fR
.fi
.PP
\fBExample 2: Compiling an IDL file for use as a client of
the interface only\fR
.PP
.PP
.nf
example% \fBorbit-idl-2 --noskels example\&.idl\fR
.fi
.PP
The following files are output:
.PP
.PP
.nf
\f(CWexample\&.h example-stubs\&.c example-common\&.c\fR
.fi
.PP
\fBExample 3: Compiling an IDL file for use as a servant
of the interface only\fR
.PP
.PP
.nf
example% \fBorbit-idl-2 --nostubs example\&.idl\fR
.fi
.PP
The following files are output:
.PP
.PP
.nf
\f(CWexample\&.h example-skels\&.c example-common\&.c\fR
.fi
.PP
\fBExample 4: Compiling an IDL file that includes IDL files
located in a non-standard directory\fR
.PP
.PP
.nf
example% \fBorbit-idl-2 -I /example-idl-location example\&.idl\fR
.fi
.PP
In this example, \fBexample\&.idl\fR includes \fBexample-included\&.idl\fR, which is located in \fB/example-idl-location/example-included\&.idl\fR\&.
.SH "EXIT STATUS"
.PP
The following exit values are returned:
.sp
.ne 2
.mk
\fB\fB0\fR\fR
.in +9n
.rt
Application exited successfully
.sp
.sp 1
.in -9n
.sp
.ne 2
.mk
\fB\fB>0\fR\fR
.in +9n
.rt
Application
exited with failure
.sp
.sp 1
.in -9n
.SH "FILES"
.PP
The following files are used by this application:
.sp
.ne 2
.mk
\fB\fB/usr/bin/orbit-idl-2\fR\fR
.in +24n
.rt
Executable for the ORBit IDL compiler
.sp
.sp 1
.in -24n
.SH "ATTRIBUTES"
.PP
See \fBattributes\fR(5)
for descriptions of the following attributes:
.sp
.TS
tab() allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWgnome-component-devel
Interface stabilityVolatile
.TE
.sp
.SH "SEE ALSO"
.PP
\fBcpp\fR(1),
\fBlibIDL-2\fR(3),
\fBlibORBit-2\fR(3),
\fBattributes\fR(5)
.SH "NOTES"
.PP
The output source code is specific to ORBit and should not be used with
any other Object Request Broker (ORB), with any other version of ORBit, or
on a platform other than the one on which the IDL compiler was itself compiled\&.
.PP
Written by Mark McLoughlin, Sun Microsystems Inc\&., 2003, 2006\&.
...\" created by instant / solbook-to-man, Wed 18 Dec 2013, 18:59
...\" LSARC 2001/201 GNOME 2.X on Solaris