=for html
<div class="synopsis">
-B<rxgen> [B<-h> | B<-c> | B<-C> | B<-S> | B<-r>] [B<-dkpR>]
+B<rxgen> [B<-h> | B<-c> | B<-C> | B<-S> | B<-r>] [B<-dkp>]
[B<-I> I<dir>] [B<-P> I<prefix>] [B<-o> I<outfile>] [I<infile>]
-B<rxgen> B<-s> I<transport> [B<-o> I<outfile>] [I<infile>]
-
-B<rxgen> B<-l> [B<-o> I<outfile>] [I<infile>]
-
-B<rxgen> B<-m> [B<-o> I<outfile>] [I<infile>]
-
=for html
</div>
it takes as input a description of an application interface similar to C
and produces a number of server and/or client stub routines to be linked
with RPC-based programs. These stubs allow programs to invoke remote
-procedures through local procedure calls. B<rxgen> is an extension of
-Sun's B<rpcgen> (version 3.9) and retains full B<rpcgen> functionality (at
-least as of that version). Please refer to rpcgen(1) for more details on
-the Sun's RPC specific flags, and to the RPC programming guide regarding
-the RPC language along with useful examples.
+procedures through local procedure calls. B<rxgen> is based on Sun's
+B<rpcgen> (version 3.9) but does not maintain compatibility with rpcgen
+RPC descriptions.
=head1 OPTIONS
=over 4
-=item B<-R>
-
-Generate code for the older \R protocol, as opposed to Rx, which is the
-default.
-
=item B<-k>
Must be specified when the generated code is intended to be used by the
=back
-The B<-s>, B<-l>, and B<-m> options are present only for B<rpcgen>
-support. See rpcgen(1) for information on their use.
-
=head1 B<rxgen> SYNTAX SUMMARY
Specification file:
In addition, B<rxgen> does a little preprocessing of its own. Any line
beginning with C<%> is passed directly into the output file, uninterpreted
by B<rxgen>. For a more heavy en masse dumping of uninterpreted code, it
-would be adviced to include all such code in an C<#include> file and pass
+would be advised to include all such code in an C<#include> file and pass
it in preceded by C<%>. The input interface may also contain any C-style
comments which are, of course, ignored. Interpretation is token-based,
thus special line-orientation of separate statements is not necessary.
stack will grow linearly with respect to the number of nodes in the list
(so it's wise to increase the Rx LWP stack if huge amounts of data are
expected back -- default stack size is 4K). The advantages should
-outweight the disadvantages here.
+outweigh the disadvantages here.
It's important to pay attention to the comments of the three array
examples above particularly when they're references to when the user
OUT long *nentries,
OUT vldb_list *linkedentries) = VLLINKEDLIST;
-We'll concentrate only on the Rx generated code since the R generated code
-(B<-R> option) will soon be obsolete. For a detailed description on the
-Rx-related calls inside the generated stubs (i.e., rx_NewCall(),
-rx_EndCall()), along with details on what happens inside certain calls
-(like xdrrx_create()) please refer to the Rx documentation. Typing C<rxgen
-vldbint.xg> will result in the creation of four files: F<vldbint.h>,
-F<vldbint.xdr.c>, F<vldbint.cs.c> and F<vldbint.ss.c>. A closer look at
-these files follows.
+For a detailed description on the Rx-related calls inside the generated
+stubs (i.e., rx_NewCall(), rx_EndCall()), along with details on what happens
+inside certain calls (like xdrrx_create()) please refer to the Rx
+documentation. Typing C<rxgen vldbint.xg> will result in the creation of
+four files: F<vldbint.h>, F<vldbint.xdr.c>, F<vldbint.cs.c> and
+F<vldbint.ss.c>. A closer look at these files follows.
=head3 Header file (F<vldbint.h>)
=head1 NOTES
-B<rxgen> is implemented from Sun's B<rpcgen> utility. All of the standard
-B<rpcgen>'s functionality is fully maintained. Note that some active
-B<rpcgen> options that don't apply to B<rxgen>'s purpose aren't referenced
-here (i.e., B<-s>, B<-l>, B<-m> options) and the interested reader should
-refer to rpcgen(1) for details.
+B<rxgen> is implemented from Sun's B<rpcgen> utility.
When the C<%#include <include file>> feature is used make sure that you
don't have any B<rxgen> language features (i.e. %#defines) since you'll
git://git.openafs.org / openafs.git / blobdiff