[apple/libc.git] / gen / FreeBSD / pause.3

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)pause.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/gen/pause.3,v 1.9 2007/01/09 00:27:54 imp Exp $
.\"
.Dd June 4, 1993
.Dt PAUSE 3
.Os
.Sh NAME
.Nm pause
.Nd stop until signal
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn pause void
.Sh DESCRIPTION
.Sy Pause is made obsolete by
.Xr sigsuspend 2 .
.Pp
The
.Fn pause
function
forces a process to pause until
a signal is received from either the
.Xr kill 2
function
or an interval timer.
(See
.Xr setitimer 2 . )
Upon termination of a signal handler started during a
.Fn pause ,
the
.Fn pause
call will return.
.Sh RETURN VALUES
Always returns \-1.
.Sh ERRORS
The
.Fn pause
function
always returns:
.Bl -tag -width Er
.It Bq Er EINTR
The call was interrupted.
.El
.Sh SEE ALSO
.Xr kill 2 ,
.Xr select 2 ,
.Xr sigsuspend 2
.Sh HISTORY
A
.Fn pause
syscall
appeared in
.At v6 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1980, 1991, 1993
e9ce8d39 A	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.
e9ce8d39 A	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	.\"
5b2abdfb	28	.\" @(#)pause.3 8.1 (Berkeley) 6/4/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/gen/pause.3,v 1.9 2007/01/09 00:27:54 imp Exp $
e9ce8d39	30	.\"
5b2abdfb A	31	.Dd June 4, 1993
5b2abdfb A	32	.Dt PAUSE 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
5b2abdfb A	35	.Nm pause
5b2abdfb A	36	.Nd stop until signal
e9ce8d39 A	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
5b2abdfb	40	.In unistd.h
e9ce8d39	41	.Ft int
5b2abdfb	42	.Fn pause void
e9ce8d39	43	.Sh DESCRIPTION
5b2abdfb A	44	.Sy Pause is made obsolete by
	45	.Xr sigsuspend 2 .
	46	.Pp
e9ce8d39	47	The
5b2abdfb A	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.
e9ce8d39	62	.Sh RETURN VALUES
5b2abdfb	63	Always returns \-1.
e9ce8d39	64	.Sh ERRORS
5b2abdfb A	65	The
	66	.Fn pause
	67	function
	68	always returns:
e9ce8d39	69	.Bl -tag -width Er
5b2abdfb A	70	.It Bq Er EINTR
	71	The call was interrupted.
	72	.El
e9ce8d39	73	.Sh SEE ALSO
5b2abdfb A	74	.Xr kill 2 ,
	75	.Xr select 2 ,
	76	.Xr sigsuspend 2
e9ce8d39	77	.Sh HISTORY
5b2abdfb A	78	A
	79	.Fn pause
	80	syscall
	81	appeared in
	82	.At v6 .