lib/libpthread/pthread_setname_np.3

   1 .\"     $NetBSD: pthread_setname_np.3,v 1.1 2007/12/14 21:51:22 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2007 YAMAMOTO Takashi,
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd December 15, 2007
  29 .Dt PTHREAD_SETNAME_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_setname_np
  33 .Nd set descriptive name of a thread
  34 .\" ------------------------------------------------------------
  35 .Sh LIBRARY
  36 .Lb libc
  37 .\" ------------------------------------------------------------
  38 .Sh SYNOPSIS
  39 .In pthread.h
  40 .Ft int
  41 .Fn pthread_setname_np "pthread_t thread" "const char *name" "void *arg"
  42 .\" ------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 .Fn pthread_setname_np
  45 sets the descriptive name of the thread.
  46 It takes the following arguments.
  47 .Bl -tag -width target
  48 .It Fa thread
  49 The thread whose descriptive name will be set.
  50 .It Fa name
  51 The
  52 .Xr printf 3
  53 format string to be used to construct the descriptive name of the thread.
  54 The resulted descriptive name should be shorter than
  55 .Dv PTHREAD_MAX_NAMELEN_NP .
  56 .It Fa arg
  57 The
  58 .Xr printf 3
  59 argument used with
  60 .Fa name .
  61 .El
  62 .\" ------------------------------------------------------------
  63 .Sh RETURN VALUES
  64 .Fn pthread_setname_np
  65 returns 0 on success.
  66 Otherwise,
  67 .Fn pthread_setname_np
  68 returns an error number described in
  69 .Xr errno 2 .
  70 .\" ------------------------------------------------------------
  71 .\".Sh ERRORS
  72 .\" ------------------------------------------------------------
  73 .Sh SEE ALSO
  74 .Xr errno 2 ,
  75 .Xr pthread_getname_np 3