xref: /freebsd/share/man/man9/tvtohz.9 (revision aca5021d5f7dcab1e11692923266373e35322d9a)
1.\" Copyright (c) 2000 Kelly Yancey
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd January 3, 2000
28.Dt TVTOHZ 9
29.Os
30.Sh NAME
31.Nm tvtohz
32.Nd convert time interval to tick count
33.Sh SYNOPSIS
34.In sys/time.h
35.Ft int
36.Fn tvtohz "struct timeval *tv"
37.Sh DESCRIPTION
38The
39.Fn tvtohz
40function accepts a single argument
41.Fa tv
42which specifies the time interval over which to calculate the number
43of system ticks that would elapse.
44.Sh RETURN VALUES
45Returns the integral number of system ticks expected to elapse in the given
46interval, including the current tick.
47.Sh SEE ALSO
48.Xr microtime 9 ,
49.Xr microuptime 9 ,
50.Xr timeout 9
51.Sh HISTORY
52The
53.Nm
54function first appeared in
55.Fx 3.0
56.Sh AUTHORS
57This manual page was written by
58.An Kelly Yancey Aq kbyanc@posi.net .
59