Remove use of .SM macros.

This commit is contained in:
Michael Kerrisk 2007-12-24 16:10:29 +00:00
parent 3f28250188
commit d2d293bac2
7 changed files with 179 additions and 180 deletions

View File

@ -20,7 +20,7 @@ bindresvport \- bind a socket to a privileged IP port
.LP
.BR bindresvport ()
is used to bind a socket descriptor to a privileged
.SM IP
IP
port, that is, a
port number in the range 0-1023.

View File

@ -32,26 +32,26 @@ DES encryption
and
.BR cbc_crypt ()
implement the
.SM NBS
.SM DES
NBS
DES
(Data Encryption Standard).
These routines are faster and more general purpose than
.BR crypt (3).
They also are able to utilize
.SM DES
DES
hardware if it is available.
.BR ecb_crypt ()
encrypts in
.SM ECB
ECB
(Electronic Code Book)
mode, which encrypts blocks of data independently.
.BR cbc_crypt ()
encrypts in
.SM CBC
CBC
(Cipher Block Chaining)
mode, which chains together
successive blocks.
.SM CBC
CBC
mode protects against insertions, deletions and
substitutions of blocks.
Also, regularities in the clear text will
@ -62,7 +62,7 @@ The first parameter,
.IR key ,
is the 8-byte encryption key with parity.
To set the key's parity, which for
.SM DES
DES
is in the low bit of each byte, use
.BR des_setparity ().
The second parameter,
@ -77,22 +77,22 @@ which must be a multiple of 8.
The fourth parameter,
.IR mode ,
is formed by
.SM OR\s0'ing
OR 'ing
together some things.
For the encryption direction 'or' in either
.SM DES_ENCRYPT
.BR DES_ENCRYPT
or
.SM DES_DECRYPT\s0.
.BR SM DES_DECRYPT .
For software versus hardware
encryption, 'or' in either
.SM DES_HW
.BR DES_HW
or
.SM DES_SW\s0.
.BR SM DES_SW .
If
.SM DES_HW
.BR DES_HW
is specified, and there is no hardware, then the encryption is performed
in software and the routine returns
.SM DESERR_NOHWDEVICE\s0.
.BR SM DESERR_NOHWDEVICE .
For
.BR cbc_crypt (),
the parameter
@ -104,23 +104,23 @@ vector upon return.
.SH RETURN VALUE
.PD 0
.TP 20
.SM DESERR_NONE
.BR DESERR_NONE
No error.
.TP
.SM DESERR_NOHWDEVICE
.BR DESERR_NOHWDEVICE
Encryption succeeded, but done in software instead of the requested hardware.
.TP
.SM DESERR_HWERROR
.BR DESERR_HWERROR
An error occurred in the hardware or driver.
.TP
.SM DESERR_BADPARAM
.BR DESERR_BADPARAM
Bad parameter to routine.
.PD
.LP
Given a result status
.IR stat ,
the macro
.\" .SM DES_FAILED\c
.\" .BR DES_FAILED\c
.\" .BR ( stat )
.BI DES_FAILED( stat )
is false only for the first two statuses.

View File

@ -279,12 +279,10 @@ plus '?' for an
ambiguous match or an extraneous parameter.
.SH ENVIRONMENT
.TP
.SM
.B POSIXLY_CORRECT
If this is set, then option processing stops as soon as a non-option
argument is encountered.
.TP
.SM
.B _<PID>_GNU_nonoption_argv_flags_
This variable was used by
.BR bash (1)

View File

@ -78,9 +78,9 @@ program number is found, or until end-of-file is encountered.
.SH RETURN VALUE
.LP
A
.SM NULL
NULL
pointer is returned on
.SM EOF
EOF
or error.
.SH FILES
.PD 0

View File

@ -131,6 +131,7 @@ A typical source fragment would be
#endif
.fi
.in
.LP
(But see the BUGS section.)
.LP
The 4.4BSD, Linux and SUSv2 versions always return an absolute

View File

