d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b66752c4a1
freebsd-dev/lib/libpthread/man/pthread_cond_init.3

83 lines
2.8 KiB
Groff
Raw Normal View History

I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
.\" 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. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL 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.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 20:50:10 +00:00
.\"
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Dd July 28, 1998
.Dt PTHREAD_COND_INIT 3
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 13:41:46 +00:00
.Os
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh NAME
.Nm pthread_cond_init
.Nd create a condition variable
Introduce .Lb macro to libc_r manpages.
2000-04-22 15:50:29 +00:00
.Sh LIBRARY
Mechanically change all libc_r references to libpthread.
2002-09-16 19:29:34 +00:00
.Lb libpthread
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In pthread.h
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Ft int
Changed prototype in synopsis to match prototype in <pthread.h>.
1998-08-03 16:54:51 +00:00
.Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr"
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh DESCRIPTION
The
.Fn pthread_cond_init
function creates a new condition variable, with attributes specified with
.Fa attr .
If
.Fa attr
is NULL the default attributes are used.
.Sh RETURN VALUES
If successful, the
.Fn pthread_cond_init
function will return zero and put the new condition variable id into
.Fa cond ,
otherwise an error number will be returned to indicate the error.
.Sh ERRORS
The .Fn function
2003-06-08 10:40:44 +00:00
The
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Fn pthread_cond_init
The .Fn function
2003-06-08 10:40:44 +00:00
function will fail if:
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
.Fa attr
is invalid.
.It Bq Er ENOMEM
The process cannot allocate enough memory to create another condition
variable.
.It Bq Er EAGAIN
Add a missing word.
2001-06-05 00:11:08 +00:00
The system temporarily lacks the resources to create another condition
variable.
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.El
.Sh SEE ALSO
Sort cross references.
1998-08-31 16:41:09 +00:00
.Xr pthread_cond_broadcast 3 ,
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Xr pthread_cond_destroy 3 ,
.Xr pthread_cond_signal 3 ,
Sort cross references.
1998-08-31 16:41:09 +00:00
.Xr pthread_cond_timedwait 3 ,
.Xr pthread_cond_wait 3
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Sh STANDARDS
The .Fn function
2003-06-08 10:40:44 +00:00
The
I've put together man pages for the pthread_cleanup, pthread_cond, and pthread_mutex routines. I've also tweaked pthread_create.3 to point to pthread_cleanup_push(3) and pthread_cleanup_pop(3). PR: 7450 Submitted by: Brian Cully <shmit@kublai.com>
1998-07-31 09:09:19 +00:00
.Fn pthread_cond_init
The .Fn function
2003-06-08 10:40:44 +00:00
function conforms to
Use ``.St -p1003.1-96''.
2001-02-26 15:16:43 +00:00
.St -p1003.1-96 .
Reference in New Issue Copy Permalink