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

.\" @(#)rtime.3n	2.1 88/08/08 4.0 RPCSRC; from 1.5 88/02/08 SMI
.\" $FreeBSD$
.\"
.Dd May 13, 2021
.Dt RTIME 3
.Os
.Sh NAME
.Nm rtime
.Nd "get remote time"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In sys/time.h
.In netinet/in.h
.Ft int
.Fo rtime
.Fa "struct sockaddr_in *addrp"
.Fa "struct timeval *timep"
.Fa "struct timeval *timeout"
.Fc
.Sh DESCRIPTION
The
.Fn rtime
function
consults the Internet Time Server at the address pointed to by
.Fa addrp
and returns the remote time in the
.Vt timeval
struct pointed to by
.Fa timep .
Normally, the
.Tn UDP
protocol is used when consulting the Time Server.
The
.Fa timeout
argument specifies how long the
routine should wait before giving
up when waiting for a reply.
If
.Fa timeout
is specified as
.Dv NULL ,
however, the routine will instead use
.Tn TCP
and block until a reply is received from the time server.
.Sh RETURN VALUES
.Rv -std rtime
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			`.\"`
Remove references to timed(8) There are still references to timed(8) and timedc(8) in the base system, which were removed in 2018. PR: 255425 Reported by: Ceri Davies <ceri at submonkey dot net> Reviewed by: ygy, gbe MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D30232 2021-05-13 07:53:08 +00:00			`.Dd May 13, 2021`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Dt RTIME 3`
			`.Os`
			`.Sh NAME`
			`.Nm rtime`
			`.Nd "get remote time"`
			`.Sh LIBRARY`
			`.Lb libc`
			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/types.h`
			`.In sys/time.h`
			`.In netinet/in.h`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Ft int`
			`.Fo rtime`
			`.Fa "struct sockaddr_in *addrp"`
			`.Fa "struct timeval *timep"`
			`.Fa "struct timeval *timeout"`
			`.Fc`
			`.Sh DESCRIPTION`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`The`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fn rtime`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`function`
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			`consults the Internet Time Server at the address pointed to by`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa addrp`
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			`and returns the remote time in the`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Vt timeval`
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			`struct pointed to by`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa timep .`
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			`Normally, the`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Tn 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`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Fa timeout`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`argument specifies how long 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			`routine should wait before giving`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`up when waiting for a reply.`
			`If`
			`.Fa timeout`
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			`is specified as`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Dv NULL ,`
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			`however, the routine will instead use`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Tn TCP`
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			`and block until a reply is received from the time server.`
man(7) -> mdoc(7). 2001-01-17 18:26:21 +00:00			`.Sh RETURN VALUES`
			`.Rv -std rtime`