eep(1) #103

Open
trinity wants to merge 16 commits from sleep into main
Showing only changes of commit 327c71c8ae - Show all commits

48
docs/sleep.1 Normal file
View File

@ -0,0 +1,48 @@
.TH SLEEP 1
.SH NAME
sleep \(en wait a moment
.SH SYNOPSIS
sleep
.RB [ seconds ]
.SH DESCRIPTION
Sleep waits the given amount of seconds before exiting.
.SH DIAGNOSTICS
Sleep exits successfully when the time specified has elapsed, or unsuccessfully
if the time fails to elapse or if invoked incorrectly. In the latter scenario
emma marked this conversation as resolved Outdated
Outdated
Review

Wait a number of seconds before exiting.

Wait a number of seconds before exiting.
sleep will also print a usage synopsis.
.SH BUGS
User may still be tired after invoking sleep.
emma marked this conversation as resolved Outdated
Outdated
Review

If the specified time fails to elapse or in the case of incorrect invocation, the program will
exit unsuccessfully. In the latter scenario, a debug message will be printed.

For parity with other man pages.

> If the specified time fails to elapse or in the case of incorrect invocation, the program will exit unsuccessfully. In the latter scenario, a debug message will be printed. [For parity with other man pages](https://git.tebibyte.media/bonsai/coreutils/pulls/93#issuecomment-4547).
.SH EXAMPLES
The following invocation sleeps for five seconds.
emma marked this conversation as resolved Outdated
Outdated
Review

The user my still be tired after invocation.

> The user my still be tired after invocation.
.RS
.R sleep 5
.RE
emma marked this conversation as resolved Outdated
Outdated
Review

[...] for five seconds:

> [...] for five seconds:
The following sh(1p) command line sleeps for five minutes, or for sixty
seconds, five times, using rpn(1) and xargs(1p).
.RS
.R $ rpn 60 5 '*' | xargs sleep
.RE
.SH COPYRIGHT
Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
.SH SEE ALSO
sleep(3)