blob: 5bffe9a771a03387e22f65d61947ad779ab406a1 (
plain) (
blame)
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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE comref SYSTEM "comref.dtd" [
<!ENTITY dictionary
'<seealso marker="diameter_dict">dictionary file</seealso>'>
<!ENTITY % also SYSTEM "seealso.ent" >
<!ENTITY % here SYSTEM "seehere.ent" >
%also;
%here;
]>
<comref>
<header>
<copyright>
<year>2011</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
The program may be used and/or copied only with the written permission
from Ericsson AB, or in accordance with the terms and conditions
stipulated in the agreement/contract under which the program has been
supplied.
</legalnotice>
<title>diameterc(1)</title>
<prepared></prepared>
<docno></docno>
<date></date>
<rev></rev>
<file>diameterc.xml</file>
</header>
<com>diameterc</com>
<comsummary><![CDATA[diameterc [<options>] <file>]]></comsummary>
<description>
<p>
The diameterc utility is used to compile a diameter
&dictionary; into Erlang source.
The resulting source implements the interface diameter required
to encode and decode the dictionary's messages and AVPs.</p>
<p>
The module &man_make; provides an alternate compilation interface.</p>
</description>
<section>
<title>USAGE</title>
<taglist>
<tag><![CDATA[diameterc [<options>] <file>]]></tag>
<item>
<p>
Compile a single dictionary file to Erlang source.
Valid options are as follows.</p>
<taglist>
<tag><![CDATA[-i <dir>]]></tag>
<item>
<p>
Prepend the specified directory to the code path.
Use to point at beam files compiled from inherited dictionaries,
<c>&dict_inherits;</c> in a dictionary file creating a beam
dependency, not an erl/hrl dependency.</p>
<p>
Multiple <c>-i</c> options can be specified.</p>
</item>
<tag><![CDATA[-o <dir>]]></tag>
<item>
<p>
Write generated source to the specified directory.
Defaults to the current working directory.</p>
</item>
<tag><![CDATA[-E]]></tag>
<tag><![CDATA[-H]]></tag>
<item>
<p>
Suppress erl and hrl generation, respectively.</p>
</item>
<tag><![CDATA[--name <name>]]></tag>
<tag><![CDATA[--prefix <prefix>]]></tag>
<item>
<p>
Transform the input dictionary before compilation, setting
<c>&dict_name;</c> or <c>&dict_prefix;</c> to the specified
string.</p>
</item>
<tag><![CDATA[--inherits <arg>]]></tag>
<item>
<p>
Transform the input dictionary before compilation, appending
<c>&dict_inherits;</c> of the specified string.</p>
<p>
Two forms of <c>--inherits</c> have special meaning:</p>
<pre>
--inherits -
--inherits Prev/Mod
</pre>
<p>
The first has the effect of clearing any previous inherits, the second
of replacing a previous inherits of <c>Prev</c> to one of <c>Mod</c>.
This allows the semantics of the input dictionary to be changed without
modifying the file itself.</p>
<p>
Multiple <c>--inherits</c> options can be specified.</p>
</item>
</taglist>
</item>
</taglist>
</section>
<!-- ===================================================================== -->
<section>
<title>EXIT STATUS</title>
<p>
Returns 0 on success, non-zero on failure.</p>
</section>
<!-- ===================================================================== -->
<section>
<title>SEE ALSO</title>
<p>
&man_make;, &man_dict;</p>
</section>
</comref>
|
