share/man/man1/wait.1

   1 .\"     $NetBSD: wait.1,v 1.3 2002/02/13 08:17:26 ross Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)wait.1      8.1 (Berkeley) 6/5/93
  31 .\"
  32 .Dd June 5, 1993
  33 .Dt WAIT 1
  34 .Os
  35 .Sh NAME
  36 .Nm wait
  37 .Nd await process completion
  38 .Sh SYNOPSIS
  39 .Nm wait
  40 .Op Ar pid
  41 .Sh DESCRIPTION
  42 If invoked with no arguments, the
  43 .Nm wait
  44 utility waits until
  45 all existing child processes in the background
  46 have terminated.
  47 .Pp
  48 Available operands:
  49 .Bl -tag -width Ds
  50 .It Ar pid
  51 If a
  52 .Ar pid
  53 operand is specified, and it is the process ID of a
  54 background child process that still exists, the
  55 .Nm wait
  56 utility
  57 waits until that process has completed and consumes its
  58 status information, without consuming the status information
  59 of any other process.
  60 .Pp
  61 If a pid operand is specified that is not the process ID of
  62 a child background process that still exists,
  63 .Nm wait
  64 exits
  65 without waiting for any processes to complete.
  66 .El
  67 .Pp
  68 The
  69 .Nm wait
  70 utility exits with one of the following values:
  71 .Bl -tag -width Ds
  72 .It \&0
  73 The
  74 .Nm wait
  75 utility was invoked with no operands and
  76 all of the existing background child processes have
  77 terminated, or the process specified by the pid
  78 operand exited normally with 0 as its exit status.
  79 .It \&\*[Gt]\&0
  80 The specified process did not exist and its exit
  81 status information was not available, or the specified
  82 process existed or its exit status information
  83 was available, and it terminated with a non-zero
  84 exit status.
  85 .El
  86 .Pp
  87 If the specified process terminated abnormally due
  88 to the receipt of a signal, the exit status
  89 information of
  90 .Nm wait
  91 contains that termination status as
  92 well.
  93 .Sh STANDARDS
  94 The
  95 .Nm wait
  96 command is expected to be
  97 .St -p1003.2
  98 compatible.