Remove building with NOCRYPTO option
[minix.git] / minix / man / man2 / sigaction.2
blobb95ade540af9ff89b69c6850b865665ae3045674
1 .TH SIGACTION 2
2 .SH NAME
3 sigaction, signal \- manage signal state and handlers
4 .SH SYNOPSIS
5 .ft B
6 #include <signal.h>
8 .in +5
9 .ti -5
10 int sigaction(int \fIsig\fP, const struct sigaction *\fIact\fP, struct sigaction *\fIoact\fP)
11 .in -5
12 .br
13 void (*signal(int \fIsig\fP, void (*\fIhandler\fP)(int)))(int);
14 .ft P
15 .SH DESCRIPTION
16 .de SP
17 .if t .sp 0.4
18 .if n .sp
20 .B Sigaction()
21 is used to examine, set, or modify the attributes of a signal.  The argument
22 .I sig
23 is the signal in question.  The
24 .I act
25 argument points to a structure containing the new attributes of the signal,
26 the structure pointed to by
27 .I oact
28 will receive the old attributes that were in effect before the call.
29 .PP
30 The
31 .I act
32 and
33 .I oact
34 arguments may be
35 .B NULL
36 to indicate that either no new attributes are to be set, or that the old
37 attributes are not of interest.
38 .PP
39 The structure containing the signal attributes is defined in <signal.h> and
40 looks like this:
41 .PP
42 .RS
43 .nf
44 .ft B
45 .ta +4n +12n
46 struct sigaction {
47         void    (*sa_handler)(int sig);
48         sigset_t        sa_mask;
49         int     sa_flags;
51 .ft R
52 .fi
53 .RE
54 .PP
55 The
56 .B sa_handler
57 field contains the address of a signal handler, a function that is called
58 when the process is signalled, or one of these special constants:
59 .PP
60 .TP 12
61 .B SIG_DFL
62 Default signal handling is to be performed.  This usually means that the
63 process is killed, but some signals may be ignored by default.
64 .TP
65 .B SIG_IGN
66 Ignore the signal.
67 .PP
68 The
69 .B sa_mask
70 field indicates a set of signals that must be blocked when the signal is
71 being handled.  Whether the signal
72 .I sig
73 itself is blocked when being handled is not controlled by this mask.  The
74 mask is of a "signal set" type that is to be manipulated by the
75 .BR sigset (3)
76 functions.
77 .PP
78 How the signal is handled precisely is specified by bits in
79 .BR sa_flags .
80 If none of the flags is set then the handler is called when the signal
81 arrives.  The signal is blocked during the call to the handler, and
82 unblocked when the handler returns.  A system call that is interrupted
83 returns
84 .B \-1
85 with
86 .B errno
87 set to
88 .BR EINTR .
89 The following bit flags can be set to modify this behaviour:
90 .PP
91 .TP 15
92 .B SA_RESETHAND
93 Reset the signal handler to
94 .B SIG_DFL
95 when the signal is caught.
96 .TP
97 .B SA_NODEFER
98 Do not block the signal on entry to the handler.
99 .TP
100 .B SA_COMPAT
101 Handle the signal in a way that is compatible with the the old
102 .B signal()
103 call.
105 The old
106 .B signal()
107 signal system call sets a signal handler for a given signal and returns the
108 old signal handler.  No signals are blocked, the flags are
109 .BR "SA_RESETHAND | SA_NODEFER | SA_COMPAT" .
110 New code should not use
111 .BR signal() .
112 Note that
113 .B signal()
114 and all of the
115 .B SA_*
116 flags are MINIX 3 extensions.
118 Signal handlers are reset to
119 .B SIG_DFL
120 on an
121 .BR execve (2).
122 Signals that are ignored stay ignored.
123 .SS Signals
124 MINIX 3 knows about the following signals:
127 .ta +11n +7n +8n
128 signal  num     notes   description
130 SIGHUP  1       km      Hangup
131 SIGINT  2       k       Interrupt (usually DEL or CTRL\-C)
132 SIGQUIT 3       kcm     Quit (usually CTRL\-\e)
133 SIGILL  4       Kc      Illegal instruction
134 SIGTRAP 5       Kc      Trace trap
135 SIGABRT 6       kcm     Abort program
136 SIGBUS  7       Kc      Bus error
137 SIGFPE  8       Kc      Floating point exception
138 SIGKILL 9       k       Kill
139 SIGUSR1 10      k       User defined signal #1
140 SIGSEGV 11      Kc      Segmentation fault
141 SIGUSR2 12      k       User defined signal #2
142 SIGPIPE 13      k       Write to a pipe with no reader
143 SIGALRM 14      k       Alarm clock
144 SIGTERM 15      km      Terminate (default for kill(1))
145 SIGEMT  16      xKc     Emulator trap
146 SIGCHLD 17      pi      Child process terminated
147 SIGCONT 18      pi      Continue if stopped
148 SIGSTOP 19      ps      Stop signal
149 SIGTSTP 20      ps      Interactive stop signal
150 SIGWINCH        21      xi      Window size change
151 SIGTTIN 22      ps      Background read
152 SIGTTOU 23      ps      Background write
153 SIGVTALRM       24      k       Virtual alarm clock
154 SIGPROF 25      k       Profiler alarm clock
155 .ft R
158 The letters in the notes column indicate:
160 .TP 5
161 .B k
162 The process is killed if the signal is not caught.
164 .B K
165 The process is killed if the signal is not caught. If the signal is received
166 due to an exception while ignored or masked, the process is killed even if a 
167 handler is defined to catch the signal.
169 .B c
170 The signal causes a core dump.
172 .B i
173 The signal is ignored if not caught.
175 .B m
176 The signal is converted to a message for system processes.
178 .B x
179 MINIX 3 extension, not defined by \s-2POSIX\s+2.
181 .B p
182 These signals are not implemented, but \s-2POSIX\s+2 requires that they are
183 defined.
185 .B s
186 The process should be stopped, but is killed instead.
189 .B SIGKILL
191 .B SIGSTOP
192 signals cannot be caught or ignored.  The
193 .B SIGILL
195 .B SIGTRAP
196 signals cannot be automatically reset.  The system silently enforces these
197 restrictions.  This may or may not be reflected by the attributes of these
198 signals and the signal masks.
199 .SS Types
200 \s-2POSIX\s+2 prescribes that <sys/types.h> has the following definition:
203 .B "typedef int (*sighandler_t)(int)"
206 With this type the following declarations can be made:
209 .ft B
211 sighandler_t sa_handler;
212 sighandler_t signal(int \fIsig\fP, sighandler_t \fIhandler\fP);
214 .ft R
217 This may help you to understand the earlier declarations better.  The
218 .B sighandler_t
219 type is also very useful in old style C code that is compiled by a compiler
220 for standard C.
221 .SH "SEE ALSO"
222 .BR kill (1),
223 .BR kill (2),
224 .BR pause (2),
225 .BR sigprocmask (2),
226 .BR sigsuspend (2),
227 .BR sigpending (2),
228 .BR sigset (3).
229 .SH DIAGNOSTICS
230 .B Sigaction()
231 returns
232 .B 0
233 on success or
234 .B \-1
235 on error.
236 .B Signal()
237 returns the old handler on success or
238 .B SIG_ERR
239 on error.  The error code may be:
241 .TP 10
242 .B EINVAL
243 Bad signal number.
245 .B EFAULT
247 .I act
249 .I oact
250 addresses.
251 .SH AUTHOR
252 Kees J. Bot (kjb@cs.vu.nl)
255 .\" $PchId: sigaction.2,v 1.2 1996/04/11 06:00:28 philip Exp $