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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "Tom">
<!ENTITY dhsurname "Lee">
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
<!ENTITY dhusername "&dhfirstname; &dhsurname;">
<!ENTITY dhemail "debian@tomlee.co">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1) and
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
<!ENTITY dhsection "1">
<!-- TITLE should be something like "User commands" or similar (see
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
<!ENTITY dhtitle "capnp User Manual">
<!ENTITY dhucpackage "CAPNPROTO">
<!ENTITY dhpackage "capnp">
]>
<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<authorgroup>
<author>
<firstname>&dhfirstname;</firstname>
<surname>&dhsurname;</surname>
<contrib>Wrote this manpage for the Debian system.</contrib>
<address>
<email>&dhemail;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2013</year>
<holder>&dhusername;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the Debian system
(and may be used by others).</para>
<para>Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License,
Version 2 or (at your option) any later version published by
the Free Software Foundation.</para>
<para>On Debian systems, the complete text of the GNU General Public
License can be found in
<filename>/usr/share/common-licenses/GPL</filename>.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&dhucpackage;</refentrytitle>
<manvolnum>&dhsection;</manvolnum>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>compiler for Cap'n Proto data interchange format definition files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="opt"><replaceable><options></replaceable></arg>
<arg choice="plain"><replaceable><command></replaceable></arg>
<arg choice="opt"><replaceable><args></replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="plain">id</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&dhpackage;</command>
<group choice="opt">
<arg choice="plain"><option>--help</option></arg>
<arg choice="plain"><option>--version</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
<para>It was written for the Debian distribution
because the original program does not have a manual page.</para>
<para><command>&dhpackage;</command> is wrapper for various tools
used to manipulate the Cap'n Proto data interchange format.
These tools include a definition file compiler, a C++ backend, a
decoder for converting Cap'n Proto messages to text and a
generator for Cap'n Proto definition IDs.</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
<para>The program follows the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>-I<replaceable>DIR</replaceable></option></term>
<term>
<option>--import-path<replaceable>DIR</replaceable></option>
</term>
<listitem>
<para>
Add DIR to the list of directories searched for non-relative
imports (ones that start with a '/').
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-standard-import</option></term>
<listitem>
<para>
Do not add any default import paths; use only those specified by
-I. Otherwise, typically /usr/include and /usr/local/include are
added by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
<listitem>
<para>
Log informational messages to stderr; useful for debugging.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="commands">
<title>COMMANDS</title>
<refsect2 id="compile_command">
<title>compile</title>
<para>Compile Cap'n Proto schema files & generate corresponding
source code in one or more languages.
</para>
<refsect3 id="compile_command_options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-I<replaceable><dir></replaceable></option></term>
<term><option>--import-path=<replaceable><dir></replaceable></option></term>
<listitem>
<para>
<![CDATA[
Add <dir> to the list of directories searched for non-relative imports
(ones that start with a '/').
]]>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-standard-import</option></term>
<listitem>
<para>
<![CDATA[
Do not add any default import paths; use only those specified by -I.
Otherwise, typically /usr/include and /usr/local/include are added by
default.
]]>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o<replaceable>lang[:<replaceable>dir</replaceable>]</replaceable></option></term>
<term><option>--output=<replaceable>lang[:<replaceable>dir</replaceable>]</replaceable></option></term>
<listitem>
<para>
<![CDATA[
Generate source code for language <lang> in directory <dir> (default:
current directory). <lang> actually specifies a plugin to use. If
<lang> is a simple word, the compiler for a plugin called
'capnpc-<lang>' in $PATH. If <lang> is a file path containing slashes,
it is interpreted as the exact plugin executable file name, and $PATH is
not searched.
]]>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--src-prefix=<replaceable><prefix></replaceable></option></term>
<listitem>
<para>
<![CDATA[
If a file specified for compilation starts with <prefix>, remove the
prefix for the purpose of deciding the names of output files. For
example, the following command:
capnp --src-prefix=foo/bar -oc++:corge foo/bar/baz/qux.capnp
would generate the files corge/baz/qux.capnp.{h,c++}.
]]>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="decode_command">
<title>decode</title>
<para>
Decodes one or more encoded Cap'n Proto messages as text.
Messages are read from standard input and by default are expected
to be in standard Cap'n Proto serialization format.
</para>
<refsect3 id="decode_command_options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-I<replaceable><dir></replaceable></option></term>
<term><option>--import-path=<replaceable><dir></replaceable></option></term>
<listitem>
<para>
Add <dir> to the list of directories searched for
non-relative imports (ones that start with a '/').
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<term><option>--flat</option></term>
<listitem>
<para>
Interpret the input as one large single-segment message rather than a
stream in standard serialization format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-standard-import</option></term>
<listitem>
<para>
Do not add any default import paths; use only those specified by -I.
Otherwise, typically /usr/include and /usr/local/include are added by
default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--packed</option></term>
<listitem>
<para>
Expect the input to be packed using standard Cap'n Proto packing, which
deflates zero-valued bytes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--short</option></term>
<listitem>
<para>
Print in short (non-pretty) format. Each message will be printed on one
line, without using whitespace to improve readability.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="id_command">
<title>id</title>
<para>
Generates a unique identifier for Cap'n Proto schema files.
</para>
</refsect2>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<para>
More documentation about Cap'n Proto is available online at
<ulink url="http://capnproto.org" />.
</para>
</refsect1>
</refentry>
|
