1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
<!ENTITY debian "Debian GNU/Linux">
<!ENTITY dhprg "<command>camlidl</command>">
]>
<!--**********************************************************************-->
<!-- Camlidl manpage -->
<!-- -->
<!-- Copyright (C) 2006 Sylvain Le Gall <gildor@debian.org> -->
<!-- Copyright (C) 2001-2006 Georges Mariano <georges.mariano@inrets.fr> -->
<!-- -->
<!-- This library is free software; you can redistribute it and/or -->
<!-- modify it under the terms of the GNU Lesser General Public -->
<!-- License as published by the Free Software Foundation; either -->
<!-- version 2.1 of the License, or (at your option) any later version; -->
<!-- with the OCaml static compilation exception. -->
<!-- -->
<!-- This library is distributed in the hope that it will be useful, -->
<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of -->
<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -->
<!-- Lesser General Public License for more details. -->
<!-- -->
<!-- You should have received a copy of the GNU Lesser General Public -->
<!-- License along with this library; if not, write to the Free Software -->
<!-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, -->
<!-- MA 02110-1301, USA. -->
<!-- -->
<!-- Contact: gildor@debian.org -->
<!--**********************************************************************-->
<refentry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
<refmeta>
<refentrytitle>CAMLIDL</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>camlidl</refname>
<refpurpose>A stub code generator for OCaml</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
&dhprg;
<arg>-I <replaceable>dir</replaceable></arg>
<arg>-D <replaceable>symbol</replaceable></arg>
<arg>-cpp</arg>
<arg>-nocpp</arg>
<arg>-prepro <replaceable>cmd</replaceable></arg>
<arg>-header</arg>
<arg>-no-include</arg>
<arg>-prefix-all-labels</arg>
<arg>-keep-labels</arg>
<arg>-help</arg>
<group>
<arg>-v</arg>
<arg>--version</arg>
</group>
<arg rep="repeat">
<replaceable>file.idl</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the &dhprg; command.</para>
<para>This manual page was written for the &debian; distribution because
the original program does not have a manual page.</para>
<para>&dhprg; is a program that generates stub code for interfacing Caml with
C from an IDL description of the C functions.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>A summary of options is included below.</para>
<para>Options for &dhprg;</para>
<variablelist>
<varlistentry>
<term>
<option>-I <replaceable>dir</replaceable></option>
</term>
<listitem>
<para>Add directory to search path.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-D <replaceable>symbol</replaceable></option>
</term>
<listitem>
<para>Pass <option>-D<replaceable>symbol</replaceable></option>
to the C preprocessor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-cpp</option>
</term>
<listitem>
<para>Pass the <filename>.idl</filename> files through the
C preprocessor. This is the default behavior.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-nocpp</option>
</term>
<listitem>
<para>Do not pass the <filename>.idl</filename> files through the
C preprocessor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-prepro <replaceable>cmd</replaceable></option>
</term>
<listitem>
<para>Use <command>cmd</command> as the preprocessor instead of
the C preprocessor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-header</option>
</term>
<listitem>
<para>Generate a <filename>.h</filename> file containing all type
definitions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-no-include</option>
</term>
<listitem>
<para>Do not #include the <filename>.h</filename> file in the
generated <filename>.c</filename> file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-prefix-all-labels</option>
</term>
<listitem>
<para>Prefix all ML name of record labels with name of enclosing
struct.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-keep-labels</option>
</term>
<listitem>
<para>Do not prefix ML names of record labels, even if ambiguous.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-v</option>
</term>
<term>
<option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<filename>file.idl</filename>
</term>
<listitem>
<para>Files to process.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="license.xml"/>
</refentry>
|
