freebsd-nq/lib/libc/rpc/rtime.3

.\" @(#)rtime.3n	2.1 88/08/08 4.0 RPCSRC; from 1.5 88/02/08 SMI
.\" $FreeBSD$
.\"
.TH RTIME 3  "22 November 1987"
.SH NAME
rtime \- get remote time
.SH SYNOPSIS
.nf
.B #include <sys/types.h>
.B #include <sys/time.h>
.B #include <netinet/in.h>
.LP
.B int rtime(addrp, timep, timeout)
.B struct sockaddr_in \(**addrp;
.B struct timeval \(**timep;
.B struct timeval \(**timeout;
.fi
.SH DESCRIPTION
.B rtime(\|)
consults the Internet Time Server at the address pointed to by
.I addrp
and returns the remote time in the
.B timeval
struct pointed to by
.IR timep .
Normally, the
.SM UDP
protocol is used when consulting the Time Server.
The
.I timeout
parameter specifies how long the
routine should wait before giving
up when waiting for a reply.  If
.I timeout
is specified as
.SM NULL\s0,
however, the routine will instead use
.SM TCP
and block until a reply is received from the time server.
.LP
The routine returns 0 if it is successful.
Otherwise,
it returns \-1 and
.B errno
is set to reflect the cause of the error.
.SH "SEE ALSO"
.BR timed (8c)
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`.\" @(#)rtime.3n 2.1 88/08/08 4.0 RPCSRC; from 1.5 88/02/08 SMI`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 20:50:10 +00:00			`.\"`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`.TH RTIME 3 "22 November 1987"`
			`.SH NAME`
			`rtime \- get remote time`
			`.SH SYNOPSIS`
			`.nf`
			`.B #include <sys/types.h>`
			`.B #include <sys/time.h>`
			`.B #include <netinet/in.h>`
			`.LP`
			`.B int rtime(addrp, timep, timeout)`
			`.B struct sockaddr_in \(**addrp;`
			`.B struct timeval \(**timep;`
			`.B struct timeval \(**timeout;`
			`.fi`
			`.SH DESCRIPTION`
			`.B rtime(\\|)`
			`consults the Internet Time Server at the address pointed to by`
			`.I addrp`
			`and returns the remote time in the`
			`.B timeval`
			`struct pointed to by`
			`.IR timep .`
			`Normally, the`
			`.SM UDP`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-02 09:14:21 +00:00			`protocol is used when consulting the Time Server.`
			`The`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`.I timeout`
			`parameter specifies how long the`
			`routine should wait before giving`
			`up when waiting for a reply. If`
			`.I timeout`
			`is specified as`
			`.SM NULL\s0,`
			`however, the routine will instead use`
			`.SM TCP`
			`and block until a reply is received from the time server.`
			`.LP`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-02 09:14:21 +00:00			`The routine returns 0 if it is successful.`
			`Otherwise,`
Now the biggest step: import the changes to the main RPC code. Note: you'll need to rinstalkl all your includes before compiling libc the next time you update your sources in order for all this to work. Reviewed by: Mark Murray 1997-05-28 05:00:11 +00:00			`it returns \-1 and`
			`.B errno`
			`is set to reflect the cause of the error.`
			`.SH "SEE ALSO"`
			`.BR timed (8c)`