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