diff options
author | sandra <sandra> | 1991-08-28 18:40:14 +0000 |
---|---|---|
committer | sandra <sandra> | 1991-08-28 18:40:14 +0000 |
commit | a6267a5653f6f8f4d1edb065393003b0caea1cd7 (patch) | |
tree | 44d6285ee1d6eeed399fa9d353895923a66bc40a /manual/signal.texi | |
parent | acc7e071384c2aa5552d20df966b262e20529797 (diff) |
Change @defvr to @deftypevr, identifying types of all macros.
Diffstat (limited to 'manual/signal.texi')
-rw-r--r-- | manual/signal.texi | 159 |
1 files changed, 79 insertions, 80 deletions
diff --git a/manual/signal.texi b/manual/signal.texi index d0c340b91f..b1b9cc1c8d 100644 --- a/manual/signal.texi +++ b/manual/signal.texi @@ -105,10 +105,10 @@ are used for. @comment signal.h @comment GNU -@defvr Macro NSIG +@deftypevr Macro int NSIG The value of this symbolic constant is the total number of signals defined. -@end defvr +@end deftypevr @menu * Program Error Signals:: Used to report serious program errors. @@ -138,7 +138,7 @@ horribly unless the signals were generated by @code{raise} or @comment signal.h @comment ANSI -@defvr Macro SIGFPE +@deftypevr Macro int SIGFPE The @code{SIGFPE} signal reports a fatal arithmetic error. Although the name is derived from ``floating-point exception'', this signal actually covers all arithmetic errors, including division by zero and overflow. @@ -161,11 +161,11 @@ If you're writing a library of numeric routines that has to be able to trap and deal with the different kinds of exceptions intelligently, you'll have to look at the documentation for your specific computer and operating system to find out how. -@end defvr +@end deftypevr @comment signal.h @comment ANSI -@defvr Macro SIGILL +@deftypevr Macro int SIGILL The name of this signal is derived from ``illegal instruction''; it means your program is trying to execute garbage or a privileged instruction. In a C program, this typically indicates that the @@ -175,12 +175,12 @@ invalid object where a pointer to a function was expected, or by writing past the end of an automatic array (or similar problems with pointers to automatic variables) and corrupting control information on the stack, like a return address from a function call. -@end defvr +@end deftypevr @cindex illegal instruction @comment signal.h @comment ANSI -@defvr Macro SIGSEGV +@deftypevr Macro int SIGSEGV This signal is generated when a program tries to read or write outside the memory that is allocated for it. (Actually, the signals only occur when the program goes far enough outside to be detected by the system's @@ -191,12 +191,12 @@ The most common way of getting a @code{SIGSEGV} condition is by dereferencing a null or uninitialized pointer. Another typical way of getting into a @code{SIGSEGV} situation is when you use a pointer to step through an array, but fail to check for the end of the array. -@end defvr +@end deftypevr @cindex segment violation @comment signal.h @comment BSD -@defvr Macro SIGBUS +@deftypevr Macro int SIGBUS This signal is generated when an invalid pointer is dereferenced. Like @code{SIGSEGV}, this signal is typically the result of dereferencing an uninitialized pointer. The difference between the two is that @@ -206,7 +206,7 @@ uninitialized pointer. The difference between the two is that pointer. The name of this signal is an abbreviation for ``bus error''. -@end defvr +@end deftypevr @node Termination Signals @@ -228,16 +228,16 @@ process to terminate. @comment signal.h @comment ANSI -@defvr Macro SIGABRT +@deftypevr Macro int SIGABRT This signal indicates an error detected by the program itself, which causes abnormal program termination. The @code{abort} function (@xref{Aborting a Program}) generates this signal. -@end defvr +@end deftypevr @cindex abort signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGHUP +@deftypevr Macro int SIGHUP The @code{SIGHUP} (``hang-up'') signal is used to report that the user's terminal is disconnected, perhaps because a network or telephone connection was broken. For more information about this, @pxref{Control @@ -247,12 +247,12 @@ This signal is also used to report the termination of the controlling process on a terminal to jobs associated with that session; in effect, this reports that a process has been disconnected from its controlling terminal. For more information, @pxref{Process Termination Details}. -@end defvr +@end deftypevr @cindex hangup signal @comment signal.h @comment ANSI -@defvr Macro SIGINT +@deftypevr Macro int SIGINT The @code{SIGINT} (``program interrupt'') signal is sent when the user types the INTR character (normally @kbd{C-c}). @xref{Special Characters}, for information about terminal driver support. @@ -261,23 +261,23 @@ You might want to establish a handler for this signal in order to make your program terminate cleanly, performing whatever tidying-up actions are appropriate first. For example, you might want to write out state information to a file, release locks on resources, and the like. -@end defvr +@end deftypevr @cindex interrupt signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGQUIT +@deftypevr Macro int SIGQUIT The @code{SIGQUIT} signal is similar to @code{SIGINT}, except that it's controlled by a different key --- the QUIT character, usually @kbd{C-\} --- and produces a core dump when it terminates the process. @xref{Special Characters}, for information about terminal driver support. -@end defvr +@end deftypevr @cindex quit signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGKILL +@deftypevr Macro int SIGKILL The @code{SIGKILL} signal is used to cause immediate program termination. It cannot be caught or ignored, and is therefore always fatal. It is also not possible to block this signal. @@ -286,19 +286,19 @@ This signal occurs only on explicit request by a user program. You would use it when you want to immediately terminate a program. For example, if a process is not responding to any other termination signals, sending it a @code{SIGKILL} signal will almost always cause it to go away. -@end defvr +@end deftypevr @cindex kill signal @comment signal.h @comment ANSI -@defvr Macro SIGTERM +@deftypevr Macro int SIGTERM The @code{SIGTERM} signal is a generic signal used to cause program termination. Unlike @code{SIGKILL}, this signal can be blocked, caught, or ignored. The shell command @code{kill} generates @code{SIGTERM} by default. @pindex kill -@end defvr +@end deftypevr @cindex termination signal @@ -315,29 +315,29 @@ use these signals, you should normally provide a signal handler. @comment signal.h @comment POSIX.1 -@defvr Macro SIGALRM +@deftypevr Macro int SIGALRM This signal typically indicates expiration of a timer that measures real or clock time. It is used by the @code{alarm} function, for example. -@end defvr +@end deftypevr @cindex alarm signal @comment signal.h @comment BSD -@defvr Macro SIGVTALRM +@deftypevr Macro int SIGVTALRM This signal typically indicates expiration of a timer that measures CPU time used by the current process. The name is an abbreviation for ``virtual time alarm''. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SIGPROF +@deftypevr Macro int SIGPROF This signal is typically indicates expiration of a timer that measures both CPU time used by the current process, and CPU time expended on behalf of the process by the system. Such a timer is used to implement code profiling facilities, hence the name of this signal. -@end defvr +@end deftypevr @node Asynchronous I/O Signals @@ -351,17 +351,17 @@ for these signals is to ignore them. @comment signal.h @comment BSD -@defvr Macro SIGIO +@deftypevr Macro int SIGIO This signal is sent when a file descriptor is ready to perform input or output. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SIGURG +@deftypevr Macro int SIGURG This signal is sent when ``urgent'' or out-of-band data arrives on a socket. @xref{Out-of-Band Data}. -@end defvr +@end deftypevr @node Miscellaneous Signals @@ -372,7 +372,7 @@ action for all of them is to cause the process to terminate. @comment signal.h @comment POSIX.1 -@defvr Macro SIGPIPE +@deftypevr Macro int SIGPIPE If you use pipes or FIFO special files, you have to design your application so that one process opens the pipe for reading before another starts writing. If the reading process never starts, or @@ -381,17 +381,17 @@ process to receive a @code{SIGPIPE} signal. Pipes and FIFO special files are discussed in more detail in @ref{Pipes and FIFOs}. -@end defvr +@end deftypevr @cindex pipe signal @cindex broken pipe signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGUSR1 -@end defvr +@deftypevr Macro int SIGUSR1 +@end deftypevr @comment signal.h @comment POSIX.1 -@defvr Macro SIGUSR2 +@deftypevr Macro int SIGUSR2 The @code{SIGUSR1} and @code{SIGUSR2} signals are set aside for you to use any way you want. They're useful for interprocess communication. Since these signals are normally fatal, you should write a signal handler @@ -399,7 +399,7 @@ for them in the program that receives the signal. There is an example showing the use of @code{SIGUSR1} and @code{SIGUSR2} in @ref{Signaling Another Process}. -@end defvr +@end deftypevr @cindex user signals @@ -415,7 +415,7 @@ understand how job control works. @xref{Job Control}. @comment signal.h @comment POSIX.1 -@defvr Macro SIGCHLD +@deftypevr Macro int SIGCHLD This signal is sent to a parent process whenever one of its child processes terminates or stops. @@ -425,29 +425,29 @@ that have terminated but not reported their status via @code{wait} or @code{waitpid} (@pxref{Process Completion}), whether your new handler applies to those processes or not depends on the particular operating system. -@end defvr +@end deftypevr @cindex child process signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGCONT +@deftypevr Macro int SIGCONT You can send a @code{SIGCONT} signal to a process to make it continue. The default behavior for this signal is to make the process continue if it is stopped, and for it to be ignored otherwise. -@end defvr +@end deftypevr @cindex continue signal @comment signal.h @comment POSIX.1 -@defvr Macro SIGSTOP +@deftypevr Macro int SIGSTOP The @code{SIGSTOP} signal stops the process. It cannot be caught or ignored. -@end defvr +@end deftypevr @cindex stop signals @comment signal.h @comment POSIX.1 -@defvr Macro SIGTSTP +@deftypevr Macro int SIGTSTP The @code{SIGTSTP} signal is an interactive stop signal. Unlike @code{SIGSTOP}, this signal can be caught or ignored. Typically, you trap this signal only if you have a special need to leave files or @@ -456,26 +456,26 @@ system tables in a secure state when a process is stopped. This signal is generated when the user types the SUSP character (normally @kbd{C-z}). For more information about terminal driver support, @pxref{Special Characters}. -@end defvr +@end deftypevr @comment signal.h @comment POSIX.1 -@defvr Macro SIGTTIN +@deftypevr Macro int SIGTTIN A process cannot read from the the user's terminal while it is running as a background job. When any process in a background job tries to read from the terminal, all of the processes in the job are sent a @code{SIGTTIN} signal. The default action for this signal is to stop the process. For more information about how this interacts with the terminal driver, @pxref{Access to the Controlling Terminal}. -@end defvr +@end deftypevr @comment signal.h @comment POSIX.1 -@defvr Macro SIGTTOU +@deftypevr Macro int SIGTTOU This is similar to @code{SIGTTIN}, but is used when a process in a background job attempts to write to the terminal. Again, the default action is to stop the process. -@end defvr +@end deftypevr While a process is stopped, no more signals can be delivered to it until it is continued, except @code{SIGKILL} signals and (obviously) @@ -738,26 +738,25 @@ provided only for compatibility with SVID. @comment signal.h @comment ANSI -@defvr Macro SIG_DFL -The value of this macro is an object of the appropriate type for use as -the @var{action} argument to the @code{signal} function. It tells the -system to use the default handling for the signal. -@end defvr +@deftypevr Macro __sighandler_t SIG_DFL +This macro can be used as the @var{action} argument to the @code{signal} +function. It tells the system to use the default handling for the +signal. +@end deftypevr @comment signal.h @comment ANSI -@defvr Macro SIG_IGN -The value of this macro is an object of the appropriate type for use as -the @var{action} argument to the @code{signal} function. It tells the -system to ignore the signal. -@end defvr +@deftypevr Macro __sighandler_t SIG_IGN +This macro can be used as the @var{action} argument to the @code{signal} +function. It tells the system to ignore the signal. +@end deftypevr @comment signal.h @comment ANSI -@defvr Macro SIG_ERR +@deftypevr Macro __sighandler_t SIG_ERR The value of this macro is used as the return value from @code{signal} to indicate an error. -@end defvr +@end deftypevr @ignore @comment RMS says that ``we don't do this''. @@ -938,28 +937,28 @@ These macros are defined in the header file @file{signal.h}. @comment signal.h @comment POSIX.1 -@defvr Macro SA_NOCLDSTOP +@deftypevr Macro int SA_NOCLDSTOP The value of this macro is an integer constant that can be used as a flag for @code{sa_flags} when setting up an action for the @code{SIGCHLD} signal. When the flag is set, the system delivers the signal for a terminated child process but not for one that is stopped. By default, @code{SIGCHLD} is delivered for both terminated children and stopped children. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SA_ONSTACK +@deftypevr Macro int SA_ONSTACK If this flag is set, the system uses the signal stack when delivering the signal. @xref{BSD Signal Handling}. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SA_RESTART +@deftypevr Macro int SA_RESTART If this flag is set, system calls interrupted by a signal return with an @code{EINTR} error instead of restarting. -@end defvr +@end deftypevr @@ -1740,28 +1739,28 @@ again. @comment signal.h @comment POSIX.1 -@defvr Macro SIG_BLOCK +@deftypevr Macro int SIG_BLOCK The value of this macro is an integer suitable for use as the @var{how} argument to @code{sigprocmask}, to specify that the process signal mask should be set to the union of the specified set with the current process signal mask. -@end defvr +@end deftypevr @comment signal.h @comment POSIX.1 -@defvr Macro SIG_UNBLOCK +@deftypevr Macro int SIG_UNBLOCK The value of this macro is an integer suitable for use as the @var{how} argument to @code{sigprocmask}, to specify that the signals in the specified set should be removed from the current process signal mask. -@end defvr +@end deftypevr @comment signal.h @comment POSIX.1 -@defvr Macro SIG_SETMASK +@deftypevr Macro int SIG_SETMASK The value of this macro is an integer suitable for use as the @var{how} argument to @code{sigprocmask}, to specify that the process signal mask should be set to the specified signal set. -@end defvr +@end deftypevr Temporary blocking of signals with @code{sigprocmask} is useful primarily when you want to lock out interrupts during critical parts @@ -2162,28 +2161,28 @@ mask value, so you bitwise-OR the flags of interest to you together. @comment signal.h @comment BSD -@defvr Macro SV_ONSTACK +@deftypevr Macro int SV_ONSTACK This macro can be used with the @code{sv_flags} field of a @code{sigvec} structure, to specify that the signal stack should be used when delivering the signal. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SV_INTERRUPT +@deftypevr Macro int SV_INTERRUPT This macro can be used with the @code{sv_flags} field of a @code{sigvec} structure, to specify that interrupted system calls should not be restarted. If this flag is set, interrupted system calls return with a @code{EINTR} error status. -@end defvr +@end deftypevr @comment signal.h @comment BSD -@defvr Macro SV_RESETHAND +@deftypevr Macro int SV_RESETHAND This macro can be used with the @code{sv_flags} field of a @code{sigvec} structure, to specify that the action for the signal should be reset back to @code{SIG_DFL} when the signal is received. -@end defvr +@end deftypevr @comment signal.h @comment BSD |