Merged revisions 1884-1905 via svnmerge from
[scons.git] / src / engine / SCons / Tool / rpcgen.xml
1 <!--
2 __COPYRIGHT__
3
4 This file is processed by the bin/SConsDoc.py module.
5 See its __doc__ string for a discussion of the format.
6 -->
7 <tool name="rpcgen">
8 <summary>
9 Sets construction variables for building with RPCGEN.
10 </summary>
11 <sets>
12 RPCGEN
13 RPCGENFLAGS
14 RPCGENCLIENTFLAGS
15 RPCGENHEADERFLAGS
16 RPCGENSERVICEFLAGS
17 RPCGENXDRFLAGS
18 </sets>
19 <uses>
20 </uses>
21 </tool>
22
23 <builder name="RPCGenClient">
24 <summary>
25 Generates an RPC client stub (<filename>_clnt.c</filename>) file
26 from a specified RPC (<filename>.x</filename>) source file.
27 Because rpcgen only builds output files
28 in the local directory,
29 the command will be executed
30 in the source file's directory by default.
31
32 <example>
33 # Builds src/rpcif_clnt.c
34 env.RPCGenClient('src/rpcif.x')
35 </example>
36 </summary>
37 </builder>
38
39 <builder name="RPCGenHeader">
40 <summary>
41 Generates an RPC header (<filename>.h</filename>) file
42 from a specified RPC (<filename>.x</filename>) source file.
43 Because rpcgen only builds output files
44 in the local directory,
45 the command will be executed
46 in the source file's directory by default.
47
48 <example>
49 # Builds src/rpcif.h
50 env.RPCGenHeader('src/rpcif.x')
51 </example>
52 </summary>
53 </builder>
54
55 <builder name="RPCGenService">
56 <summary>
57 Generates an RPC server-skeleton (<filename>_svc.c</filename>) file
58 from a specified RPC (<filename>.x</filename>) source file.
59 Because rpcgen only builds output files
60 in the local directory,
61 the command will be executed
62 in the source file's directory by default.
63
64 <example>
65 # Builds src/rpcif_svc.c
66 env.RPCGenClient('src/rpcif.x')
67 </example>
68 </summary>
69 </builder>
70
71 <builder name="RPCGenXDR">
72 <summary>
73 Generates an RPC XDR routine (<filename>_xdr.c</filename>) file
74 from a specified RPC (<filename>.x</filename>) source file.
75 Because rpcgen only builds output files
76 in the local directory,
77 the command will be executed
78 in the source file's directory by default.
79
80 <example>
81 # Builds src/rpcif_xdr.c
82 env.RPCGenClient('src/rpcif.x')
83 </example>
84 </summary>
85 </builder>
86
87 <cvar name="RPCGEN">
88 <summary>
89 The RPC protocol compiler.
90 </summary>
91 </cvar>
92
93 <cvar name="RPCGENCLIENTFLAGS">
94 <summary>
95 Options passed to the RPC protocol compiler
96 when generating client side stubs.
97 These are in addition to any flags specified in the
98 &cv-link-RPCGENFLAGS;
99 construction variable.
100 </summary>
101 </cvar>
102
103 <cvar name="RPCGENFLAGS">
104 <summary>
105 General options passed to the RPC protocol compiler.
106 </summary>
107 </cvar>
108
109 <cvar name="RPCGENHEADERFLAGS">
110 <summary>
111 Options passed to the RPC protocol compiler
112 when generating a header file.
113 These are in addition to any flags specified in the
114 &cv-link-RPCGENFLAGS;
115 construction variable.
116 </summary>
117 </cvar>
118
119 <cvar name="RPCGENSERVICEFLAGS">
120 <summary>
121 Options passed to the RPC protocol compiler
122 when generating server side stubs.
123 These are in addition to any flags specified in the
124 &cv-link-RPCGENFLAGS;
125 construction variable.
126 </summary>
127 </cvar>
128
129 <cvar name="RPCGENXDRFLAGS">
130 <summary>
131 Options passed to the RPC protocol compiler
132 when generating XDR routines.
133 These are in addition to any flags specified in the
134 &cv-link-RPCGENFLAGS;
135 construction variable.
136 </summary>
137 </cvar>