aboutsummaryrefslogtreecommitdiff
path: root/coreutils-5.3.0-bin/man/cat1p/kill.1p.txt
blob: 4a26aec4f79363d4744797f773e56584a954e9cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
kill(P)                                                 kill(P)





NAME
       kill - terminate or signal processes

SYNOPSIS
       kill -s signal_name pid ...

       kill -l [exit_status]



       kill [-signal_name] pid ...

       kill [-signal_number] pid ...


DESCRIPTION
       The  kill  utility shall send a signal to the process or
       processes specified by each pid operand.

       For each pid operand, the  kill  utility  shall  perform
       actions equivalent to the kill() function defined in the
       System Interfaces volume of IEEE Std 1003.1-2001  called
       with the following arguments:

              The value of the pid operand shall be used as the
              pid argument.

              The sig argument is the value specified by the -s
              option,  -  signal_number  option,  or the - sig-
              nal_name option, or by SIGTERM, if none of  these
              options is specified.

OPTIONS
       The  kill  utility shall conform to the Base Definitions
       volume of IEEE Std 1003.1-2001,  Section  12.2,  Utility
       Syntax Guidelines,  except that in the last two SYNOPSIS
       forms, the - signal_number and - signal_name options are
       usually more than a single character.

       The following options shall be supported:

       -l     (The letter ell.) Write all values of signal_name
              supported by the implementation, if no operand is
              given.  If an exit_status operand is given and it
              is a value of the '?'   shell  special  parameter
              (see  Special Parameters and wait() ) correspond-
              ing to a process that was terminated by a signal,
              the  signal_name corresponding to the signal that
              terminated the process shall be written.   If  an
              exit_status  operand  is  given  and  it  is  the
              unsigned decimal integer value of a  signal  num-
              ber,  the signal_name (the symbolic constant name
              without the SIG prefix defined in the Base  Defi-
              nitions  volume  of  IEEE Std 1003.1-2001) corre-
              sponding to that signal shall be written.  Other-
              wise, the results are unspecified.

       -s  signal_name

              Specify the signal to send, using one of the sym-
              bolic names defined  in  the  <signal.h>  header.
              Values  of  signal_name  shall be recognized in a
              case-independent fashion, without the SIG prefix.
              In   addition,  the  symbolic  name  0  shall  be
              recognized, representing the signal  value  zero.
              The corresponding signal shall be sent instead of
              SIGTERM.

       -signal_name

              Equivalent to -s signal_name.

       -signal_number

              Specify  a  non-negative  decimal  integer,  sig-
              nal_number,  representing  the  signal to be used
              instead of SIGTERM, as the sig  argument  in  the
              effective  call  to  kill().  The  correspondence
              between integer values and the sig value used  is
              shown in the following table.

       The  effects  of specifying any signal_number other than
       those listed in the table are undefined.


         signal_number     sig Value
         0                 0
         1                 SIGHUP
         2                 SIGINT
         3                 SIGQUIT
         6                 SIGABRT
         9                 SIGKILL
         14                SIGALRM
         15                SIGTERM

       If the first argument is a negative integer, it shall be
       interpreted  as a - signal_number option, not as a nega-
       tive pid operand specifying a process group.

OPERANDS
       The following operands shall be supported:

       pid    One of the following:

       A decimal integer specifying a process or process  group
       to  be  signaled.   The process or processes selected by
       positive, negative, and zero values of the  pid  operand
       shall  be  as  described  for  the  kill()  function. If
       process number 0 is specified, all processes in the cur-
       rent process group shall be signaled. For the effects of
       negative pid numbers, see the kill() function defined in
       the System Interfaces volume of IEEE Std 1003.1-2001. If
       the first pid operand is negative, it should be preceded
       by  "--" to keep it from being interpreted as an option.

       A job control job ID (see the Base Definitions volume of
       IEEE Std 1003.1-2001, Section 3.203, Job Control Job ID)
       that identifies a background process group  to  be  sig-
       naled.  The  job  control  job ID notation is applicable
       only for invocations of kill in the current shell execu-
       tion environment; see Shell Execution Environment .

       exit_status
              A  decimal  integer specifying a signal number or
              the exit status of a process terminated by a sig-
              nal.


STDIN
       Not used.

INPUT FILES
       None.

ENVIRONMENT VARIABLES
       The  following  environment  variables  shall affect the
       execution of kill:

       LANG   Provide a default value for the internationaliza-
              tion  variables  that are unset or null. (See the
              Base Definitions volume of  IEEE Std 1003.1-2001,
              Section  8.2,  Internationalization Variables for
              the precedence of internationalization  variables
              used  to  determine  the  values  of locale cate-
              gories.)

       LC_ALL If set to a non-empty string value, override  the
              values  of  all  the  other  internationalization
              variables.

       LC_CTYPE
              Determine the locale for  the  interpretation  of
              sequences  of  bytes  of  text data as characters
              (for example, single-byte as  opposed  to  multi-
              byte characters in arguments).

       LC_MESSAGES
              Determine  the  locale  that  should  be  used to
              affect the format and contents of diagnostic mes-
              sages written to standard error.

       NLSPATH
              Determine  the  location  of message catalogs for
              the processing of LC_MESSAGES .


ASYNCHRONOUS EVENTS
       Default.

