about summary refs log tree commit diff
path: root/README
blob: 3ef974dced5663f35ad54c4e269c78974718d10f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
REAP(1)                     General Commands Manual                    REAP(1)

NAME
     reap – run process until all its spawned processes are dead

SYNOPSIS
     reap [-vw] command line ...

DESCRIPTION
     The reap utility executes the given command line and ensures all spawned
     processes are dead before it exits.

     By default, it will start slaying the spawned processes when the main
     process exits.  When the option -w is given, reap will instead wait for
     the processes to terminate.

     Upon receiving SIGINT or SIGTERM, reap will start slaying all children
     immediately.

     The options are as follows:

     -w      Wait for all spawned processes to finish.

     -v      Verbose mode, report what reap is doing.

EXIT STATUS
     The reap utility exits with the exit status of the spawned command.

     On fatal errors, exit codes 111 is returned.

ASSUMPTIONS
     reap uses the PR_SET_CHILD_SUBREAPER feature of Linux.  Slaying the
     children only works when the kernel configuration CONFIG_PROC_CHILDREN is
     enabled.

     reap can only work reliably when it has permission to kill all spawned
     processes and they respect SIGTERM.

AUTHORS
     Leah Neukirchen <leah@vuxu.org>

LICENSE
     reap is in the public domain.

     To the extent possible under law, the creator of this work has waived all
     copyright and related or neighboring rights to this work.

     http://creativecommons.org/publicdomain/zero/1.0/

Void Linux                      August 13, 2019                     Void Linux