diff options
| author | wiz <wiz@NetBSD.org> | 2002-10-01 17:22:00 +0000 |
|---|---|---|
| committer | wiz <wiz@NetBSD.org> | 2002-10-01 17:22:00 +0000 |
| commit | 6569c5c50996a3ffc19fc4b63fa6d74cd573f4f3 (patch) | |
| tree | b640f9cbe5bf5ee4b28d53fc73216174300f972e /lib/libc/rpc | |
| parent | 45dfd29508988be493867313533f1d1c7652a81b (diff) | |
New sentence, new line. From Robert Elz.
Diffstat (limited to 'lib/libc/rpc')
| -rw-r--r-- | lib/libc/rpc/getnetpath.3 | 8 | ||||
| -rw-r--r-- | lib/libc/rpc/getrpcent.3 | 5 | ||||
| -rw-r--r-- | lib/libc/rpc/getrpcport.3 | 5 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_clnt_create.3 | 8 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_soc.3 | 179 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_svc_calls.3 | 12 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_svc_create.3 | 14 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_svc_reg.3 | 5 | ||||
| -rw-r--r-- | lib/libc/rpc/rpc_xdr.3 | 5 | ||||
| -rw-r--r-- | lib/libc/rpc/rpcbind.3 | 5 | ||||
| -rw-r--r-- | lib/libc/rpc/xdr.3 | 89 |
11 files changed, 182 insertions, 153 deletions
diff --git a/lib/libc/rpc/getnetpath.3 b/lib/libc/rpc/getnetpath.3 index badd382ed9e..4916cf0f5a7 100644 --- a/lib/libc/rpc/getnetpath.3 +++ b/lib/libc/rpc/getnetpath.3 @@ -1,5 +1,5 @@ .\" @(#)getnetpath.3n 1.26 93/05/07 SMI; from SVr4 -.\" $NetBSD: getnetpath.3,v 1.3 2002/02/07 07:00:23 ross Exp $ +.\" $NetBSD: getnetpath.3,v 1.4 2002/10/01 17:22:00 wiz Exp $ .\" Copyright 1989 AT&T .Dd April 22, 2000 .Dt GETNETPATH 3 @@ -59,7 +59,8 @@ NETPATH. .Fn setnetpath must be called before the first call to .Fn getnetpath -and may be called at any other time. It returns a handle that is used by +and may be called at any other time. +It returns a handle that is used by .Fn getnetpath . .Pp .Fn getnetpath @@ -113,7 +114,8 @@ See When first called, .Fn getnetpath returns a pointer to the netconfig database entry corresponding to the first -valid NETPATH component. When NETPATH has been exhausted, +valid NETPATH component. +When NETPATH has been exhausted, .Fn getnetpath returns NULL. .Sh SEE ALSO diff --git a/lib/libc/rpc/getrpcent.3 b/lib/libc/rpc/getrpcent.3 index 50c2294aa61..4b1f69de77e 100644 --- a/lib/libc/rpc/getrpcent.3 +++ b/lib/libc/rpc/getrpcent.3 @@ -1,5 +1,5 @@ .\" @(#)getrpcent.3n 2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI -.\" $NetBSD: getrpcent.3,v 1.9 2002/02/07 07:00:23 ross Exp $ +.\" $NetBSD: getrpcent.3,v 1.10 2002/10/01 17:22:01 wiz Exp $ .\" .Dd December 14, 1987 .Dt GETRPCENT 3 @@ -57,7 +57,8 @@ The rpc program number for this service. reads the next line of the file, opening the file if necessary. .Pp .Fn setrpcent -opens and rewinds the file. If the +opens and rewinds the file. +If the .Fa stayopen flag is non-zero, the net data base will not be closed after each call to diff --git a/lib/libc/rpc/getrpcport.3 b/lib/libc/rpc/getrpcport.3 index db3160b8002..65d96d2a395 100644 --- a/lib/libc/rpc/getrpcport.3 +++ b/lib/libc/rpc/getrpcport.3 @@ -1,5 +1,5 @@ .\" @(#)getrpcport.3r 2.2 88/08/02 4.0 RPCSRC; from 1.12 88/02/26 SMI -.\" $NetBSD: getrpcport.3,v 1.3 1998/02/05 18:49:08 perry Exp $ +.\" $NetBSD: getrpcport.3,v 1.4 2002/10/01 17:22:01 wiz Exp $ .\" .Dd October 6, 1987 .Dt GETRPCPORT 3 @@ -24,7 +24,8 @@ and using protocol .Fa proto . It returns 0 if it cannot contact the portmapper, or if .Fa prognum -is not registered. If +is not registered. +If .Fa prognum is registered but not with version .Fa versnum , diff --git a/lib/libc/rpc/rpc_clnt_create.3 b/lib/libc/rpc/rpc_clnt_create.3 index 82b5e6f36ec..23e2b0685ae 100644 --- a/lib/libc/rpc/rpc_clnt_create.3 +++ b/lib/libc/rpc/rpc_clnt_create.3 @@ -2,7 +2,7 @@ .\" Copyright 1989 AT&T .\" @(#)rpc_clnt_create 1.5 89/07/24 SMI; .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" $NetBSD: rpc_clnt_create.3,v 1.5 2002/02/07 07:00:23 ross Exp $ +.\" $NetBSD: rpc_clnt_create.3,v 1.6 2002/10/01 17:22:01 wiz Exp $ .Dd May 7, 1993 .Dt RPC_CLNT_CREATE 3 .Os @@ -324,7 +324,8 @@ If is .Dv NULL and it is connection-oriented, it is assumed that the file descriptor -is connected. For connectionless transports, if +is connected. +For connectionless transports, if .Fa svcaddr is ..Dv NULL , @@ -431,7 +432,8 @@ does not consult the remote rpcbind service for this information. .It struct rpc_createerr rpc_createerr; A global variable whose value is set by any RPC client handle creation routine -that fails. It is used by the routine +that fails. +It is used by the routine .Fn clnt_pcreateerror to print the reason for the failure. .El diff --git a/lib/libc/rpc/rpc_soc.3 b/lib/libc/rpc/rpc_soc.3 index 538d0c9a1a8..bf621ea04b3 100644 --- a/lib/libc/rpc/rpc_soc.3 +++ b/lib/libc/rpc/rpc_soc.3 @@ -1,5 +1,5 @@ .\" @(#)rpc.3n 2.4 88/08/08 4.0 RPCSRC; from 1.19 88/06/24 SMI -.\" $NetBSD: rpc_soc.3,v 1.5 2002/07/31 01:46:02 soren Exp $ +.\" $NetBSD: rpc_soc.3,v 1.6 2002/10/01 17:22:01 wiz Exp $ .\" .TH RPC_SOC 3 "16 February 1988" .SH NAME @@ -106,8 +106,8 @@ auth_destroy(auth) .IP A macro that destroys the authentication information associated with .IR auth . -Destruction usually involves deallocation of private data -structures. The use of +Destruction usually involves deallocation of private data structures. +The use of .I auth is undefined after calling .BR auth_destroy(\|) . @@ -125,8 +125,8 @@ authnone_create(\|) Create and returns an .SM RPC authentication handle that passes nonusable authentication -information with each remote procedure call. This is the -default authentication used by +information with each remote procedure call. +This is the default authentication used by .SM RPC. .if t .ne 10 .LP @@ -237,8 +237,8 @@ resultproc_t eachresult; Like .BR callrpc(\|) , except the call message is broadcast to all locally -connected broadcast nets. Each time it receives a -response, this routine calls +connected broadcast nets. +Each time it receives a response, this routine calls .BR eachresult(\|) , whose form is: .IP @@ -269,8 +269,8 @@ waits for more replies; otherwise it returns with appropriate status. .IP Warning: broadcast sockets are limited in size to the -maximum transfer unit of the data link. For ethernet, -this value is 1500 bytes. +maximum transfer unit of the data link. +For ethernet, this value is 1500 bytes. .br .if t .ne 13 .LP @@ -320,10 +320,12 @@ clnt_destroy(clnt) .IP A macro that destroys the client's .SM RPC -handle. Destruction usually involves deallocation +handle. +Destruction usually involves deallocation of private data structures, including .I clnt -itself. Use of +itself. +Use of .I clnt is undefined after calling .BR clnt_destroy(\|) . @@ -350,15 +352,16 @@ Generic client creation routine. identifies the name of the remote host where the server is located. .I proto -indicates which kind of transport protocol to use. The -currently supported values for this field are \(lqudp\(rq +indicates which kind of transport protocol to use. +The currently supported values for this field are \(lqudp\(rq and \(lqtcp\(rq. Default timeouts are set, but can be modified using .BR clnt_control(\|) . .IP Warning: Using .SM UDP -has its shortcomings. Since +has its shortcomings. +Since .SM UDP\s0-based .SM RPC messages can only hold up to 8 Kbytes of encoded data, @@ -382,7 +385,8 @@ about a client object. .I req indicates the type of operation, and .I info -is a pointer to the information. For both +is a pointer to the information. +For both .SM UDP and .SM TCP\s0, @@ -439,8 +443,8 @@ A macro that frees any data allocated by the .SM RPC/XDR system when it decoded the results of an .SM RPC -call. The -parameter +call. +The parameter .I out is the address of the results, and .I outproc @@ -648,7 +652,8 @@ This allows simulation of and acquisition of .SM RPC overheads, such as round trip times, without any -kernel interference. This routine returns +kernel interference. +This routine returns .SM NULL if it fails. .br @@ -674,8 +679,8 @@ version .IR versnum ; the client uses .SM TCP/IP -as a transport. The remote program is located at Internet -address +as a transport. +The remote program is located at Internet address .IR *addr . If .\"The following in-line font conversion is necessary for the hyphen indicator @@ -683,7 +688,8 @@ If is zero, then it is set to the actual port that the remote program is listening on (the remote .B portmap -service is consulted for this information). The parameter +service is consulted for this information). +The parameter .I sockp is a socket; if it is .BR \s-1RPC_ANYSOCK\s0 , @@ -726,15 +732,16 @@ version .IR versnum ; the client uses use .SM UDP/IP -as a transport. The remote program is located at Internet -address +as a transport. +The remote program is located at Internet address .IR addr . If \fB\%addr\-\*[Gt]sin_port\fR is zero, then it is set to actual port that the remote program is listening on (the remote .B portmap -service is consulted for this information). The parameter +service is consulted for this information). +The parameter .I sockp is a socket; if it is .BR \s-1RPC_ANYSOCK\s0 , @@ -744,8 +751,7 @@ The .SM UDP transport resends the call message in intervals of .B wait -time until a response is received or until the call times -out. +time until a response is received or until the call times out. The total time for the call to time out is specified by .BR clnt_call(\|) . .IP @@ -780,15 +786,16 @@ on .IR versnum ; the client uses use .SM UDP/IP -as a transport. The remote program is located at Internet -address +as a transport. +The remote program is located at Internet address .IR addr . If \fB\%addr\-\*[Gt]sin_port\fR is zero, then it is set to actual port that the remote program is listening on (the remote .B portmap -service is consulted for this information). The parameter +service is consulted for this information). +The parameter .I sockp is a socket; if it is .BR \s-1RPC_ANYSOCK\s0 , @@ -798,8 +805,7 @@ The .SM UDP transport resends the call message in intervals of .B wait -time until a response is received or until the call times -out. +time until a response is received or until the call times out. The total time for the call to time out is specified by .BR clnt_call(\|) . .IP @@ -885,12 +891,12 @@ is most likely or .BR \s-1IPPROTO_TCP\s0 . A return value of zero means that the mapping does not exist -or that -the +or that the .SM RPC system failured to contact the remote .B portmap -service. In the latter case, the global variable +service. +In the latter case, the global variable .B rpc_createerr(\|) contains the .SM RPC @@ -926,14 +932,12 @@ call on your behalf to a procedure on that host. The parameter .I *portp will be modified to the program's port number if the -procedure -succeeds. The definitions of other parameters are discussed -in +procedure succeeds. +The definitions of other parameters are discussed in .B callrpc(\|) and .BR clnt_call(\|) . -This procedure should be used for a \(lqping\(rq and nothing -else. +This procedure should be used for a \(lqping\(rq and nothing else. See also .BR clnt_broadcast(\|) . .br @@ -956,7 +960,8 @@ and .I port on the machine's .B portmap -service. The value of +service. +The value of .I protocol is most likely .B @@ -985,8 +990,8 @@ and .B ports on the machine's .B portmap -service. This routine returns one if it succeeds, zero -otherwise. +service. +This routine returns one if it succeeds, zero otherwise. .br .if t .ne 15 .LP @@ -1004,7 +1009,8 @@ Register procedure .I procname with the .SM RPC -service package. If a request arrives for program +service package. +If a request arrives for program .IR prognum , version .IR versnum , @@ -1039,8 +1045,8 @@ struct rpc_createerr rpc_createerr; .IP A global variable whose value is set by any .SM RPC -client creation routine -that does not succeed. Use the routine +client creation routine that does not succeed. +Use the routine .B clnt_pcreateerror(\|) to print the reason why. .if t .ne 7 @@ -1061,7 +1067,8 @@ service transport handle, Destruction usually involves deallocation of private data structures, including .I xprt -itself. Use of +itself. +Use of .I xprt is undefined after calling this routine. .br @@ -1080,7 +1087,8 @@ service side's read file descriptor bit mask; it is suitable as a parameter to the .B select -system call. This is only of interest +system call. +This is only of interest if a service implementor does not call .BR svc_run(\|) , but rather does his own asynchronous event processing. @@ -1101,8 +1109,8 @@ int svc_fds; .IP Similar to .BR svc_fedset(\|) , -but limited to 32 descriptors. This -interface is obsoleted by +but limited to 32 descriptors. +This interface is obsoleted by .BR svc_fdset(\|) . .br .if t .ne 9 @@ -1119,11 +1127,9 @@ char *in; .IP A macro that frees any data allocated by the .SM RPC/XDR -system when it decoded the arguments to a service procedure -using +system when it decoded the arguments to a service procedure using .BR svc_getargs(\|) . -This routine returns 1 if the results were successfully -freed, +This routine returns 1 if the results were successfully freed, and zero otherwise. .br .if t .ne 10 @@ -1140,8 +1146,7 @@ char *in; .IP A macro that decodes the arguments of an .SM RPC -request -associated with the +request associated with the .SM RPC service transport handle, .IR xprt . @@ -1152,8 +1157,7 @@ is the address where the arguments will be placed; is the .SM XDR routine used to decode the arguments. -This routine returns one if decoding succeeds, and zero -otherwise. +This routine returns one if decoding succeeds, and zero otherwise. .br .if t .ne 9 .LP @@ -1212,7 +1216,8 @@ int rdfds; .IP Similar to .BR svc_getreqset(\|) , -but limited to 32 descriptors. This interface is obsoleted by +but limited to 32 descriptors. +This interface is obsoleted by .BR svc_getreqset(\|) . .br .if t .ne 17 @@ -1238,7 +1243,8 @@ If .I protocol is zero, the service is not registered with the .B portmap -service. If +service. +If .I protocol is non-zero, then a mapping of the triple .RI [ prognum , versnum , protocol\fR] @@ -1281,12 +1287,14 @@ svc_run(\|) .fi .ft R .IP -This routine never returns. It waits for +This routine never returns. +It waits for .SM RPC requests to arrive, and calls the appropriate service procedure using .B svc_getreq(\|) -when one arrives. This procedure is usually waiting for a +when one arrives. +This procedure is usually waiting for a .B select(\|) system call to return. .br @@ -1305,7 +1313,8 @@ char *out; Called by an .SM RPC service's dispatch routine to send the results of a -remote procedure call. The parameter +remote procedure call. +The parameter .I xprt is the request's associated transport handle; .I outproc @@ -1360,7 +1369,8 @@ svcerr_decode(xprt) .ft R .IP Called by a service dispatch routine that cannot successfully -decode its parameters. See also +decode its parameters. +See also .BR svc_getargs(\|) . .br .if t .ne 7 @@ -1390,7 +1400,8 @@ svcerr_noprog(xprt) .IP Called when the desired program is not registered with the .SM RPC -package. Service implementors usually do not need this routine. +package. +Service implementors usually do not need this routine. .br .if t .ne 7 .LP @@ -1406,7 +1417,8 @@ svcerr_progvers(xprt) Called when the desired version of a program is not registered with the .SM RPC -package. Service implementors usually do not need this routine. +package. +Service implementors usually do not need this routine. .br .if t .ne 7 .LP @@ -1438,7 +1450,8 @@ svcerr_weakauth(xprt) .IP Called by a service dispatch routine that refuses to perform a remote procedure call due to insufficient -authentication parameters. The routine calls +authentication parameters. +The routine calls .BR "svcerr_auth(xprt, \s-1AUTH_TOOWEAK\s0)" . .br .if t .ne 11 @@ -1453,9 +1466,8 @@ svcraw_create(\|) .IP This routine creates a toy .SM RPC -service transport, to which it returns a pointer. The -transport -is really a buffer within the process's address space, +service transport, to which it returns a pointer. +The transport is really a buffer within the process's address space, so the corresponding .SM RPC client should live in the same @@ -1495,15 +1507,16 @@ which may be in which case a new socket is created. If the socket is not bound to a local .SM TCP -port, then this routine binds it to an arbitrary port. Upon -completion, +port, then this routine binds it to an arbitrary port. +Upon completion, \fB\%xprt\-\*[Gt]xp_sock\fR is the transport's socket descriptor, and \fB\%xprt\-\*[Gt]xp_port\fR is the transport's port number. This routine returns .SM NULL -if it fails. Since +if it fails. +Since .SM TCP\s0-based .SM RPC uses buffered @@ -1524,16 +1537,15 @@ u_int recvsize; .fi .ft R .IP -Create a service on top of any open descriptor. Typically, -this -descriptor is a connected socket for a stream protocol such -as +Create a service on top of any open descriptor. +Typically, this descriptor is a connected socket +for a stream protocol such as .SM TCP\s0. .I sendsize and .I recvsize -indicate sizes for the send and receive buffers. If they are -zero, a reasonable default is chosen. +indicate sizes for the send and receive buffers. +If they are zero, a reasonable default is chosen. .br .if t .ne 10 .LP @@ -1557,8 +1569,8 @@ which may be in which case a new socket is created. If the socket is not bound to a local .SM UDP -port, then this routine binds it to an arbitrary port. Upon -completion, +port, then this routine binds it to an arbitrary port. +Upon completion, \fB\%xprt\-\*[Gt]xp_sock\fR is the transport's socket descriptor, and \fB\%xprt\-\*[Gt]xp_port\fR @@ -1585,8 +1597,8 @@ struct accepted_reply *ar; .IP Used for encoding .SM RPC -reply messages. This routine is useful for users who -wish to generate +reply messages. +This routine is useful for users who wish to generate \s-1RPC\s0-style messages without using the .SM RPC @@ -1605,7 +1617,8 @@ struct authunix_parms *aupp; .IP Used for describing .SM UNIX -credentials. This routine is useful for users +credentials. +This routine is useful for users who wish to generate these credentials without using the .SM RPC authentication package. diff --git a/lib/libc/rpc/rpc_svc_calls.3 b/lib/libc/rpc/rpc_svc_calls.3 index 177af5ca084..c0f72636197 100644 --- a/lib/libc/rpc/rpc_svc_calls.3 +++ b/lib/libc/rpc/rpc_svc_calls.3 @@ -2,7 +2,7 @@ .\" Copyright 1989 AT&T .\" @(#)rpc_svc_calls 1.5 89/07/25 SMI; .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" $NetBSD: rpc_svc_calls.3,v 1.4 2002/02/07 07:00:23 ross Exp $ +.\" $NetBSD: rpc_svc_calls.3,v 1.5 2002/10/01 17:22:02 wiz Exp $ .Dd May 3, 1993 .Dt RPC_SVC_CALLS 3 .Os @@ -95,7 +95,8 @@ As currently implemented, .Fn svc_exit zeroes the .Dv svc_fdset -global variable. If RPC server activity is to be resumed, +global variable. +If RPC server activity is to be resumed, services must be reregistered with the RPC library either through one of the .Fn rpc_svc_create @@ -201,8 +202,8 @@ RPC service transport handle and thus not portable. This macro returns a pointer to a sockcred structure, defined in .Fd \*[Lt]sys/socket.h\*[Gt] , -identifying the calling client. This only works if the client is -calling the server over an +identifying the calling client. +This only works if the client is calling the server over an .Dv AF_LOCAL socket. .It Fa struct pollfd svc_pollset[FD_SETSIZE]; @@ -238,7 +239,8 @@ system call to return. .Pp .It Fn svc_sendreply Called by an RPC service's dispatch routine to send the results of a -remote procedure call. The parameter +remote procedure call. +The parameter .Fa xprt is the request's associated transport handle; .Fa outproc diff --git a/lib/libc/rpc/rpc_svc_create.3 b/lib/libc/rpc/rpc_svc_create.3 index b187f6cb944..2df71ad6e04 100644 --- a/lib/libc/rpc/rpc_svc_create.3 +++ b/lib/libc/rpc/rpc_svc_create.3 @@ -2,7 +2,7 @@ .\" Copyright 1989 AT&T .\" @(#)rpc_svc_create 1.3 89/06/28 SMI; .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" $NetBSD: rpc_svc_create.3,v 1.4 2002/02/07 07:00:24 ross Exp $ +.\" $NetBSD: rpc_svc_create.3,v 1.5 2002/10/01 17:22:02 wiz Exp $ .Dd May 3, 1993 .Dt RPC_SVC_CREATE 3 .Sh NAME @@ -74,8 +74,8 @@ an error will normally be returned. .Fa info -should be a pointer to an -integer. Upon successful completion of the +should be a pointer to an integer. +Upon successful completion of the .Dv SVCGET_VERSQUIET request, .Fa *info @@ -94,9 +94,8 @@ served by this server but the version number is outside the range registered with the server, an .Dv RPC_PROGVERSMISMATCH -error will normally -be returned. It is sometimes desirable to -change this behavior. +error will normally be returned. +It is sometimes desirable to change this behavior. .Fa info should be a pointer to an integer which is either 0 @@ -154,7 +153,8 @@ Destruction usually involves deallocation of private data structures, including .Fa xprt -itself. Use of +itself. +Use of .Fa xprt is undefined after calling this routine. .Pp diff --git a/lib/libc/rpc/rpc_svc_reg.3 b/lib/libc/rpc/rpc_svc_reg.3 index 991c796063f..cf3ea0b06db 100644 --- a/lib/libc/rpc/rpc_svc_reg.3 +++ b/lib/libc/rpc/rpc_svc_reg.3 @@ -2,7 +2,7 @@ .\" Copyright 1989 AT&T .\" @(#)rpc_svc_call 1.6 89/07/20 SMI; .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" $NetBSD: rpc_svc_reg.3,v 1.4 2002/02/07 07:00:24 ross Exp $ +.\" $NetBSD: rpc_svc_reg.3,v 1.5 2002/10/01 17:22:02 wiz Exp $ .Dd May 3, 1993 .Dt RPC_SVC_REG 3 .Sh NAME @@ -167,7 +167,8 @@ and -1 otherwise. After RPC service transport handle .Fa xprt is created, it is registered with the RPC -service package. This routine modifies the global variable +service package. +This routine modifies the global variable .Va svc_fdset (see .Xr rpc_svc_calls 3 ) . diff --git a/lib/libc/rpc/rpc_xdr.3 b/lib/libc/rpc/rpc_xdr.3 index ef41e7d2253..68b8c0487b2 100644 --- a/lib/libc/rpc/rpc_xdr.3 +++ b/lib/libc/rpc/rpc_xdr.3 @@ -2,7 +2,7 @@ .\" Copyright 1989 AT&T .\" @(#)rpc_xdr.new 1.1 89/04/06 SMI; .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. -.\" $NetBSD: rpc_xdr.3,v 1.4 2002/02/07 07:00:24 ross Exp $ +.\" $NetBSD: rpc_xdr.3,v 1.5 2002/10/01 17:22:02 wiz Exp $ .Dd May 3, 1993 .Dt RPC_XDR 3 .Os @@ -90,7 +90,8 @@ number mis-match or because of authentication errors. .Pp .It Fn xdr_replymsg Used for describing RPC -reply messages. It translates between the +reply messages. +It translates between the RPC reply message and its external representation. This reply could be either an acceptance, rejection or diff --git a/lib/libc/rpc/rpcbind.3 b/lib/libc/rpc/rpcbind.3 index d00e753c47c..156669d3120 100644 --- a/lib/libc/rpc/rpcbind.3 +++ b/lib/libc/rpc/rpcbind.3 @@ -1,7 +1,7 @@ .\" @(#)rpcbind.3n 1.25 93/05/07 SMI; from SVr4 .\" Copyright 1989 AT&T .\" Copyright (c) 1988 Sun Microsystem's, Inc. - All Right's Reserved. -.\" $NetBSD: rpcbind.3,v 1.5 2002/02/07 07:00:24 ross Exp $ +.\" $NetBSD: rpcbind.3,v 1.6 2002/10/01 17:22:02 wiz Exp $ .Dd May 7, 1993 .Dt RPCBIND 3 .Os @@ -68,7 +68,8 @@ The address found is returned in should be preallocated. This routine returns .Dv TRUE -if it succeeds. A return value of +if it succeeds. +A return value of .Dv FALSE means that the mapping does not exist or that the RPC diff --git a/lib/libc/rpc/xdr.3 b/lib/libc/rpc/xdr.3 index 3928eab0d2b..58411cdee9a 100644 --- a/lib/libc/rpc/xdr.3 +++ b/lib/libc/rpc/xdr.3 @@ -1,5 +1,5 @@ .\" @(#)xdr.3n 2.2 88/08/03 4.0 RPCSRC; from 1.16 88/03/14 SMI -.\" $NetBSD: xdr.3,v 1.6 2001/09/16 02:17:41 wiz Exp $ +.\" $NetBSD: xdr.3,v 1.7 2002/10/01 17:22:03 wiz Exp $ .\" .TH XDR 3 "16 February 1988" .SH NAME @@ -59,9 +59,8 @@ xdrproc_t elproc; .ft R .IP A filter primitive that translates between variable-length -arrays -and their corresponding external representations. The -parameter +arrays and their corresponding external representations. +The parameter .I arrp is the address of the pointer to the array, while .I sizep @@ -77,8 +76,7 @@ each of the array's elements, and is an .SM XDR filter that translates between -the array elements' C form, and their external -representation. +the array elements' C form, and their external representation. This routine returns one if it succeeds, zero otherwise. .br .if t .ne 8 @@ -94,7 +92,8 @@ bool_t *bp; .IP A filter primitive that translates between booleans (C integers) -and their external representations. When encoding data, this +and their external representations. +When encoding data, this filter produces values of either one or zero. This routine returns one if it succeeds, zero otherwise. .br @@ -114,8 +113,8 @@ A filter primitive that translates between counted byte strings and their external representations. The parameter .I sp -is the address of the string pointer. The length of the -string is located at address +is the address of the string pointer. +The length of the string is located at address .IR sizep ; strings cannot be longer than .IR maxsize . @@ -135,9 +134,8 @@ char *cp; A filter primitive that translates between C characters and their external representations. This routine returns one if it succeeds, zero otherwise. -Note: encoded characters are not packed, and occupy 4 bytes -each. For arrays of characters, it is worthwhile to -consider +Note: encoded characters are not packed, and occupy 4 bytes each. +For arrays of characters, it is worthwhile to consider .BR xdr_bytes(\|) , .B xdr_opaque(\|) or @@ -159,7 +157,8 @@ A macro that invokes the destroy routine associated with the stream, .IR xdrs . Destruction usually involves freeing private data structures -associated with the stream. Using +associated with the stream. +Using .I xdrs after invoking .B xdr_destroy(\|) @@ -225,11 +224,12 @@ char *objp; .fi .ft R .IP -Generic freeing routine. The first argument is the +Generic freeing routine. +The first argument is the .SM XDR -routine for the object being freed. The second argument -is a pointer to the object itself. Note: the pointer passed -to this routine is +routine for the object being freed. +The second argument is a pointer to the object itself. +Note: the pointer passed to this routine is .I not freed, but what it points to .I is @@ -379,7 +379,8 @@ a chunk of memory at location .I addr whose length is no more than .I size -bytes long. The +bytes long. +The .I op determines the direction of the .SM XDR @@ -431,7 +432,8 @@ execpt that it serializes .SM NULL pointers, whereas .B xdr_reference(\|) -does not. Thus, +does not. +Thus, .B xdr_pointer(\|) can represent recursive data structures, such as binary trees or @@ -458,17 +460,19 @@ stream object pointed to by The stream's data is written to a buffer of size .IR sendsize ; a value of zero indicates the system should use a suitable -default. The stream's data is read from a buffer of size +default. +The stream's data is read from a buffer of size .IR recvsize ; it too can be set to a suitable default by passing a zero value. When a stream's output buffer is full, .I writeit -is called. Similarly, when a stream's input buffer is empty, +is called. +Similarly, when a stream's input buffer is empty, .I readit -is called. The behavior of these two routines is similar to -the -system calls +is called. +The behavior of these two routines is similar to +the system calls .B read and .BR write , @@ -505,8 +509,8 @@ The data in the output buffer is marked as a completed record, and the output buffer is optionally written out if .I sendnow -is non-zero. This routine returns one if it succeeds, zero -otherwise. +is non-zero. +This routine returns one if it succeeds, zero otherwise. .br .if t .ne 8 .LP @@ -519,8 +523,7 @@ int empty; .fi .ft R .IP -This routine can be invoked only on -streams created by +This routine can be invoked only on streams created by .BR xdrrec_create(\|) . After consuming the rest of the current record in the stream, this routine returns one if the stream has no more input, @@ -536,8 +539,7 @@ xdrrec_skiprecord(xdrs) .fi .ft R .IP -This routine can be invoked only on -streams created by +This routine can be invoked only on streams created by .BR xdrrec_create(\|) . It tells the .SM XDR @@ -577,7 +579,8 @@ This routine returns one if it succeeds, zero otherwise. .IP Warning: this routine does not understand .SM NULL -pointers. Use +pointers. +Use .B xdr_pointer(\|) instead. .br @@ -683,8 +686,7 @@ u_int maxsize; .ft R .IP A filter primitive that translates between C strings and -their -corresponding external representations. +their corresponding external representations. Strings cannot be longer than .IR maxsize . Note: @@ -802,24 +804,27 @@ bool_t (*defaultarm) (\|); /* may equal \s-1NULL\s0 */ .IP A filter primitive that translates between a discriminated C .B union -and its corresponding external representation. It first -translates the discriminant of the union located at +and its corresponding external representation. +It first translates the discriminant of the union located at .IR dscmp . This discriminant is always an .BR enum_t . Next the union located at .I unp -is translated. The parameter +is translated. +The parameter .I choices is a pointer to an array of .B xdr_discrim(\|) -structures. Each structure contains an ordered pair of +structures. +Each structure contains an ordered pair of .RI [ value , proc ]. If the union's discriminant is equal to the associated .IR value , then the .I proc -is called to translate the union. The end of the +is called to translate the union. +The end of the .B xdr_discrim(\|) structure array is denoted by a routine of value .SM NULL\s0. @@ -845,13 +850,13 @@ xdrproc_t elproc; .ft R .IP A filter primitive that translates between fixed-length -arrays -and their corresponding external representations. The -parameter +arrays and their corresponding external representations. +The parameter .I arrp is the address of the pointer to the array, while .I size -is the element count of the array. The parameter +is the element count of the array. +The parameter .I elsize is the .I sizeof |
