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