xref: /freebsd/bin/sleep/sleep.1 (revision a1a4f1a0d87b594d3f17a97dc0127eec1417e6f6)
1.\" Copyright (c) 1990, 1993, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)sleep.1	8.3 (Berkeley) 4/18/94
36.\" $FreeBSD$
37.\"
38.Dd April 18, 1994
39.Dt SLEEP 1
40.Os
41.Sh NAME
42.Nm sleep
43.Nd suspend execution for an interval of time
44.Sh SYNOPSIS
45.Nm sleep
46.Ar seconds
47.Sh DESCRIPTION
48The
49.Nm
50command
51suspends execution for a minimum of
52.Ar seconds .
53.Nm Sleep
54is used to schedule the execution of other commands (see
55.Sx EXAMPLES
56below).
57.Pp
58If the
59.Nm
60command receives a signal, it takes the standard action.
61The
62.Dv SIGALRM
63signal is not handled specially by this implementation.
64.Sh DIAGNOSTICS
65The
66.Nm
67utility exits with one of the following values:
68.Bl -tag -width flag
69.It Li \&0
70On successful completion.
71.It Li \&>\&0
72An error occurred.
73.El
74.Sh EXAMPLES
75To schedule the execution of a command for
76.Va x
77number seconds later:
78.Pp
79.Dl (sleep 1800; sh command_file >& errors)&
80.Pp
81This incantation would wait a half hour before
82running the script command_file. (See the
83.Xr at 1
84utility.)
85.Pp
86To reiteratively run a command (with the
87.Xr csh 1 ) :
88.Pp
89.Bd -literal -offset indent -compact
90while (1)
91	if (! -r zzz.rawdata) then
92		sleep 300
93	else
94		foreach i (`ls *.rawdata`)
95			sleep 70
96			awk -f collapse_data $i >> results
97		end
98		break
99	endif
100end
101.Ed
102.Pp
103The scenario for a script such as this might be: a program currently
104running is taking longer than expected to process a series of
105files, and it would be nice to have
106another program start processing the files created by the first
107program as soon as it is finished (when zzz.rawdata is created).
108The script checks every five minutes for the file zzz.rawdata,
109when the file is found, then another portion processing
110is done courteously by sleeping for 70 seconds in between each
111awk job.
112.Sh SEE ALSO
113.Xr at 1 ,
114.Xr nanosleep 2 ,
115.Xr sleep 3
116.Sh STANDARDS
117The
118.Nm
119command is expected to be
120.St -p1003.2
121compatible.
122