.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TIMED-PROCESS 1p"
.TH TIMED-PROCESS 1p 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
timed\-process \- Run background process for limited amount of time
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    timed\-process [\-e exit_status] timeout command [<arg> [<arg> ...]]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This script runs \fIcommand\fR for a specified amount of time and if it
doesn't finish, it kills the process.  If \fIcommand\fR runs and exits
before the given timeout, \fBtimed-process\fR returns the exit value of
\&\fIcommand\fR.  If \fIcommand\fR did not exit before \fItimeout\fR seconds,
then \fBtimed-process\fR will kill the process and returns an exit value
of 255, unless the \-e command line option is set, which instructs
\&\fBtimed-process\fR to return a different exit value.  This allows the
user of \fBtimed-process\fR to determine if the process ended normally or
was killed.