summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/time.3am
blob: 884f56f4a9b3095ae7a1300ae94fb5124912f7df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
.TH TIME 3am "Jul 11 2022" "Free Software Foundation" "GNU Awk Extension Modules"
.SH NAME
time \- time functions for gawk
.SH SYNOPSIS
.ft CW
@load "time"
.sp
time = gettimeofday()
.br
ret = sleep(amount)
.ft R
.SH CAUTION
This extension is deprecated in favor of the
.B timex
extension in the
.I gawkextlib
project.
Loading it issues a warning.
It will be removed from the
.I gawk
distribution in the next major release.
.SH DESCRIPTION
The
.I time
extension adds two functions named
.B gettimeofday()
and
.BR sleep() ,
as follows.
.TP
.B gettimeofday()
This function returns the number of seconds since the Epoch
as a floating-point value. It should have subsecond precision.
It returns \-1 upon error and sets
.B ERRNO
to indicate the problem.
.TP
.BI sleep( seconds )
This function attempts to sleep for the given amount of seconds, which
may include a fractional portion.
If
.I seconds
is negative, or the attempt to sleep fails,
then it returns \-1 and sets
.BR ERRNO .
Otherwise, the function should return 0 after sleeping
for the indicated amount of time.
.\" .SH NOTES
.\" .SH BUGS
.SH EXAMPLE
.ft CW
.nf
@load "time"
\&...
printf "It is now %g seconds since the Epoch\en", gettimeofday()
printf "Pausing for a while... " ; sleep(2.5) ; print "done"
.fi
.ft R
.SH "SEE ALSO"
.IR "GAWK: Effective AWK Programming" ,
.IR filefuncs (3am),
.IR fnmatch (3am),
.IR fork (3am),
.IR inplace (3am),
.IR ordchr (3am),
.IR readdir (3am),
.IR readfile (3am),
.IR revoutput (3am),
.IR rwarray (3am).
.PP
.IR gettimeofday (2),
.IR nanosleep (2),
.IR select (2).
.SH AUTHOR
Arnold Robbins,
.BR arnold@skeeve.com .
.SH COPYING PERMISSIONS
Copyright \(co 2012, 2013, 2018, 2022,
Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of
this manual page provided the copyright notice and this permission
notice are preserved on all copies.
.ig
Permission is granted to process this file through troff and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual page).
..
.PP
Permission is granted to copy and distribute modified versions of this
manual page under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
.PP
Permission is granted to copy and distribute translations of this
manual page into another language, under the above conditions for
modified versions, except that this permission notice may be stated in
a translation approved by the Foundation.
.\" vim: set filetype=nroff :