lib/libc/gen/raise.3

   1 .\"     $NetBSD: raise.3,v 1.8 2009/01/30 23:26:54 ad Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the American National Standards Committee X3, on Information
   8 .\" Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)raise.3     8.1 (Berkeley) 6/4/93
  35 .\"
  36 .Dd January 29, 2009
  37 .Dt RAISE 3
  38 .Os
  39 .Sh NAME
  40 .Nm raise
  41 .Nd send a signal to the current thread
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In signal.h
  46 .Ft int
  47 .Fn raise "int sig"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn raise
  51 function sends the signal
  52 .Fa sig
  53 to the current thread.
  54 .Sh RETURN VALUES
  55 Upon successful completion, a value of 0 is returned.
  56 Otherwise, a value of \-1 is returned and the global variable
  57 .Va errno
  58 is set to indicate the error.
  59 .Sh ERRORS
  60 The
  61 .Fn raise
  62 function
  63 may fail and set
  64 .Va errno
  65 for any of the errors specified for the
  66 library functions
  67 .Xr _lwp_self 2
  68 and
  69 .Xr _lwp_kill 2 .
  70 .Sh SEE ALSO
  71 .Xr kill 2
  72 .Sh STANDARDS
  73 The
  74 .Fn raise
  75 function
  76 conforms to
  77 .St -ansiC
  78 and
  79 .St -susv2 .