version 1, including all changes.
.
Rev |
Author |
# |
Line |
1 |
perry |
1 |
ORBIT-IDL |
|
|
2 |
!!!ORBIT-IDL |
|
|
3 |
NAME |
|
|
4 |
SYNOPSIS |
|
|
5 |
DESCRIPTION |
|
|
6 |
OPTIONS |
|
|
7 |
COMPILING |
|
|
8 |
SEE ALSO |
|
|
9 |
AUTHOR |
|
|
10 |
---- |
|
|
11 |
!!NAME |
|
|
12 |
|
|
|
13 |
|
|
|
14 |
orbit-idl - IDL compiler for ORBit |
|
|
15 |
!!SYNOPSIS |
|
|
16 |
|
|
|
17 |
|
|
|
18 |
__orbit-idl__ [[ ''options'' ] |
|
|
19 |
''file...'' |
|
|
20 |
!!DESCRIPTION |
|
|
21 |
|
|
|
22 |
|
|
|
23 |
__orbit-idl__ converts object interface descriptions |
|
|
24 |
written in CORBA IDL (Interface Definition Language) into C |
|
|
25 |
code that you can compile and link into your |
|
|
26 |
programs. |
|
|
27 |
!!OPTIONS |
|
|
28 |
|
|
|
29 |
|
|
|
30 |
__orbit-idl__ accepts the following options: |
|
|
31 |
|
|
|
32 |
|
|
|
33 |
__-d__ ''ARG''__ |
|
|
34 |
--debug=__''ARG'' |
|
|
35 |
|
|
|
36 |
|
|
|
37 |
Set the debug level. Supported levels are 0 to 4, default is |
|
|
38 |
2. |
|
|
39 |
|
|
|
40 |
|
|
|
41 |
__--skeleton-impl__ |
|
|
42 |
|
|
|
43 |
|
|
|
44 |
Generate a ''skeleton-impl'' file. |
|
|
45 |
|
|
|
46 |
|
|
|
47 |
__--nostubs__ |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
Do not create the ''stubs'' file. |
|
|
51 |
|
|
|
52 |
|
|
|
53 |
__--noskels__ |
|
|
54 |
|
|
|
55 |
|
|
|
56 |
Do not create the ''skels'' file. |
|
|
57 |
|
|
|
58 |
|
|
|
59 |
__--nocommon__ |
|
|
60 |
|
|
|
61 |
|
|
|
62 |
Do not create the ''common'' file. |
|
|
63 |
|
|
|
64 |
|
|
|
65 |
__--noheaders__ |
|
|
66 |
|
|
|
67 |
|
|
|
68 |
Do not create the ''headers'' file. |
|
|
69 |
|
|
|
70 |
|
|
|
71 |
__-D__ ''ARG''__ |
|
|
72 |
--define=__''ARG'' |
|
|
73 |
|
|
|
74 |
|
|
|
75 |
Define name for preprocessor. |
|
|
76 |
|
|
|
77 |
|
|
|
78 |
__-I__ ''PATH''__ |
|
|
79 |
--include=__''PATH'' |
|
|
80 |
|
|
|
81 |
|
|
|
82 |
Add search path for include files. |
|
|
83 |
|
|
|
84 |
|
|
|
85 |
__--c-output-formatter=__''PROGRAM'' |
|
|
86 |
|
|
|
87 |
|
|
|
88 |
Define the program to use for formatting the compiler |
|
|
89 |
output; defaults to indent(1). |
|
|
90 |
|
|
|
91 |
|
|
|
92 |
__-l__ ''ARG''__ |
|
|
93 |
--lang=__''ARG'' |
|
|
94 |
|
|
|
95 |
|
|
|
96 |
Specify the output language. The default is C. Support for |
|
|
97 |
languages other than C requires the installation of a |
|
|
98 |
backend for that language. |
|
|
99 |
|
|
|
100 |
|
|
|
101 |
__--backenddir=__''DIR'' |
|
|
102 |
|
|
|
103 |
|
|
|
104 |
Specify the directory where a language backend is stored |
|
|
105 |
(not necessary if backend is stored in the default |
|
|
106 |
directory, /usr/lib/orbit-idl.) |
|
|
107 |
|
|
|
108 |
|
|
|
109 |
__--usage__ |
|
|
110 |
|
|
|
111 |
|
|
|
112 |
Print a very brief usage summary. |
|
|
113 |
|
|
|
114 |
|
|
|
115 |
__-? |
|
|
116 |
--help__ |
|
|
117 |
|
|
|
118 |
|
|
|
119 |
Print a slightly more detailed usage summary. |
|
|
120 |
!!COMPILING |
|
|
121 |
|
|
|
122 |
|
|
|
123 |
The IDL file(s) compiled by __orbit-idl__ define the |
|
|
124 |
interfaces to network-transparent objects. These files are |
|
|
125 |
first passed to cpp(1), the C Preprocessor, then the result |
|
|
126 |
is parsed, and the C code is generated. |
|
|
127 |
|
|
|
128 |
|
|
|
129 |
By default, __orbit-idl__ generates four files, the |
|
|
130 |
''stubs'', ''skels'', ''common'', and ''header'' |
|
|
131 |
files. If your input file is named __sample.idl__, then |
|
|
132 |
the output files will be named, respectively, |
|
|
133 |
__sample-stubs.c__, __sample-skels.c__, |
|
|
134 |
__sample-common.c__, and __sample.h__. You can |
|
|
135 |
optionally also generate a ''skeleton-impl'' file (which |
|
|
136 |
would be named __sample-skelimpl.c__ in our example). |
|
|
137 |
This file requires manual editing to be useful, and is |
|
|
138 |
therefore not generated by default. |
|
|
139 |
|
|
|
140 |
|
|
|
141 |
The generated C files are formatting |
|
|
142 |
( |
|
|
143 |
!!SEE ALSO |
|
|
144 |
|
|
|
145 |
|
|
|
146 |
orbit-config(1), cpp(1), indent(1), |
|
|
147 |
/usr/share/doc/liborbit-dev, |
|
|
148 |
http://orbit-resource.sourceforge.net, |
|
|
149 |
http://www.omg.org. |
|
|
150 |
!!AUTHOR |
|
|
151 |
|
|
|
152 |
|
|
|
153 |
Copyright 2001, 2002 Dick Porter |
|
|
154 |
|
|
|
155 |
|
|
|
156 |
This manual was originally written for orbit-idl by Chris |
|
|
157 |
Waters |
|
|
158 |
---- |