aboutsummaryrefslogtreecommitdiffstats
path: root/lib/diameter/doc/src/diameter_compile.xml
blob: 72bac30709fee4e62327af7eeb688a194deba122 (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
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE comref SYSTEM "comref.dtd">

<comref>
<header>
<copyright>
<year>2011</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>diameter_compile.xml</file>
</header>

<com>diameterc</com>
<comsummary><![CDATA[diameterc [<options>] <file>]]></comsummary>

<description>

<p>
The diameterc utility is used to transform diameter
<seealso marker="diameter_dict">dictionary files</seealso>
into Erlang source.
The resulting source implements the interface diameter requires
to encode and decode the dictionary's messages and AVP's.</p>

</description>

<section>
<title>USAGE</title>

<taglist>

<tag><![CDATA[diameterc [<options>] <file>]]></tag>
<item>
<p>
Transforms a single dictionary file. Valid options are as follows.</p>

<!-- Leave -h/d/v undocumented, except for the usage message from the
     utility itself. -->

<taglist>
<tag><![CDATA[-o <dir>]]></tag>
<item>
<p>
Specifies the directory into which the generated source should be written.
Defaults to the current working directory.</p>
</item>

<tag><![CDATA[-i <dir>]]></tag>
<item>
<p>
Specifies a directory to add to the code path.
Typically used to point at beam files corresponding to dictionaries
included by the one being compiled (using the <c>@includes</c> directive):
inclusion is a beam dependency, not an erl/hrl dependency.</p>

<p>
Multiple <c>-i</c> options can be specified.</p>
</item>

<tag><![CDATA[-E]]></tag>
<item>
<p>
Supresses erl generation.</p>
</item>

<tag><![CDATA[-H]]></tag>
<item>
<p>
Supresses hrl generation.</p>
</item>

</taglist>

</item>
</taglist>

</section>

<!-- ===================================================================== -->

<section>
<title>EXIT STATUS</title>

<p>
Returns 0 on success, non-zero on failure.</p>

</section>

<!-- ===================================================================== -->

<section>
<title>BUGS</title>

<p>
The identification of errors in the source file is poor.</p>

</section>

<!-- ===================================================================== -->

<section>
<title>SEE ALSO</title>

<p>
<seealso marker="diameter_dict">diameter_dict(4)</seealso></p>

</section>

</comref>