mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-10-18 02:19:39 +00:00
Code Issues Releases Activity
fa573868f1
freebsd/bin/sleep/sleep.1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

134 lines
3.9 KiB
Groff
Raw Normal View History

/*- or .\"- or #- to begin license clauses.
2005-01-10 08:39:26 +00:00
.\"-
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.\" Copyright (c) 1990, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Dd March 22, 2024
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Dt SLEEP 1
.Os
.Sh NAME
.Nm sleep
.Nd suspend execution for an interval of time
.Sh SYNOPSIS
Let sleep(1) handle fractions of a second (up to nanosecond). This is a conservative change. It does the same thing in weird cases like the old one. For example, 'sleep abcd' still sleeps for zero seconds. `sleep 10.a' and `sleep 10.05aa' do the best and not abort (ie: 10.a == 10 seconds, 10.05a == 10.05 seconds).
1999-10-01 07:53:40 +00:00
.Nm
sleep.1: Fix mdoc style Fixes: be038c3afcae bin/sleep: add support for multiple delay values MFC after: 1 week
2022-05-25 08:09:29 +00:00
.Ar number Ns Op Ar unit
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Op ...
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh DESCRIPTION
The
Correct use of .Nm. Add rcsid.
1998-05-18 06:51:59 +00:00
.Nm
bin/sleep: add support for multiple delay values The sleep time is calculated as the sum of all arguments passed. This makes the FreeBSD version of sleep functionally compatible with the version in GNU coreutils. MFC after: 1 week
2022-05-24 08:47:40 +00:00
command suspends execution for a minimum of
bin/sleep: add support for units other than seconds The coreutils version of this command accepts a unit designation of s, m, h, or d (for seconds, minutes, hours, days) immediately following the number of (fractional) units to delay. The submitted patch has been modified in one detail: the test meant to detect the presence of the unit modified was not specific (!= 1) and would have accepted a non-numeric initial element or extra characters following the union. The committed version accepts only the number immediately followed by one of the defined unit designators and no further characters. PR: 264162 MFC after: 1 week
2022-05-24 07:43:38 +00:00
.Ar number
seconds (the default, or unit
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Li s ) ,
bin/sleep: add support for multiple delay values The sleep time is calculated as the sum of all arguments passed. This makes the FreeBSD version of sleep functionally compatible with the version in GNU coreutils. MFC after: 1 week
2022-05-24 08:47:40 +00:00
minutes (unit
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Li m ) ,
bin/sleep: add support for units other than seconds The coreutils version of this command accepts a unit designation of s, m, h, or d (for seconds, minutes, hours, days) immediately following the number of (fractional) units to delay. The submitted patch has been modified in one detail: the test meant to detect the presence of the unit modified was not specific (!= 1) and would have accepted a non-numeric initial element or extra characters following the union. The committed version accepts only the number immediately followed by one of the defined unit designators and no further characters. PR: 264162 MFC after: 1 week
2022-05-24 07:43:38 +00:00
hours (unit
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Li h ) ,
bin/sleep: add support for units other than seconds The coreutils version of this command accepts a unit designation of s, m, h, or d (for seconds, minutes, hours, days) immediately following the number of (fractional) units to delay. The submitted patch has been modified in one detail: the test meant to detect the presence of the unit modified was not specific (!= 1) and would have accepted a non-numeric initial element or extra characters following the union. The committed version accepts only the number immediately followed by one of the defined unit designators and no further characters. PR: 264162 MFC after: 1 week
2022-05-24 07:43:38 +00:00
or days (unit
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Li d ) .
Intervals can be written in any form allowed by
.Xr strtod 3 .
If multiple intervals are given, they are added together.
If the final sum is zero or negative,
.Nm
exits immediately.
Describe proper signals behavior rather than just removing it. Remove obsoleted reference to alarm(3). Submitted by: bde
1999-08-16 12:36:45 +00:00
.Pp
If the
.Nm
command receives a signal, it takes the standard action.
Document the new argument parser for sleep(1) and SIGINFO behaviour. Remove higlight for the unportability notice. MFC after: 3 weeks
2010-08-02 10:59:23 +00:00
When the
.Dv SIGINFO
signal is received, the estimate of the amount of seconds left to
sleep is printed on the standard output.
Let sleep(1) handle fractions of a second (up to nanosecond). This is a conservative change. It does the same thing in weird cases like the old one. For example, 'sleep abcd' still sleeps for zero seconds. `sleep 10.a' and `sleep 10.05aa' do the best and not abort (ie: 10.a == 10 seconds, 10.05a == 10.05 seconds).
1999-10-01 07:53:40 +00:00
.Sh IMPLEMENTATION NOTES
Describe proper signals behavior rather than just removing it. Remove obsoleted reference to alarm(3). Submitted by: bde
1999-08-16 12:36:45 +00:00
The
.Dv SIGALRM
signal is not handled specially by this implementation.
Add the new standard EXIT STATUS section where appropriate. Sort standard sections in the (documented) preferred order.
2005-01-16 16:41:59 +00:00
.Sh EXIT STATUS
.Ex -std
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh EXAMPLES
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
To run a command after half an hour:
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Dl (sleep 0.5h; sh command_file >out 2>err)&
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
This incantation would wait half an hour before
running the script
.Pa command_file .
See the
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Xr at 1
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
utility for another way to do this.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
To reiteratively run a command:
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Pp
.Bd -literal -offset indent -compact
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
while :; do
if ! [ -r zzz.rawdata ] ; then
sleep 5m
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
else
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
for i in *.rawdata ; do
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
sleep 70
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
awk -f collapse_data "$i"
done >results
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
break
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
fi
done
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Ed
.Pp
The scenario for a script such as this might be: a program currently
running is taking longer than expected to process a series of
files, and it would be nice to have
another program start processing the files created by the first
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
program as soon as it is finished (when
.Pa zzz.rawdata
is created).
The script checks every five minutes for the file
.Pa zzz.rawdata ,
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
when the file is found, then another portion processing
is done courteously by sleeping for 70 seconds in between each
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Xr awk 1
job.
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh SEE ALSO
Restore reference to sleep(3).
1999-10-28 17:41:33 +00:00
.Xr nanosleep 2 ,
.Xr sleep 3
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
.Sh STANDARDS
The
Correct use of .Nm. Add rcsid.
1998-05-18 06:51:59 +00:00
.Nm
BSD 4.4 Lite bin Sources
1994-05-26 06:18:55 +00:00
command is expected to be
.St -p1003.2
compatible.
sleep: Overhaul. Program: * Add a dummy getopt(3) loop to handle `--`. * Move interval parsing out into a separate function. * Print a diagnostic for every invalid interval. * Check for NaN and infinity. * Improve bounds checks. Manual page: * Miscellaneous markup fixes. * Reword DESCRIPTION section. * Move text about GNU compatibility to STANDARDS section. * Convert examples from csh to sh. Sponsored by: Klara, Inc. Reviewed by: kevans Differential Revision: https://reviews.freebsd.org/D44471
2024-03-25 15:58:31 +00:00
.Pp
Support for non-integer intervals, units other than seconds, and
multiple intervals which are added together are non-portable
extensions first introduced in GNU sh-utils 2.0a (released in 2002).
Add History section. sleep appeared in v4.
2002-06-10 09:07:22 +00:00
.Sh HISTORY
A
.Nm
command appeared in
.At v4 .
Reference in New Issue Copy Permalink