@ -60,12 +60,12 @@ authnone_create()
.ft R
.IP
Create and returns an
.SM RPC
RPC
authentication handle that passes nonusable authentication
information with each remote procedure call.
This is the
default authentication used by
.SM RPC.
RPC.
.if t .ne 10
.LP
.ft B
@ -79,7 +79,7 @@ int uid, gid, len, *aup_gids;
.ft R
.IP
Create and return an
.SM RPC
RPC
authentication handle that contains
authentication information.
The parameter
@ -88,10 +88,10 @@ is the name of the machine on which the information was
created;
.I uid
is the user's user
.SM ID ;
ID;
.I gid
is the user's current group
.SM ID ;
ID;
.I len
and
.I aup_gids
@ -150,7 +150,7 @@ is handy for translating failure statuses into messages.
.IP
Warning: calling remote procedures with this routine
uses
.SM UDP/IP
UDP/IP
as a transport; see
.BR clntudp_create ()
for restrictions.
@ -232,7 +232,7 @@ A macro that calls the remote procedure
associated with the client handle,
.IR clnt ,
which is obtained with an
.SM RPC
RPC
client creation routine such as
.BR clnt_create ().
The parameter
@ -258,7 +258,7 @@ CLIENT *clnt;
.ft R
.IP
A macro that destroys the client's
.SM RPC
RPC
handle.
Destruction usually involves deallocation
of private data structures, including
@ -269,7 +269,7 @@ Use of
is undefined after calling
.BR clnt_destroy ().
If the
.SM RPC
RPC
library opened the associated socket, it will close it also.
Otherwise, the socket remains open.
.br
@ -298,11 +298,11 @@ Default timeouts are set, but can be modified using
.BR clnt_control ().
.IP
Warning: Using
.SM UDP
UDP
has its shortcomings.
Since
.SM UDP-based
.SM RPC
UDP-based
RPC
messages can only hold up to 8 Kbytes of encoded data,
this transport cannot be used for procedures that take
large arguments or return huge results.
@ -327,17 +327,17 @@ indicates the type of operation, and
.I info
is a pointer to the information.
For both
.SM UDP
UDP
and
.SM TCP,
TCP,
the supported values of
.I req
and their argument types and what they do are:
.IP
.nf
.ta +2.0i +2.0i +2.0i
.SM CLSET_TIMEOUT struct timeval set total timeout
.SM CLGET_TIMEOUT struct timeval get total timeout
CLSET_TIMEOUT struct timeval set total timeout
CLGET_TIMEOUT struct timeval get total timeout
.fi
.IP
Note: if you set the timeout using
@ -347,23 +347,23 @@ the timeout parameter passed to
will be ignored in all future calls.
.IP
.nf
.SM CLGET_SERVER_ADDR struct sockaddr_in get server's address
CLGET_SERVER_ADDR struct sockaddr_in get server's address
.fi
.br
.IP
The following operations are valid for
.SM UDP
UDP
only:
.IP
.nf
.ta +2.0i +2.0i +2.0i
.SM CLSET_RETRY_TIMEOUT struct timeval set the retry timeout
.SM CLGET_RETRY_TIMEOUT struct timeval get the retry timeout
CLSET_RETRY_TIMEOUT struct timeval set the retry timeout
CLGET_RETRY_TIMEOUT struct timeval get the retry timeout
.fi
.br
.IP
The retry timeout is the time that
.SM "UDP RPC"
"UDP RPC"
waits for the server to reply before
retransmitting the request.
.br
@ -380,16 +380,16 @@ char *out;
.ft R
.IP
A macro that frees any data allocated by the
.SM RPC/XDR
RPC/XDR
system when it decoded the results of an
.SM RPC
RPC
call.
The parameter
.I out
is the address of the results, and
.I outproc
is the
.SM XDR
XDR
routine describing the results.
This routine returns one if the results were successfully
freed,
@ -425,7 +425,7 @@ char *s;
.IP
Print a message to standard error indicating
why a client
.SM RPC
RPC
handle could not be created.
The message is prepended with string
.I s
@ -467,7 +467,7 @@ char *s;
.ft R
.IP
Print a message to standard error indicating why an
.SM RPC
RPC
call failed;
.I clnt
is the handle used to do the call.
@ -511,11 +511,11 @@ Take the same arguments as
.BR clnt_perrno (),
but instead of sending a message to the standard error
indicating why an
.SM RPC
RPC
call failed, return a pointer to a string which contains
the message.
The string ends with a
.SM NEWLINE.
NEWLINE.
.IP
.BR clnt_sperrno ()
is used instead of
@ -569,7 +569,7 @@ unsigned long prognum, versnum;
.ft R
.IP
This routine creates a toy
.SM RPC
RPC
client for the remote program
.IR prognum ,
version
@ -577,17 +577,17 @@ version
The transport used to pass messages to the service is
actually a buffer within the process's address space, so the
corresponding
.SM RPC
RPC
server should live in the same address space; see
.BR svcraw_create ().
This allows simulation of
.SM RPC
RPC
and acquisition of
.SM RPC
RPC
overheads, such as round trip times, without any
kernel interference.
This routine returns
.SM NULL
NULL
if it fails.
.br
.if t .ne 15
@ -605,13 +605,13 @@ unsigned int sendsz, recvsz;
.ft R
.IP
This routine creates an
.SM RPC
RPC
client for the remote program
.IR prognum ,
version
.IR versnum ;
the client uses
.SM TCP/IP
TCP/IP
as a transport.
The remote program is located at Internet
address
@ -630,10 +630,10 @@ is a socket; if it is
then this routine opens a new one and sets
.IR sockp .
Since
.SM TCP-based
.SM RPC
TCP-based
RPC
uses buffered
.SM I/O ,
I/O,
the user may specify the size of the send and receive buffers
with the parameters
.I sendsz
@ -641,7 +641,7 @@ and
.IR recvsz ;
values of zero choose suitable defaults.
This routine returns
.SM NULL
NULL
if it fails.
.br
.if t .ne 15
@ -659,13 +659,13 @@ int *sockp;
.ft R
.IP
This routine creates an
.SM RPC
RPC
client for the remote program
.IR prognum ,
version
.IR versnum ;
the client uses use
.SM UDP/IP
UDP/IP
as a transport.
The remote program is located at Internet
address
@ -683,7 +683,7 @@ is a socket; if it is
then this routine opens a new one and sets
.IR sockp .
The
.SM UDP
UDP
transport resends the call message in intervals of
.I wait
time until a response is received or until the call times
@ -692,8 +692,8 @@ The total time for the call to time out is specified by
.BR clnt_call ().
.IP
Warning: since
.SM UDP-based
.SM RPC
UDP-based
RPC
messages can only hold up to 8 Kbytes
of encoded data, this transport cannot be used for procedures
that take large arguments or return huge results.
@ -716,13 +716,13 @@ unsigned int recosize;
.ft R
.IP
This routine creates an
.SM RPC
RPC
client for the remote program
.IR prognum ,
on
.IR versnum ;
the client uses use
.SM UDP/IP
UDP/IP
as a transport.
The remote program is located at Internet
address
@ -740,7 +740,7 @@ is a socket; if it is
then this routine opens a new one and sets
.BR sockp .
The
.SM UDP
UDP
transport resends the call message in intervals of
.I wait
time until a response is received or until the call times
@ -749,8 +749,8 @@ The total time for the call to time out is specified by
.BR clnt_call ().
.IP
This allows the user to specify the maximum packet size for sending and receiving
.SM UDP-based
.SM RPC
UDP-based
RPC
messages.
.br
.if t .ne 7
@ -765,7 +765,7 @@ struct sockaddr_in *addr;
.ft R
.IP
Stuff the machine's
.SM IP
IP
address into
.IR *addr ,
without consulting the library routines that deal with
@ -787,14 +787,14 @@ struct sockaddr_in *addr;
A user interface to the
.B portmap
service, which returns a list of the current
.SM RPC
RPC
program-to-port mappings
on the host located at
.SM IP
IP
address
.IR *addr .
This routine can return
.SM NULL .
NULL.
The command
.IR "rpcinfo\ \-p"
uses this routine.
@ -825,20 +825,20 @@ The value of
.I protocol
is most likely
.B
.SM IPPROTO_UDP
IPPROTO_UDP
or
.BR IPPROTO_TCP .
A return value of zero means that the mapping does not exist
or that
the
.SM RPC
RPC
system failed to contact the remote
.B portmap
service.
In the latter case, the global variable
.BR rpc_createerr ()
contains the
.SM RPC
RPC
status.
.br
.if t .ne 15
@ -863,11 +863,11 @@ A user interface to the
service, which instructs
.B portmap
on the host at
.SM IP
IP
address
.I *addr
to make an
.SM RPC
RPC
call on your behalf to a procedure on that host.
The parameter
.I *portp
@ -909,7 +909,7 @@ The value of
.I protocol
is most likely
.B
.SM IPPROTO_UDP
IPPROTO_UDP
or
.BR IPPROTO_TCP .
This routine returns one if it succeeds, zero otherwise.
@ -953,7 +953,7 @@ xdrproc_t inproc, outproc;
Register procedure
.I procname
with the
.SM RPC
RPC
service package.
If a request arrives for program
.IR prognum ,
@ -974,7 +974,7 @@ otherwise.
.IP
Warning: remote procedures registered in this form
are accessed using the
.SM UDP/IP
UDP/IP
transport; see
.BR svcudp_create ()
for restrictions.
@ -989,7 +989,7 @@ struct rpc_createerr rpc_createerr;
.ft R
.IP
A global variable whose value is set by any
.SM RPC
RPC
client creation routine
that does not succeed.
Use the routine
@ -1007,7 +1007,7 @@ xprt;
.ft R
.IP
A macro that destroys the
.SM RPC
RPC
service transport handle,
.IR xprt .
Destruction usually involves deallocation
@ -1028,7 +1028,7 @@ fd_set svc_fdset;
.ft R
.IP
A global variable reflecting the
.SM RPC
RPC
service side's
read file descriptor bit mask; it is suitable as a parameter
to the
@ -1072,7 +1072,7 @@ char *in;
.ft R
.IP
A macro that frees any data allocated by the
.SM RPC/XDR
RPC/XDR
system when it decoded the arguments to a service procedure
using
.BR svc_getargs ().
@ -1093,10 +1093,10 @@ char *in;
.ft R
.IP
A macro that decodes the arguments of an
.SM RPC
RPC
request
associated with the
.SM RPC
RPC
service transport handle,
.IR xprt .
The parameter
@ -1104,7 +1104,7 @@ The parameter
is the address where the arguments will be placed;
.I inproc
is the
.SM XDR
XDR
routine used to decode the arguments.
This routine returns one if decoding succeeds, and zero
otherwise.
@ -1122,7 +1122,7 @@ SVCXPRT *xprt;
.IP
The approved way of getting the network address of the caller
of a procedure associated with the
.SM RPC
RPC
service transport handle,
.IR xprt .
.br
@ -1143,9 +1143,9 @@ but instead implements custom asynchronous event processing.
It is called when the
.BR select (2)
system call has determined that an
.SM RPC
RPC
request has arrived on some
.SM RPC
RPC
socket(s);
.I rdfds
is the resultant read file descriptor bit mask.
@ -1206,10 +1206,10 @@ service (generally
.I protocol
is zero,
.B
.SM IPPROTO_UDP
IPPROTO_UDP
or
.B
.SM IPPROTO_TCP
IPPROTO_TCP
).
The procedure
.I dispatch
@ -1239,7 +1239,7 @@ svc_run()
.IP
This routine never returns.
It waits for
.SM RPC
RPC
requests to arrive, and calls the appropriate service
procedure using
.BR svc_getreq ()
@ -1261,7 +1261,7 @@ char *out;
.ft R
.IP
Called by an
.SM RPC
RPC
service's dispatch routine to send the results of a
remote procedure call.
The parameter
@ -1269,7 +1269,7 @@ The parameter
is the request's associated transport handle;
.I outproc
is the
.SM XDR
XDR
routine which is used to encode the results; and
.I out
is the address of the results.
@ -1349,7 +1349,7 @@ SVCXPRT *xprt;
.ft R
.IP
Called when the desired program is not registered with the
.SM RPC
RPC
package.
Service implementors usually do not need this routine.
.br
@ -1366,7 +1366,7 @@ SVCXPRT *xprt;
.IP
Called when the desired version of a program is not registered
with the
.SM RPC
RPC
package.
Service implementors usually do not need this routine.
.br
@ -1420,7 +1420,7 @@ unsigned int recvsize;
Create a service on top of any open descriptor.
Typically, this descriptor is a connected socket for a stream protocol such
as
.SM TCP.
TCP.
.I sendsize
and
.I recvsize
@ -1439,23 +1439,23 @@ svcraw_create()
.ft R
.IP
This routine creates a toy
.SM RPC
RPC
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
RPC
client should live in the same
address space;
see
.BR clntraw_create ().
This routine allows simulation of
.SM RPC
RPC
and acquisition of
.SM RPC
RPC
overheads (such as round trip times), without any kernel
interference.
This routine returns
.SM NULL
NULL
if it fails.
.br
.if t .ne 11
@ -1471,8 +1471,8 @@ unsigned int send_buf_size, recv_buf_size;
.ft R
.IP
This routine creates a
.SM TCP/IP-based
.SM RPC
TCP/IP-based
RPC
service transport, to which it returns a pointer.
The transport is associated with the socket
.IR sock ,
@ -1480,7 +1480,7 @@ which may be
.BR RPC_ANYSOCK ,
in which case a new socket is created.
If the socket is not bound to a local
.SM TCP
TCP
port, then this routine binds it to an arbitrary port.
Upon completion,
\fB\%xprt\->xp_sock\fR
@ -1488,13 +1488,13 @@ is the transport's socket descriptor, and
\fB\%xprt\->xp_port\fR
is the transport's port number.
This routine returns
.SM NULL
NULL
if it fails.
Since
.SM TCP-based
.SM RPC
TCP-based
RPC
uses buffered
.SM I/O ,
I/O,
users may specify the size of buffers; values of zero
choose suitable defaults.
.br
@ -1511,8 +1511,8 @@ unsigned int sendsize, recosize;
.ft R
.IP
This routine creates a
.SM UDP/IP-based
.SM RPC
UDP/IP-based
RPC
service transport, to which it returns a pointer.
The transport is associated with the socket
.IR sock ,
@ -1520,7 +1520,7 @@ which may be
.BR RPC_ANYSOCK ,
in which case a new socket is created.
If the socket is not bound to a local
.SM UDP
UDP
port, then this routine binds it to an arbitrary port.
Upon completion,
\fB\%xprt\->xp_sock\fR
@ -1528,13 +1528,13 @@ is the transport's socket descriptor, and
\fB\%xprt\->xp_port\fR
is the transport's port number.
This routine returns
.SM NULL
NULL
if it fails.
.IP
This allows the user to specify the maximum packet size for sending and
receiving
.SM UDP-based
.SM RPC messages.
UDP-based
RPC messages.
.br
.if t .ne 5
.LP
@ -1563,12 +1563,12 @@ struct accepted_reply *ar;
.ft R
.IP
Used for encoding
.SM RPC
RPC
reply messages.
This routine is useful for users who wish to generate
RPC-style
messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 7
@ -1583,11 +1583,11 @@ struct authunix_parms *aupp;
.ft R
.IP
Used for describing
.SM UNIX
UNIX
credentials.
This routine is useful for users
who wish to generate these credentials without using the
.SM RPC
RPC
authentication package.
.br
.if t .ne 7
@ -1603,12 +1603,12 @@ struct rpc_msg *chdr;
.ft R
.IP
Used for describing
.SM RPC
RPC
call header messages.
This routine is useful for users who wish to generate
.SM RPC-style
RPC-style
messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 7
@ -1623,12 +1623,12 @@ struct rpc_msg *cmsg;
.ft R
.IP
Used for describing
.SM RPC
RPC
call messages.
This routine is useful for users who wish to generate
.SM RPC-style
RPC-style
messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 7
@ -1643,12 +1643,12 @@ struct opaque_auth *ap;
.ft R
.IP
Used for describing
.SM RPC
RPC
authentication information messages.
This routine is useful for users who wish to generate
.SM RPC-style
RPC-style
messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 7
@ -1699,12 +1699,12 @@ struct rejected_reply *rr;
.ft R
.IP
Used for describing
.SM RPC
RPC
reply messages.
This routine is useful for users who wish to generate
.SM RPC-style
RPC-style
messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 8
@ -1719,12 +1719,12 @@ struct rpc_msg *rmsg;
.ft R
.IP
Used for describing
.SM RPC
RPC
reply messages.
This routine is useful for users who wish to generate
.SM RPC
RPC
style messages without using the
.SM RPC
RPC
package.
.br
.if t .ne 8
@ -1739,10 +1739,10 @@ SVCXPRT *xprt;
.ft R
.IP
After
.SM RPC
RPC
service transport handles are created,
they should register themselves with the
.SM RPC
RPC
service package.
This routine modifies the global variable
.BR svc_fds ().
@ -1760,10 +1760,10 @@ SVCXPRT *xprt;
.ft R
.IP
Before an
.SM RPC
RPC
service transport handle is destroyed,
it should unregister itself with the
.SM RPC
RPC
service package.
This routine modifies the global variable
.BR svc_fds ().
@ -1785,5 +1785,5 @@ rpcgen Programming Guide
.ft R
.RE
.IR "RPC: Remote Procedure Call Protocol Specification" ,
.SM RFC\ 1050, Sun Microsystems, Inc.,
.SM USC-ISI.
RFC\ 1050, Sun Microsystems, Inc.,
USC-ISI.

