~vcs-imports/gawk/master

« back to all changes in this revision

Viewing changes to extension/time.3am

  • Committer: Arnold D. Robbins
  • Date: 2012-11-25 19:54:48 UTC
  • mfrom: (319.1.122)
  • Revision ID: git-v1:9a9ff61bbd952c1263b55f82a269da5b09289a6b
Merge branch 'master' into array-iface

Show diffs side-by-side

added added

removed removed

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