=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/rpcgen/rpcgen.1,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- src/usr.bin/rpcgen/rpcgen.1 1996/06/26 05:38:42 1.3 +++ src/usr.bin/rpcgen/rpcgen.1 1998/09/27 16:57:51 1.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rpcgen.1,v 1.3 1996/06/26 05:38:42 deraadt Exp $ +.\" $OpenBSD: rpcgen.1,v 1.4 1998/09/27 16:57:51 aaron Exp $ .\" $NetBSD: rpcgen.1,v 1.5.2.1 1995/12/05 02:51:02 jtc Exp $ .\" from: @(#)rpcgen.new.1 1.1 90/11/09 TIRPC 1.0; from 40.10 of 10/10/89 .\" Copyright (c) 1988,1990 Sun Microsystems, Inc. - All Rights Reserved. @@ -114,7 +114,7 @@ it backgrounds itself by default. A special define symbol .Dv RPC_SVC_FG -can be used to run the server process in foreground. +can be used to run the server process in the foreground. .P The second synopsis provides special features which allow for the creation of more sophisticated @@ -172,40 +172,35 @@ The C preprocessor, .Xr cpp 1 is run on the input file before it is actually interpreted by -.Nm rpcgen +.Nm rpcgen . For each type of output file, .Nm rpcgen defines a special preprocessor symbol for use by the .Nm rpcgen programmer: .Pp -.PD 0 -.TP 12 -.Dv RPC_HDR -defined when compiling into header files -.TP -.Dv RPC_XDR -defined when compiling into +.Bl -tag -width RPC_CLNT -compact +.It Dv RPC_HDR +Defined when compiling into header files. +.It Dv RPC_XDR +Defined when compiling into .Tn XDR -routines -.TP -.Dv RPC_SVC -defined when compiling into server-side stubs -.TP -.Dv RPC_CLNT -defined when compiling into client-side stubs -.TP -.Dv RPC_TBL -defined when compiling into +routines. +.It Dv RPC_SVC +Defined when compiling into server-side stubs. +.It Dv RPC_CLNT +Defined when compiling into client-side stubs. +.It Dv RPC_TBL +Defined when compiling into .Tn RPC -dispatch tables -.PD +dispatch tables. +.El .Pp Any line beginning with .Sq % is passed directly into the output file, uninterpreted by -.Nm rpcgen +.Nm rpcgen . .Pp For every data type referred to in .Ar infile @@ -228,7 +223,7 @@ .It Fl b This generates code for the .Tn SunOS4.1 -style of rpc. This is the default. +style of RPC. This is the default. .It Fl c Compile into .Tn XDR @@ -297,7 +292,7 @@ .It Fl n Ar netid Compile into server-side stubs for the transport specified by -.Ar netid. +.Ar netid . There should be an entry for .Ar netid in the @@ -305,11 +300,15 @@ This option may be specified more than once, so as to compile a server that serves multiple transports. .It Fl N -Use the newstyle of rpcgen. This allows procedures to have multiple arguments. +Use the newstyle of +.Nm rpcgen . +This allows procedures to have multiple arguments. It also uses the style of parameter passing that closely resembles C. So, when passing an argument to a remote procedure you do not have to pass a pointer to the argument but the argument itself. This behaviour is different from the oldstyle -of rpcgen generated code. The newstyle is not the default case because of +of +.Nm rpcgen +generated code. The newstyle is not the default case because of backward compatibility. .It Fl o Ar outfile Specify the name of the output file. @@ -319,19 +318,19 @@ .Fl c Fl h Fl l .Fl m Fl n Fl s modes only -.Pc +.Pc . .It Fl s Ar nettype Compile into server-side stubs for all the transports belonging to the class .Ar nettype . The supported classes are -.Em netpath, -.Em visible, -.Em circuit_n, -.Em circuit_v, -.Em datagram_n, -.Em datagram_v, -.Em tcp, +.Em netpath , +.Em visible , +.Em circuit_n , +.Em circuit_v , +.Em datagram_n , +.Em datagram_v , +.Em tcp , and .Em udp [see @@ -348,7 +347,8 @@ the transports are chosen at run time and not at compile time. .It Fl S\&c Generate sample code to show the use of remote procedure and how to bind -to the server before calling the client side stubs generated by rpcgen. +to the server before calling the client side stubs generated by +.Nm rpcgen . .It Fl S\&s Generate skeleton code for the remote procedures on the server side. You would need to fill in the actual code for the remote procedures. @@ -398,7 +398,6 @@ .Em netid and hence is very site specific. .Sh EXAMPLE -.Pp The command .Pp .Bd -literal -offset indent @@ -414,7 +413,7 @@ .Pa prot_tbl.i . .Pp The following example sends the C data-definitions (header file) -to standard output. +to standard output: .Pp .Bd -literal -offset indent $ rpcgen -h prot.x