STDOUT
       When the -l option is not specified, the standard output
       shall not be used.

       When  the  -l  option is specified, the symbolic name of
       each signal shall be written in the following format:


              "%s%c", <signal_name>, <separator>

       where the <signal_name> is in uppercase, without the SIG
       prefix,  and the <separator> shall be either a <newline>
       or a <space>. For the last signal  written,  <separator>
       shall be a <newline>.

       When  both  the  -l  option  and exit_status operand are
       specified, the symbolic name of the corresponding signal
       shall be written in the following format:


              "%s\n", <signal_name>

STDERR
       The  standard  error  shall  be used only for diagnostic
       messages.

OUTPUT FILES
       None.

EXTENDED DESCRIPTION
       None.

EXIT STATUS
       The following exit values shall be returned:

        0     At least one matching process was found for  each
              pid  operand,  and  the specified signal was suc-
              cessfully processed for  at  least  one  matching
              process.

       >0     An error occurred.


CONSEQUENCES OF ERRORS
       Default.

       The following sections are informative.

APPLICATION USAGE
       Process numbers can be found by using ps.

       The  job control job ID notation is not required to work
       as expected when kill is operating in  its  own  utility
       execution  environment. In either of the following exam-
       ples:


              nohup kill %1 &
              system("kill %1");

       the kill operates in a different  environment  and  does
       not share the shell's understanding of job numbers.

EXAMPLES
       Any of the commands:


              kill -9 100 -165
              kill -s kill 100 -165
              kill -s KILL 100 -165

       sends the SIGKILL signal to the process whose process ID
       is 100 and to all processes whose process  group  ID  is
       165, assuming the sending process has permission to send
       that signal to the specified processes,  and  that  they
       exist.

       The System Interfaces volume of IEEE Std 1003.1-2001 and
       this volume of IEEE Std 1003.1-2001 do not require  spe-
       cific  signal  numbers  for any signal_names. Even the -
       signal_number   option   provides   symbolic   (although
       numeric)  names  for signals. If a process is terminated
       by a signal, its exit status indicates the  signal  that
       killed  it,  but the exact values are not specified. The
       kill -l option, however, can be used to map decimal sig-
       nal  numbers  and  exit status values into the name of a
       signal. The following example reports the  status  of  a
       terminated job:


              job
              stat=$?
              if [ $stat -eq 0 ]
              then
                  echo job completed successfully.
              elif [ $stat -gt 128 ]
              then
                  echo job terminated by signal SIG$(kill -l $stat).
              else
                  echo job terminated with error code $stat.
              fi

       To send the default signal to a process group (say 123),
       an application should use a command similar  to  one  of
       the following:


              kill -TERM -123
              kill -- -123

RATIONALE
       The  -l  option originated from the C shell, and is also
       implemented in the KornShell. The  C  shell  output  can
       consist  of  multiple  output  lines  because the signal
       names do not always fit on a single line on some  termi-
       nal  screens.  The  KornShell  output  also included the
       implementation-defined signal numbers and was considered
       by  the  standard  developers  to  be  too difficult for
       scripts to parse conveniently. The specified output for-
       mat is intended not only to accommodate the historical C
       shell output, but also to permit an entirely vertical or
       entirely horizontal listing on systems for which this is
       appropriate.

       An early proposal invented the name SIGNULL  as  a  sig-
       nal_name  for  signal  0  (used by the System Interfaces
       volume of IEEE Std 1003.1-2001 to test for the existence
       of  a  process  without  sending it a signal). Since the
       signal_name 0 can be used in  this  case  unambiguously,
       SIGNULL has been removed.

       An early proposal also required symbolic signal_names to
       be recognized with or without the SIG prefix. Historical
       versions of kill have not written the SIG prefix for the
       -l option and have not recognized the SIG prefix on sig-
       nal_names.  Since  neither  applications portability nor
       ease-of-use would be improved by requiring  this  exten-
       sion, it is no longer required.

       To  avoid  an  ambiguity  of  an initial negative number
       argument specifying either a signal number or a  process
       group,  IEEE Std 1003.1-2001  mandates that it is always
       considered the former by  implementations  that  support
       the  XSI option. It also requires that conforming appli-
       cations always use the "--" options terminator  argument
       when  specifying  a  process  group, unless an option is
       also specified.

       The -s option was added  in  response  to  international
       interest  in  providing some form of kill that meets the
       Utility Syntax Guidelines.

       The job control job ID notation is not required to  work
       as  expected  when  kill is operating in its own utility
       execution environment. In either of the following  exam-
       ples:


              nohup kill %1 &
              system("kill %1");

       the  kill  operates  in a different environment and does
       not understand how the shell has managed  its  job  num-
       bers.

FUTURE DIRECTIONS
       None.

SEE ALSO
       Shell Command Language , ps , wait() , the System Inter-
       faces volume of IEEE Std 1003.1-2001, kill(),  the  Base
       Definitions volume of IEEE Std 1003.1-2001, <signal.h>

COPYRIGHT
       Portions  of  this  text are reprinted and reproduced in
       electronic form from  IEEE  Std  1003.1,  2003  Edition,
       Standard  for Information Technology -- Portable Operat-
       ing System Interface (POSIX), The Open Group Base Speci-
       fications Issue 6, Copyright (C) 2001-2003 by the Insti-
       tute of Electrical and Electronics  Engineers,  Inc  and
       The  Open Group. In the event of any discrepancy between
       this version and the original IEEE and  The  Open  Group
       Standard,  the original IEEE and The Open Group Standard
       is the referee document. The original  Standard  can  be
       obtained        online        at        http://www.open-
       group.org/unix/online.html .



POSIX                         2003                      kill(P)