MAN Solaris - orbit-idl-2 (1)

advertisement


NAME

orbit-idl-2 - ORBit IDL compiler

CONTENTS

SYNOPSIS

orbit-idl-2 [--define=string ] [--include=string] [--libIDL-version] [--lang=string] [--debug=int] [--idlwarnlevel=int] [--imodule] [--showcpperrors] [--nostubs] [--noskels] [--nocommon] [--noheaders] [--noidata] [--add-imodule] [--skeleton-impl] [--backenddir=dir] [--c-output-formatter=program] [--onlytop] [--pidl] [--nodefskels] [--deps=filename] [--headerguardprefix=string] [--usage] [--version] [--help] idlfile

advertisements

advertisements


DESCRIPTION

orbit-idl-2 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.

OPTIONS

The following options are supported:

--add-imodule Output an interface type data file.

--backenddir=dir Override the IDL backend library directory.

--c-output-formatter=program Specify the program with which to format output (normally, indent).

-d, --debug=int Set the debug level. Valid values are in the range 0 to 4 inclusive.

-D--define=string Define value in preprocessor. This option is passed directly to cpp(1).

--deps=filename Generate dependency information suitable for inclusion in a Makefile.

--headerguardprefix=string Prefix for #ifdef header guards. Sometimes useful to avoid conflicts.

-?, --help Show help information on standard output, and exit.

--idlwarnlevel=int Set the IDL warning level. Valid values are in the range 0 to 4 inclusive. The default value is 2.

-i, --imodule Output only an interface type data file.

-I, --include=string Add search path for include files. This option is passed directly to cpp(1).

-l, --lang=string Display the language (the default is C).

--libIDL-version Show version of libIDL used. See libIDL-2(3).

--nocommon Do not output a common file.

--nodefskels Do not output definitions for skeletals in header.

--noheaders Do not output a header file.

--noidata Do not generate interface type data.

--noskels Do not output a skeletals file.

--nostubs Do not output a stubs file.

--onlytop Inhibit inclusion of IDL files.

--pidl Treat the input as Pseudo IDL.

--showcpperrors Show C preprocessor errors.

--skeleton-impl Output a skeletal object implementation.

--usage Display brief usage information.

-v, --version Display the compiler version and serial.

OPERANDS

The following operands are supported:

filename The name of the input IDL file to be processed by the compiler.

EXAMPLES

Example 1: Compiling an IDL file

example% orbit-idl-2 example.idl

The following files are output:

example.h example-stubs.c example-skels.c example-common.c

Example 2: Compiling an IDL file for use as a client of the interface only

example% orbit-idl-2 --noskels example.idl

The following files are output:

example.h example-stubs.c example-common.c

Example 3: Compiling an IDL file for use as a servant of the interface only

example% orbit-idl-2 --nostubs example.idl

The following files are output:

example.h example-skels.c example-common.c

Example 4: Compiling an IDL file that includes IDL files located in a non-standard directory

example% orbit-idl-2 -I /example-idl-location example.idl

In this example, example.idl includes example-included.idl, which is located in /example-idl-location/example-included.idl.

EXIT STATUS

The following exit values are returned:

0 Application exited successfully

>0 Application exited with failure

FILES

The following files are used by this application:

/usr/bin/orbit-idl-2 Executable for the ORBit IDL compiler

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWgnome-component-devel
Interface stabilityVolatile

SEE ALSO

cpp(1), libIDL-2(3), libORBit-2(3), attributes(5)

NOTES

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.

Written by Mark McLoughlin, Sun Microsystems Inc., 2003, 2006.

Jump to page    or go to Top of page |  Section 1 |  Main Solaris Index.


SunOS 5.11 orbit-idl-2 (1) 11 Jan 2003
Generated by Open Solaris Forum from /usr/share/man/man1/orbit-idl-2.1 using man macros with tbl support.