usr/src/man/man3c/psignal.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2014, Joyent, Inc.  All rights reserved.
   4 .\" Copyright 2015 Circonus, Inc.  All rights reserved.
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH PSIGNAL 3C "Aug 14, 2014"
   9 .SH NAME
  10 psignal, psiginfo \- system signal messages
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 #include <siginfo.h>
  15
  16 \fBvoid\fR \fBpsignal\fR(\fBint\fR \fIsig\fR, \fBconst char *\fR\fIs\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBpsiginfo\fR(\fBconst siginfo_t *\fR\fIpinfo\fR, \fBconst char *\fR\fIs\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .LP
  26 The \fBpsignal()\fR and \fBpsiginfo()\fR functions produce messages on the
  27 standard error output describing a signal.  The \fIsig\fR argument is a signal
  28 that may have been  passed as the first argument to a signal handler.  The
  29 \fIpinfo\fR argument is a pointer to a \fBsiginfo\fR structure that may have
  30 been passed as the second argument to an enhanced signal handler.  See
  31 \fBsigaction\fR(2). The argument string \fIs\fR is printed first, followed by a
  32 colon and a blank, followed by the message and a \fBNEWLINE\fR character. If
  33 \fBs\fR is the value \fBNULL\fR or an empty string, then nothing is printed for
  34 the user's string and the colon and blank are omitted.
  35 .SH USAGE
  36 .LP
  37 Messages printed from these functions are in the native language specified by
  38 the \fBLC_MESSAGES\fR locale category.  See \fBsetlocale\fR(3C).
  39 .SH ATTRIBUTES
  40 .LP
  41 See \fBattributes\fR(5) for descriptions of the following attributes:
  42 .sp
  43
  44 .sp
  45 .TS
  46 box;
  47 c | c
  48 l | l .
  49 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  50 _
  51 MT-Level        Safe
  52 .TE
  53
  54 .SH SEE ALSO
  55 .LP
  56 \fBsigaction\fR(2), \fBgettext\fR(3C), \fBperror\fR(3C), \fBsetlocale\fR(3C),
  57 \fBsiginfo.h\fR(3HEAD), \fBsignal.h\fR(3HEAD), \fBattributes\fR(5)