1.\" $OpenBSD: tvtohz.9,v 1.3 2003/06/04 04:29:03 deraadt Exp $ 2.\" 3.\" Copyright (c) 1999 Marc Espie 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 ``AS IS'' AND ANY EXPRESS OR 16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25.\" 26.Dd February 15, 2002 27.Dt TVTOHZ 9 28.Os 29.Sh NAME 30.Nm tvtohz 31.Nd translate time period to timeout delay 32.Sh SYNOPSIS 33.Fd #include <sys/types.h> 34.Fd #include <sys/time.h> 35.Fd #include <sys/systm.h> 36.Ft int 37.Fn tvtohz "struct timeval *tv" 38.Sh DESCRIPTION 39The 40.Fn tvtohz 41function computes the number of 42.Va hz 43in the specified amount of time. 44This is mainly used to translate a timeval into a suitable argument for 45.Xr timeout 9 . 46.Sh CODE REFERENCES 47This function is implemented in the file 48.Pa sys/kern/kern_clock.c . 49.Sh SEE ALSO 50.Xr hz 9 , 51.Xr hzto 9 , 52.Xr timeout 9 53