Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / gen / sigignore.3
blob81be05cd8872a4d54cf5d16f0ea9b82e834707f8
1 .\"     $NetBSD: sigignore.3,v 1.3 2003/04/16 13:34:39 wiz Exp $
2 .\"
3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Klaus Klein.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd January 16, 2003
31 .Dt SIGIGNORE 3
32 .Os
33 .Sh NAME
34 .Nm sigignore
35 .Nd manipulate signal dispositions
36 .Sh LIBRARY
37 .Lb libc
38 .Sh SYNOPSIS
39 .In signal.h
40 .Ft int
41 .Fn sigignore "int sig"
42 .Sh DESCRIPTION
43 .Bf -symbolic
44 This interface is made obsolete by
45 .Xr sigaction 2 .
46 .Ef
47 .Pp
48 The
49 .Fn sigignore
50 function sets the disposition of the signal
51 .Fa sig
53 .Dv SIG_IGN .
54 .Sh RETURN VALUES
55 If successful, the
56 .Fn sigignore
57 function returns 0.
58 Otherwise \-1 is returned and
59 .Va errno
60 is set to indicate the error.
61 .Sh ERRORS
62 The
63 .Fn sigignore
64 function will fail if:
65 .Bl -tag -width Er
66 .It Bq Er EINVAL
67 The argument
68 .Fa sig
69 is not a valid signal number.
70 .It Bq Er EINVAL
71 An attempt is made to ignore a signal that cannot be ignored,
72 such as
73 .Dv SIGKILL
75 .Dv SIGSTOP .
76 .El
77 .Sh SEE ALSO
78 .Xr sigaction 2
79 .Sh STANDARDS
80 The
81 .Fn sigignore
82 function conforms to
83 .St -p1003.1-2001 .