lib/libc/gen/pause.3

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)pause.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt PAUSE 3
  37 .Os BSD 4
  38 .Sh NAME
  39 .Nm pause
  40 .Nd stop until signal
  41 .Sh SYNOPSIS
  42 .Fd #include <unistd.h>
  43 .Ft int
  44 .Fn pause void
  45 .Sh DESCRIPTION
  46 .Sy Pause is made obsolete by
  47 .Xr sigsuspend 2 .
  48 .Pp
  49 The
  50 .Fn pause
  51 function
  52 forces a process to pause until
  53 a signal is received from either the
  54 .Xr kill 2
  55 function
  56 or an interval timer.
  57 (See
  58 .Xr setitimer 2 . )
  59 Upon termination of a signal handler started during a
  60 .Fn pause ,
  61 the
  62 .Fn pause
  63 call will return.
  64 .Sh RETURN VALUES
  65 Always returns \-1.
  66 .Sh ERRORS
  67 The
  68 .Fn pause
  69 function
  70 always returns:
  71 .Bl -tag -width [EINTR]
  72 .It Bq Er EINTR
  73 The call was interrupted.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr kill 2 ,
  77 .Xr select 2 ,
  78 .Xr sigsuspend 2
  79 .Sh HISTORY
  80 A
  81 .Fn pause
  82 syscall
  83 appeared in
  84 .At v6 .