harakit/docs/eep.1

55 lines
1.0 KiB
Groff

.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
.\"
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.TH EEP 1
.SH NAME
eep \(en wait a moment
.SH SYNOPSIS
eep
.RB [ seconds ]
.SH DESCRIPTION
Sleep waits the given amount of seconds before exiting.
.SH DIAGNOSTICS
Eep exits successfully when the time specified has elapsed, or unsuccessfully
if the time fails to elapse or if invoked incorrectly. In the latter scenario
eep will also print a usage synopsis.
.SH BUGS
User may still be tired after invoking eep.
.SH EXAMPLES
The following invocation eeps for five seconds.
.RS
.R eep 5
.RE
The following sh(1p) command line eeps for five minutes, or for sixty
seconds, five times, using rpn(1) and xargs(1p).
.RS
.R $ rpn 60 5 '*' | xargs eep
.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)