gen/FreeBSD/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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)pause.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/pause.3,v 1.9 2007/01/09 00:27:54 imp Exp $
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt PAUSE 3
  33 .Os
  34 .Sh NAME
  35 .Nm pause
  36 .Nd stop until signal
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft int
  42 .Fn pause void
  43 .Sh DESCRIPTION
  44 .Sy Pause is made obsolete by
  45 .Xr sigsuspend 2 .
  46 .Pp
  47 The
  48 .Fn pause
  49 function
  50 forces a process to pause until
  51 a signal is received from either the
  52 .Xr kill 2
  53 function
  54 or an interval timer.
  55 (See
  56 .Xr setitimer 2 . )
  57 Upon termination of a signal handler started during a
  58 .Fn pause ,
  59 the
  60 .Fn pause
  61 call will return.
  62 .Sh RETURN VALUES
  63 Always returns \-1.
  64 .Sh ERRORS
  65 The
  66 .Fn pause
  67 function
  68 always returns:
  69 .Bl -tag -width Er
  70 .It Bq Er EINTR
  71 The call was interrupted.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr kill 2 ,
  75 .Xr select 2 ,
  76 .Xr sigsuspend 2
  77 .Sh HISTORY
  78 A
  79 .Fn pause
  80 syscall
  81 appeared in
  82 .At v6 .