xref: /freebsd/share/man/man9/tvtohz.9 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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.Dd January 3, 2000
26.Dt TVTOHZ 9
27.Os
28.Sh NAME
29.Nm tvtohz
30.Nd convert time interval to tick count
31.Sh SYNOPSIS
32.In sys/time.h
33.Ft int
34.Fn tvtohz "struct timeval *tv"
35.Sh DESCRIPTION
36The
37.Fn tvtohz
38function accepts a single argument
39.Fa tv
40which specifies the time interval over which to calculate the number
41of system ticks that would elapse.
42.Sh RETURN VALUES
43Returns the integral number of system ticks expected to elapse in the given
44interval, including the current tick.
45.Sh SEE ALSO
46.Xr callout 9 ,
47.Xr microtime 9 ,
48.Xr microuptime 9
49.Sh HISTORY
50The
51.Nm
52function first appeared in
53.Fx 3.0
54.Sh AUTHORS
55This manual page was written by
56.An Kelly Yancey Aq Mt kbyanc@posi.net .
57