View File

@ -40,7 +40,7 @@ is the
each of the array's elements, and
.I elproc
is an
.SM XDR
XDR
filter that translates between
the array elements' C form, and their external
representation.
@ -122,7 +122,7 @@ XDR *xdrs;
.ft R
.IP
A macro that invokes the destroy routine associated with the
.SM XDR
XDR
stream,
.IR xdrs .
Destruction usually involves freeing private data structures
@ -195,7 +195,7 @@ char *objp;
.IP
Generic freeing routine.
The first argument is the
.SM XDR
XDR
routine for the object being freed.
The second argument
is a pointer to the object itself.
@ -219,18 +219,18 @@ XDR *xdrs;
.IP
A macro that invokes the get-position routine
associated with the
.SM XDR
XDR
stream,
.IR xdrs .
The routine returns an unsigned integer,
which indicates the position of the
.SM XDR
XDR
byte stream.
A desirable feature of
.SM XDR
XDR
streams is that simple arithmetic works with this number,
although the
.SM XDR
XDR
stream instances need not guarantee this.
.br
.if t .ne 4
@ -247,7 +247,7 @@ int len;
.ft R
.IP
A macro that invokes the in-line routine associated with the
.SM XDR
XDR
stream,
.IR xdrs .
The routine returns a pointer
@ -260,7 +260,7 @@ Note: pointer is cast to
Warning:
.BR xdr_inline ()
may return
.SM NULL
NULL
(0)
if it cannot allocate a contiguous piece of a buffer.
Therefore the behavior may vary among stream instances;
@ -312,7 +312,7 @@ enum xdr_op op;
.ft R
.IP
This routine initializes the
.SM XDR
XDR
stream object pointed to by
.IR xdrs .
The stream's data is written to, or read from,
@ -324,7 +324,7 @@ bytes long.
The
.I op
determines the direction of the
.SM XDR
XDR
stream
(either
.BR XDR_ENCODE ,
@ -369,7 +369,7 @@ xdrproc_t xdrobj;
Like
.BR xdr_reference ()
except that it serializes
.SM NULL
NULL
pointers, whereas
.BR xdr_reference ()
does not.
@ -394,7 +394,7 @@ int (*readit) (), (*writeit) ();
.ft R
.IP
This routine initializes the
.SM XDR
XDR
stream object pointed to by
.IR xdrs .
The stream's data is written to a buffer of size
@ -420,13 +420,13 @@ except that
.I handle
is passed to the former routines as the first parameter.
Note: the
.SM XDR
XDR
stream's
.I op
field must be set by the caller.
.IP
Warning: this
.SM XDR
XDR
stream implements an intermediate record stream.
Therefore there are additional bytes in the stream
to provide record boundary information.
@ -484,7 +484,7 @@ This routine can be invoked only on
streams created by
.BR xdrrec_create ().
It tells the
.SM XDR
XDR
implementation that the rest of the current record
in the stream's input buffer should be discarded.
This routine returns one if it succeeds, zero otherwise.
@ -514,13 +514,13 @@ the structure that
points to; and
.I proc
is an
.SM XDR
XDR
procedure that filters the structure
between its C form and its external representation.
This routine returns one if it succeeds, zero otherwise.
.IP
Warning: this routine does not understand
.SM NULL
NULL
pointers.
Use
.BR xdr_pointer ()
@ -539,7 +539,7 @@ unsigned int pos;
.IP
A macro that invokes the set position routine associated with
the
.SM XDR
XDR
stream
.IR xdrs .
The parameter
@ -547,12 +547,12 @@ The parameter
is a position value obtained from
.BR xdr_getpos ().
This routine returns one if the
.SM XDR
XDR
stream could be repositioned,
and zero otherwise.
.IP
Warning: it is difficult to reposition some types of
.SM XDR
XDR
streams, so this routine may fail with one
type of stream and succeed with another.
.br
@ -586,11 +586,11 @@ enum xdr_op op;
.ft R
.IP
This routine initializes the
.SM XDR
XDR
stream object pointed to by
.IR xdrs .
The
.SM XDR
XDR
stream data is written to, or read from, the
.I stdio
stream
@ -598,7 +598,7 @@ stream
The parameter
.I op
determines the direction of the
.SM XDR
XDR
stream (either
.BR XDR_ENCODE ,
.BR XDR_DECODE ,
@ -606,7 +606,7 @@ or
.BR XDR_FREE ).
.IP
Warning: the destroy routine associated with such
.SM XDR
XDR
streams calls
.BR fflush (3)
on the
@ -741,13 +741,13 @@ is called to translate the union.
The end of the
.BR xdr_discrim ()
structure array is denoted by a routine of value
.SM NULL.
NULL.
If the discriminant is not found in the
.I choices
array, then the
.I defaultarm
procedure is called (if it is not
.SM NULL).
NULL).
Returns one if it succeeds, zero otherwise.
.br
.if t .ne 6
@ -778,7 +778,7 @@ is the
each of the array's elements, and
.I elproc
is an
.SM XDR
XDR
filter that translates between
the array elements' C form, and their external
representation.
@ -795,7 +795,7 @@ xdr_void()
.IP
This routine always returns one.
It may be passed to
.SM RPC
RPC
routines that require a function parameter,
where nothing is to be done.
.br
@ -814,13 +814,13 @@ A primitive that calls
.B "xdr_string(xdrs, sp,MAXUN.UNSIGNED );"
where
.B
.SM MAXUN.UNSIGNED
.B MAXUN.UNSIGNED
is the maximum value of an unsigned integer.
.BR xdr_wrapstring ()
is handy because the
.SM RPC
RPC
package passes a maximum of two
.SM XDR
XDR
routines as parameters, and
.BR xdr_string (),
one of the most frequently used primitives, requires three.
@ -837,6 +837,6 @@ eXternal Data Representation: Sun Technical Notes
.ft R
.br
.IR "XDR: External Data Representation Standard" ,
.SM RFC\ 1014, Sun Microsystems, Inc.,
.SM USC-ISI.
RFC\ 1014, Sun Microsystems, Inc.,
USC-ISI.
.RE