share/man/man1/sleep.1

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved  Portions
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
   5 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at  http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
   8 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
   9 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
  10 .\"  This notice shall appear on any product containing this material.
  11 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  12 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
  13 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  14 .TH SLEEP 1 "May 13, 2017"
  15 .SH NAME
  16 sleep \- suspend execution for an interval
  17 .SH SYNOPSIS
  18 .SS "/usr/bin/sleep"
  19 .LP
  20 .nf
  21 \fB/usr/bin/sleep\fR \fIseconds\fR
  22 .fi
  23
  24 .SS "ksh93"
  25 .LP
  26 .nf
  27 \fBsleep\fR \fIseconds\fR
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .LP
  32 \fBsleep\fR suspends execution for at least the time in seconds specified by
  33 \fIseconds\fR or until a \fBSIGALRM\fR signal is received. The \fIseconds\fR
  34 operand can be specified as a floating point number but the actual granularity
  35 normally depends on the underlying system.
  36 .SH OPERANDS
  37 .SS "/usr/bin/sleep"
  38 .LP
  39 The following operands are supported for \fB/usr/bin/sleep\fR and \fBksh93\fR's
  40 \fBsleep\fR built-in command:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIseconds\fR\fR
  45 .ad
  46 .RS 11n
  47 A non-negative floating-point number specifying the number of seconds for which
  48 to suspend execution. The floating-point number may be specified in all formats
  49 required by C99/XPG6, including constants such as "Inf" or "infinity".
  50 .RE
  51
  52 .SS "ksh93"
  53 .LP
  54 The following operands are supported:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fItime\fR\fR
  59 .ad
  60 .RS 8n
  61 Specify \fItime\fR in seconds as a floating point number. The actual
  62 granularity depends on the underlying system, normally around 1 millisecond.
  63 .RE
  64
  65 .SH EXAMPLES
  66 .LP
  67 \fBExample 1 \fRSuspending Command Execution
  68 .sp
  69 .LP
  70 The following example executes a command after a certain amount of time:
  71
  72 .sp
  73 .in +2
  74 .nf
  75 example% \fB(sleep 105; \fIcommand\fR)&\fR
  76 .fi
  77 .in -2
  78 .sp
  79
  80 .LP
  81 \fBExample 2 \fRExecuting a Command Every So Often
  82 .sp
  83 .LP
  84 The following example executes a command every so often:
  85
  86 .sp
  87 .in +2
  88 .nf
  89 example% \fBwhile true
  90 do
  91         \fIcommand\fR
  92         sleep 37
  93 done\fR
  94 .fi
  95 .in -2
  96 .sp
  97
  98 .LP
  99 \fBExample 3 \fRSuspend command execution forever (or until a \fBSIGALRM\fR
 100 signal is received)
 101 .sp
 102 .in +2
 103 .nf
 104 example% sleep Inf
 105 .fi
 106 .in -2
 107 .sp
 108
 109 .LP
 110 \fBExample 4 \fRSuspending command execution for 0.5 seconds
 111 .sp
 112 .LP
 113 Suspending command execution for 0.5 seconds using an alternative
 114 floating-point representation for the value "0.5"
 115
 116 .sp
 117 .in +2
 118 .nf
 119 example% printf "%a\en" 0.5
 120 0x1.0000000000000000000000000000p-01
 121 .fi
 122 .in -2
 123 .sp
 124
 125 .sp
 126 .in +2
 127 .nf
 128 example% sleep 0x1.0000000000000000000000000000p-01
 129 .fi
 130 .in -2
 131 .sp
 132
 133 .SH ENVIRONMENT VARIABLES
 134 .LP
 135 See \fBenviron\fR(5) for descriptions of the following environment variables
 136 that affect the execution of \fBsleep\fR: \fBLANG\fR, \fBLC_ALL\fR,
 137 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 138 .SH EXIT STATUS
 139 .LP
 140 The following exit values are returned:
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB0\fR\fR
 145 .ad
 146 .RS 6n
 147 The execution was successfully suspended for at least \fItime\fR seconds, or a
 148 \fBSIGALRM\fR signal was received (see NOTES).
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB>0\fR\fR
 155 .ad
 156 .RS 6n
 157 An error has occurred.
 158 .RE
 159
 160 .SH ATTRIBUTES
 161 .LP
 162 See \fBattributes\fR(5) for descriptions of the following attributes:
 163 .SS "/usr/bin/sleep"
 164 .TS
 165 box;
 166 c | c
 167 l | l .
 168 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 169 _
 170 Interface Stability     Committed
 171 _
 172 Standard        See \fBstandards\fR(5).
 173 .TE
 174
 175 .SS "ksh93"
 176 .TS
 177 box;
 178 c | c
 179 l | l .
 180 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 181 _
 182 Interface Stability     Uncommitted
 183 .TE
 184
 185 .SH SEE ALSO
 186 .LP
 187 \fBksh93\fR(1), \fBwait\fR(1), \fBalarm\fR(2), \fBsleep\fR(3C),
 188 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
 189 .SH NOTES
 190 .LP
 191 If the \fBsleep\fR utility receives a \fBSIGALRM\fR signal, one of the
 192 following actions is taken:
 193 .RS +4
 194 .TP
 195 .ie t \(bu
 196 .el o
 197 Terminate normally with a zero exit status.
 198 .RE
 199 .RS +4
 200 .TP
 201 .ie t \(bu
 202 .el o
 203 Effectively ignore the signal.
 204 .RE
 205 .sp
 206 .LP
 207 The \fBsleep\fR utility takes the standard action for all other signals.
 208 .sp
 209 .LP
 210 The behavior for input values such as "NaN" (not-a-number) or negative values
 211 is undefined.