lib/libpthread/pthread_main_np.3

   1 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
   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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man3/pthread_main_np.3,v 1.6 2007/10/22 10:08:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_main_np.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_MAIN_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_main_np
  33 .Nd identify the initial thread
  34 .Sh LIBRARY
  35 .Lb libpthread
  36 .Sh SYNOPSIS
  37 .In pthread.h
  38 .In pthread_np.h
  39 .Ft int
  40 .Fn pthread_main_np void
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_main_np
  44 function
  45 is used in userland threads environment to identify the initial thread.
  46 Its semantics is similar to the Solaris's
  47 .Fn thr_main
  48 function.
  49 .Sh RETURN VALUES
  50 The
  51 .Fn pthread_main_np
  52 function returns
  53 1 if the calling thread is the initial thread,
  54 0 if the calling thread is not the initial thread,
  55 and \-1 if the thread's initialization has not yet completed.
  56 .Sh SEE ALSO
  57 .Xr pthread_create 3 ,
  58 .Xr pthread_equal 3 ,
  59 .Xr pthread_self 3
  60 .Sh AUTHORS
  61 This manual page was written by
  62 .An Alexey Zelkin Aq phantom@FreeBSD.org .