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 XXX
  10 </summary>
  11 </tool>
  12
  13 <builder name="RPCGenClient">
  14 <summary>
  15 Generates an RPC client stub (<filename>_clnt.c</filename>) file
  16 from a specified RPC (<filename>.x</filename>) source file.
  17 Because rpcgen only builds output files
  18 in the local directory,
  19 the command will be executed
  20 in the source file's directory by default.
  21
  22 <example>
  23 # Builds src/rpcif_clnt.c
  24 env.RPCGenClient('src/rpcif.x')
  25 </example>
  26 </summary>
  27 </builder>
  28
  29 <builder name="RPCGenHeader">
  30 <summary>
  31 Generates an RPC header (<filename>.h</filename>) file
  32 from a specified RPC (<filename>.x</filename>) source file.
  33 Because rpcgen only builds output files
  34 in the local directory,
  35 the command will be executed
  36 in the source file's directory by default.
  37
  38 <example>
  39 # Builds src/rpcif.h
  40 env.RPCGenHeader('src/rpcif.x')
  41 </example>
  42 </summary>
  43 </builder>
  44
  45 <builder name="RPCGenService">
  46 <summary>
  47 Generates an RPC server-skeleton (<filename>_svc.c</filename>) file
  48 from a specified RPC (<filename>.x</filename>) source file.
  49 Because rpcgen only builds output files
  50 in the local directory,
  51 the command will be executed
  52 in the source file's directory by default.
  53
  54 <example>
  55 # Builds src/rpcif_svc.c
  56 env.RPCGenClient('src/rpcif.x')
  57 </example>
  58 </summary>
  59 </builder>
  60
  61 <builder name="RPCGenXDR">
  62 <summary>
  63 Generates an RPC XDR routine (<filename>_xdr.c</filename>) file
  64 from a specified RPC (<filename>.x</filename>) source file.
  65 Because rpcgen only builds output files
  66 in the local directory,
  67 the command will be executed
  68 in the source file's directory by default.
  69
  70 <example>
  71 # Builds src/rpcif_xdr.c
  72 env.RPCGenClient('src/rpcif.x')
  73 </example>
  74 </summary>
  75 </builder>
  76
  77 <cvar name="RPCGEN">
  78 <summary>
  79 The RPC protocol compiler.
  80 </summary>
  81 </cvar>
  82
  83 <cvar name="RPCGENCLIENTFLAGS">
  84 <summary>
  85 Options passed to the RPC protocol compiler
  86 when generating client side stubs.
  87 These are in addition to any flags specified in the
  88 &cv-link-RPCGENFLAGS;
  89 construction variable.
  90 </summary>
  91 </cvar>
  92
  93 <cvar name="RPCGENFLAGS">
  94 <summary>
  95 General options passed to the RPC protocol compiler.
  96 </summary>
  97 </cvar>
  98
  99 <cvar name="RPCGENHEADERFLAGS">
 100 <summary>
 101 Options passed to the RPC protocol compiler
 102 when generating a header file.
 103 These are in addition to any flags specified in the
 104 &cv-link-RPCGENFLAGS;
 105 construction variable.
 106 </summary>
 107 </cvar>
 108
 109 <cvar name="RPCGENSERVICEFLAGS">
 110 <summary>
 111 Options passed to the RPC protocol compiler
 112 when generating server side stubs.
 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="RPCGENXDRFLAGS">
 120 <summary>
 121 Options passed to the RPC protocol compiler
 122 when generating XDR routines.
 123 These are in addition to any flags specified in the
 124 &cv-link-RPCGENFLAGS;
 125 construction variable.
 126 </summary>
 127 </cvar>