orbit-idl-2(1) [debian man page]
ORBIT-IDL-2(1) General Commands Manual ORBIT-IDL-2(1) NAME
orbit-idl-2 - IDL compiler for ORBit2 SYNOPSIS
orbit-idl-2 [ options ] file... DESCRIPTION
orbit-idl-2 converts object interface descriptions written in CORBA IDL (Interface Definition Language) into C code that you can compile and link into your programs. OPTIONS
orbit-idl-2 accepts the following options: -d ARG --debug=ARG Set the debug level. Supported levels are 0 to 4, default is 2. --idlwarnlevel=INT Set the warning level for compiler warnings. Supported levels are 0 to 4, default is 2. --showcpperrors Show errors from cpp(1). --small Optimize for size instead of speed. --oldstyle Use the old style IDL compiler (not generally recommended). --skeleton-impl Generate a skeleton-impl file. --nostubs Do not create the stubs file. --noskels Do not create the skels file. --nocommon Do not create the common file. --noheaders Do not create the headers file. --noidata Don't generate Interface type data. -i --imodule Generate only an imodule file (no skels, stubs, etc.). --add-imodule Generate an imodule file (as well as other files generated by default or by other options). --onlytop Inhibit file includes. --pidl Treat source as pseudo-IDL. -D ARG --define=ARG Define name for preprocessor. -I PATH --include=PATH Add search path for include files. --deps=FILENAME Generate dependency information, suitable for inclusion in a Makefile. -l ARG --lang=ARG Specify the output language. The default is C. Support for languages other than C requires the installation of a backend for that language. --backenddir=DIR Specify the directory where a language backend is stored (not necessary if backend is stored in the default directory). --usage Print a very brief usage summary. -? --help Print a slightly more detailed usage summary. -v --version Print version number and serial. COMPILING
The IDL file(s) compiled by orbit-idl-2 define the interfaces to network-transparent objects. These files are first passed to cpp(1), the C Preprocessor, then the result is parsed, and the C code is generated. By default, orbit-idl-2 generates four files, the stubs, skels, common, and header files. If your input file is named sample.idl, then the output files will be named, respectively, sample-stubs.c, sample-skels.c, sample-common.c, and sample.h. You can optionally also gen- erate a skeleton-impl file (which would be named sample-skelimpl.c in our example), or an imodule file (e.g. sample-imodule.c). These files require manual editing to be useful, and is therefore not generated by default. The generated C files are formatting ("pretty-printed") using indent(1). You can use another program for this if you prefer, with the --c- output-formatter argument. SEE ALSO
orbit2-config(1), cpp(1), indent(1), /usr/share/doc/liborbit2-dev, http://orbit-resource.sourceforge.net, http://www.omg.org. AUTHOR
Copyright (C) 2001, 2002 Dick Porter <dick@acm.org> and Elliot Lee <sopwith@redhat.com> This manual was originally written for orbit-idl by Chris Waters <xtifr@debian.org> for Debian GNU/Linux. Version 0.5.15 18 March 2002 ORBIT-IDL-2(1)
Check Out this Related Man Page
orbit-idl-2(1) User Commands orbit-idl-2(1) NAME
orbit-idl-2 - ORBit IDL compiler 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 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 TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWgnome-component-devel | +-----------------------------+-----------------------------+ |Interface stability |Volatile | +-----------------------------+-----------------------------+ 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. SunOS 5.11 11 Jan 2003 orbit-idl-2(1)