[unix-history] / lib / libc / gen / pause.3

.\" Copyright (c) 1980, 1991 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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	6.3 (Berkeley) 4/19/91
.\"
.Dd April 19, 1991
.Dt PAUSE 3
.Os BSD 4
.Sh NAME
.Nm pause
.Nd stop until signal
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fn pause void
.Sh DESCRIPTION
.Bf -symbolic
Pause is made obsolete by sigpause(3).
.Ef
.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 [EINTR]
.It Bq Er EINTR
The call was interrupted.
.El
.Sh SEE ALSO
.Xr kill 2 ,
.Xr select 2 ,
.Xr sigpause 2
.Sh HISTORY
A
.Fn pause
syscall
appeared in 
.At v6 .
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1980, 1991 Regents of the University of California.
	2	.\" 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 6.3 (Berkeley) 4/19/91
	33	.\"
	34	.Dd April 19, 1991
	35	.Dt PAUSE 3
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm pause
	39	.Nd stop until signal
	40	.Sh SYNOPSIS
	41	.Fd #include <unistd.h>
	42	.Ft int
	43	.Fn pause void
	44	.Sh DESCRIPTION
	45	.Bf -symbolic
	46	Pause is made obsolete by sigpause(3).
	47	.Ef
	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 sigpause 2
79	.Sh HISTORY
80	A
81	.Fn pause
82	syscall
83	appeared in
84	.At v6 .