From owner-freebsd-doc  Mon Jan 29 13:47:06 1996
Return-Path: owner-doc
Received: (from root@localhost)
          by freefall.freebsd.org (8.7.3/8.7.3) id NAA07072
          for doc-outgoing; Mon, 29 Jan 1996 13:47:06 -0800 (PST)
Received: from Post-Office.UH.EDU (Post-Office.UH.EDU [129.7.1.20])
          by freefall.freebsd.org (8.7.3/8.7.3) with ESMTP id NAA07056
          for <doc@freebsd.org>; Mon, 29 Jan 1996 13:46:56 -0800 (PST)
Received: from UUCP-GW.CC.UH.EDU by Post-Office.UH.EDU (PMDF V5.0-5 #8380)
 id <01I0L6CTP0GU0006K6@Post-Office.UH.EDU> for doc@freebsd.org; Mon,
 29 Jan 1996 15:46:43 -0600 (CST)
Received: from Taronga.COM by UUCP-GW.CC.UH.EDU with UUCP id AA02638
 (5.67a/IDA-1.5 for doc@freebsd.org); Mon, 29 Jan 1996 15:18:21 -0600
Received: (from peter@localhost) by bonkers.taronga.com (8.6.11/8.6.9)
 id JAA18262 for doc@freebsd.org; Mon, 29 Jan 1996 09:59:39 -0600
Date: Mon, 29 Jan 1996 09:59:39 -0600
From: peter@taronga.com (Peter da Silva)
Subject: Suggested change to the sleep(3) man page
To: doc@freebsd.org
Message-id: <199601291559.JAA18262@bonkers.taronga.com>
Content-transfer-encoding: 7BIT
Sender: owner-doc@freebsd.org
Precedence: bulk

Thanks to Josh MacDonald for noticing this. Here's what I would put in...

.Sh RETURN VALUES
The
.Fn sleep
function returns the number of seconds remaining to complete the operation. If
sleep is interrupted or cannot allocate a timer it may will return the value
needed to be passed to a subsequent sleep to complete the necessary delay.
.Sh WARNING
In practice the FreeBSD implementation will not be interrupted: it will
always return the original argument or zero. Code that depends on
sleep being interrupted (using it as a timed pause, for example) needs
to be recoded to use
.Xr select 2
or some other delay mechanism. Code that
calls
.Fn sleep
repeatedly until it returns zero may busy-wait until a timer
is available.