Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / string / strsignal.3
blobc9bbcb1985e55bf11bcad1c8e479fd4d32836df2
1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the American National Standards Committee X3, on Information
6 .\" Processing Systems.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)strerror.3    6.9 (Berkeley) 6/29/91
33 .\"     $NetBSD: strsignal.3,v 1.9 2003/08/07 16:43:52 agc Exp $
34 .\"
35 .Dd July 22, 2009
36 .Dt STRSIGNAL 3
37 .Os
38 .Sh NAME
39 .Nm strsignal
40 .Nd get signal description string
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In string.h
45 .Ft char *
46 .Fn strsignal "int sig"
47 .Sh DESCRIPTION
48 The
49 .Fn strsignal
50 function returns a pointer to the language-dependent string describing
51 a signal.
52 .Pp
53 The array pointed to is not to be modified by the program, but may be
54 overwritten by subsequent calls to
55 .Fn strsignal .
56 .Sh SEE ALSO
57 .Xr intro 2 ,
58 .Xr psignal 3 ,
59 .Xr setlocale 3
60 .\" .Sh STANDARDS
61 .\" The
62 .\" .Fn strsignal
63 .\" function conforms to
64 .\" .St -p1003.1-2008 .