usr/src/man/man1/kill.1

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
   5 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
   6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at  http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
   8 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
   9 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.opengroup.org/unix/online.html.
  10 .\"  This notice shall appear on any product containing this material.
  11 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  12 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
  13 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  14 .TH KILL 1 "Aug 11, 2009"
  15 .SH NAME
  16 kill \- terminate or signal processes
  17 .SH SYNOPSIS
  18 .LP
  19 .nf
  20 \fB/usr/bin/kill\fR \fB-s\fR \fIsignal_name\fR \fIpid\fR...
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fB/usr/bin/kill\fR \fB-l\fR [\fIexit_status\fR]
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fB/usr/bin/kill\fR [\fB-\fIsignal_name\fR\fR] \fIpid\fR...
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fB/usr/bin/kill\fR [\fB-\fIsignal_number\fR\fR] \fIpid\fR...
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBkill\fR utility sends a signal to the process or processes specified by
  42 each \fIpid\fR operand.
  43 .sp
  44 .LP
  45 For each \fIpid\fR operand, the \fBkill\fR utility performs actions equivalent
  46 to the \fBkill\fR(2) function called with the following arguments:
  47 .RS +4
  48 .TP
  49 1.
  50 The value of the \fIpid\fR operand is used as the \fIpid\fR argument.
  51 .RE
  52 .RS +4
  53 .TP
  54 2.
  55 The \fIsig\fR argument is the value specified by the \fB-s\fR option, the
  56 \fB-\fR\fIsignal_name\fR option, or the \fB-\fR\fIsignal_number\fR option, or,
  57 if none of these options is specified, by \fBSIGTERM\fR.
  58 .RE
  59 .sp
  60 .LP
  61 The signaled process must belong to the current user unless the user is the
  62 super-user.
  63 .sp
  64 .LP
  65 See NOTES for descriptions of the shell built-in versions of \fBkill\fR.
  66 .SH OPTIONS
  67 .sp
  68 .LP
  69 The following options are supported:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-l\fR\fR
  74 .ad
  75 .RS 18n
  76 (The letter ell.) Writes all values of \fIsignal_name\fR supported by the
  77 implementation, if no operand is specified. If an \fIexit_status\fR operand is
  78 specified and it is a value of the \fB?\fR shell special parameter and
  79 \fBwait\fR corresponding to a process that was terminated by a signal, the
  80 \fIsignal_name\fR corresponding to the signal that terminated the process is
  81 written. If an \fIexit_status\fR operand is specified and it is the unsigned
  82 decimal integer value of a signal number, the \fIsignal_name\fR corresponding
  83 to that signal is written. Otherwise, the results are unspecified.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-s\fR \fIsignal_name\fR\fR
  90 .ad
  91 .RS 18n
  92 Specifies the signal to send, using one of the symbolic names defined in the
  93 \fB<signal.h>\fR description. Values of \fIsignal_name\fR is recognized in a
  94 case-independent fashion, without the \fBSIG\fR prefix. In addition, the
  95 symbolic name \fB0\fR is recognized, representing the signal value zero. The
  96 corresponding signal is sent instead of \fBSIGTERM\fR.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-\fR\fIsignal_name\fR\fR
 103 .ad
 104 .RS 18n
 105 Equivalent to \fB-s\fR \fIsignal_name\fR.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB-\fR\fIsignal_number\fR\fR
 112 .ad
 113 .RS 18n
 114 Specifies a non-negative decimal integer, \fIsignal_number\fR, representing the
 115 signal to be used instead of \fBSIGTERM\fR, as the \fIsig\fR argument in the
 116 effective call to \fBkill\fR(2).
 117 .RE
 118
 119 .SH OPERANDS
 120 .sp
 121 .LP
 122 The following operands are supported:
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fIpid\fR\fR
 127 .ad
 128 .RS 15n
 129 One of the following:
 130 .RS +4
 131 .TP
 132 1.
 133 A decimal integer specifying a process or process group to be signaled. The
 134 process or processes selected by positive, negative and zero values of the
 135 \fIpid\fR operand is as described for the kill function. If process number 0 is
 136 specified, all processes in the process group are signaled. If the first
 137 \fIpid\fR operand is negative, it should be preceded by \fB\(mi\(mi\fR to keep
 138 it from being interpreted as an option.
 139 .RE
 140 .RS +4
 141 .TP
 142 2.
 143 A job control job \fBID\fR that identifies a background process group to be
 144 signaled. The job control job \fBID\fR notation is applicable only for
 145 invocations of \fBkill\fR in the current shell execution environment.
 146 .RE
 147 The job control job \fBID\fR type of \fIpid\fR is available only on systems
 148 supporting the job control option.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fIexit_status\fR\fR
 155 .ad
 156 .RS 15n
 157 A decimal integer specifying a signal number or the exit status of a process
 158 terminated by a signal.
 159 .RE
 160
 161 .SH USAGE
 162 .sp
 163 .LP
 164 Process numbers can be found by using \fBps\fR(1).
 165 .sp
 166 .LP
 167 The job control job \fBID\fR notation is not required to work as expected when
 168 \fBkill\fR is operating in its own utility execution environment. In either of
 169 the following examples:
 170 .sp
 171 .in +2
 172 .nf
 173 example% \fBnohup kill %1 &\fR
 174 example% \fBsystem( "kill %1");\fR
 175 .fi
 176 .in -2
 177 .sp
 178
 179 .sp
 180 .LP
 181 \fBkill\fR operates in a different environment and does not share the shell's
 182 understanding of job numbers.
 183 .SH OUTPUT
 184 .sp
 185 .LP
 186 When the \fB-l\fR option is not specified, the standard output is not be used.
 187 .sp
 188 .LP
 189 When the \fB-l\fR option is specified, the symbolic name of each signal is
 190 written in the following format:
 191 .sp
 192 .in +2
 193 .nf
 194 "%s%c", <\fIsignal_name\fR>, <\fIseparator\fR>
 195 .fi
 196 .in -2
 197
 198 .sp
 199 .LP
 200 where the \fB<\fR\fIsignal_name\fR\fB>\fR is in upper-case, without the
 201 \fBSIG\fR prefix, and the \fB<\fR\fIseparator\fR\fB>\fR is either a newline
 202 character or a space character. For the last signal written,
 203 \fB<\fR\fIseparator\fR\fB>\fR is a newline character.
 204 .sp
 205 .LP
 206 When both the \fB-l\fR option and \fIexit_status\fR operand are specified, the
 207 symbolic name of the corresponding signal is written in the following format:
 208 .sp
 209 .in +2
 210 .nf
 211 "%s\en", <\fIsignal_name\fR>
 212 .fi
 213 .in -2
 214
 215 .SH EXAMPLES
 216 .LP
 217 \fBExample 1 \fRSending the kill signal
 218 .sp
 219 .LP
 220 Any of the commands:
 221
 222 .sp
 223 .in +2
 224 .nf
 225 example% \fBkill -9 100 -165\fR
 226 example% \fBkill -s kill 100 -165\fR
 227 example% \fBkill -s KILL 100 -165\fR
 228 .fi
 229 .in -2
 230 .sp
 231
 232 .sp
 233 .LP
 234 sends the \fBSIGKILL\fR signal to the process whose process \fBID\fR is
 235 \fB100\fR and to all processes whose process group \fBID\fR is \fB165\fR,
 236 assuming the sending process has permission to send that signal to the
 237 specified processes, and that they exist.
 238
 239 .LP
 240 \fBExample 2 \fRAvoiding ambiguity with an initial negative number
 241 .sp
 242 .LP
 243 To avoid an ambiguity of an initial negative number argument specifying either
 244 a signal number or a process group, the former is always be the case.
 245 Therefore, to send the default signal to a process group (for example,
 246 \fB123\fR), an application should use a command similar to one of the
 247 following:
 248
 249 .sp
 250 .in +2
 251 .nf
 252 example% \fBkill -TERM -123\fR
 253 example% \fBkill -- -123\fR
 254 .fi
 255 .in -2
 256 .sp
 257
 258 .SH ENVIRONMENT VARIABLES
 259 .sp
 260 .LP
 261 See \fBenviron\fR(5) for descriptions of the following environment variables
 262 that affect the execution of \fBkill\fR: \fBLANG\fR, \fBLC_ALL\fR,
 263 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 264 .SH EXIT STATUS
 265 .sp
 266 .LP
 267 The following exit values are returned:
 268 .sp
 269 .ne 2
 270 .na
 271 \fB\fB0\fR\fR
 272 .ad
 273 .RS 6n
 274 At least one matching process was found for each \fIpid\fR operand, and the
 275 specified signal was successfully processed for at least one matching process.
 276 .RE
 277
 278 .sp
 279 .ne 2
 280 .na
 281 \fB\fB>0\fR\fR
 282 .ad
 283 .RS 6n
 284 An error occurred.
 285 .RE
 286
 287 .SH ATTRIBUTES
 288 .sp
 289 .LP
 290 See \fBattributes\fR(5) for descriptions of the following attributes:
 291 .SS "/usr/bin/kill, csh, ksh, sh"
 292 .sp
 293
 294 .sp
 295 .TS
 296 box;
 297 c | c
 298 l | l .
 299 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 300 _
 301 CSI     Enabled
 302 _
 303 Interface Stability     Committed
 304 _
 305 Standard        See \fBstandards\fR(5).
 306 .TE
 307
 308 .SS "ksh93"
 309 .sp
 310
 311 .sp
 312 .TS
 313 box;
 314 c | c
 315 l | l .
 316 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 317 _
 318 CSI     Enabled
 319 _
 320 Interface Stability     Uncommitted
 321 .TE
 322
 323 .SH SEE ALSO
 324 .sp
 325 .LP
 326 \fBcsh\fR(1), \fBgetconf\fR(1), \fBjobs\fR(1), \fBksh\fR(1), \fBksh93\fR(1),
 327 \fBps\fR(1), \fBsh\fR(1), \fBshell_builtins\fR(1), \fBwait\fR(1),
 328 \fBkill\fR(2), \fBsignal\fR(3C), \fBsignal.h\fR(3HEAD), \fBattributes\fR(5),
 329 \fBenviron\fR(5), \fBstandards\fR(5)
 330 .SH NOTES
 331 .SS "/usr/bin/kill"
 332 .sp
 333 .LP
 334 The number of realtime signals supported is defined by the \fBgetconf\fR(1)
 335 value \fB_POSIX_RTSIG_MAX\fR.
 336 .SS "sh"
 337 .sp
 338 .LP
 339 The Bourne shell, \fBsh\fR, has a built-in version of \fBkill\fR to provide the
 340 functionality of the \fBkill\fR command for processes identified with a
 341 \fIjobid\fR. The \fBsh\fR syntax is:
 342 .sp
 343 .in +2
 344 .nf
 345 kill [ -sig ] [ pid ] [ %job ]...
 346 kill -l
 347 .fi
 348 .in -2
 349 .sp
 350
 351 .SS "csh"
 352 .sp
 353 .LP
 354 The C-shell, \fBcsh\fR, also has a built-in \fBkill\fR command, whose syntax
 355 is:
 356 .sp
 357 .in +2
 358 .nf
 359 kill [-sig][pid][%job]...
 360 kill -l
 361 .fi
 362 .in -2
 363 .sp
 364
 365 .sp
 366 .LP
 367 The \fBcsh\fR \fBkill\fR built-in sends the \fBTERM\fR (terminate) signal, by
 368 default, or the signal specified, to the specified process \fBID\fR, the
 369 \fIjob\fR indicated, or the current \fIjob\fR. Signals are either specified by
 370 number or by name. There is no default. Typing \fBkill\fR does not send a
 371 signal to the current job. If the signal being sent is \fBTERM\fR (terminate)
 372 or \fBHUP\fR (hangup), then the job or process is sent a \fBCONT\fR (continue)
 373 signal as well.
 374 .sp
 375 .ne 2
 376 .na
 377 \fB\fB-l\fR\fR
 378 .ad
 379 .RS 6n
 380 Lists the signal names that can be sent.
 381 .RE
 382
 383 .SS "ksh"
 384 .sp
 385 .LP
 386 The syntax of the \fBksh\fR \fBkill\fR is:
 387 .sp
 388 .in +2
 389 .nf
 390 kill [-sig][pid][%job]...
 391 kill -l
 392 .fi
 393 .in -2
 394 .sp
 395
 396 .sp
 397 .LP
 398 The \fBksh\fR \fBkill\fR sends either the \fBTERM\fR (terminate) signal or the
 399 specified signal to the specified jobs or processes. Signals are either
 400 specified by number or by names (as specified in \fBsignal.h\fR(3HEAD) stripped
 401 of the \fBSIG\fR prefix). If the signal being sent is \fBTERM\fR (terminate) or
 402 \fBHUP\fR (hangup), then the job or process is sent a \fBCONT\fR (continue)
 403 signal if it is stopped. The argument \fIjob\fR can be the process id of a
 404 process that is not a member of one of the active jobs. In the second form,
 405 \fBkill\fR \fB-l\fR, the signal numbers and names are listed.
 406 .SS "ksh93"
 407 .sp
 408 .LP
 409 The syntax of the \fBksh93\fR \fBkill\fR is:
 410 .sp
 411 .in +2
 412 .nf
 413 kill [-n signum] [-s signame] job ...
 414 kill [-n signum] [-s signame] -l [arg ...]
 415 .fi
 416 .in -2
 417 .sp
 418
 419 .sp
 420 .LP
 421 With the first form in which \fB-l\fR is not specified, \fBkill\fR sends a
 422 signal to one or more processes specified by \fIjob\fR. This normally
 423 terminates the processes unless the signal is being caught or ignored.
 424 .sp
 425 .LP
 426 Specify \fIjob\fR as one of the following:
 427 .sp
 428 .ne 2
 429 .na
 430 \fB\fInumber\fR\fR
 431 .ad
 432 .RS 12n
 433 The process id of \fIjob\fR.
 434 .RE
 435
 436 .sp
 437 .ne 2
 438 .na
 439 \fB\fB-\fR\fInumber\fR\fR
 440 .ad
 441 .RS 12n
 442 The process group id of \fIjob\fR.
 443 .RE
 444
 445 .sp
 446 .ne 2
 447 .na
 448 \fB\fB%\fR\fInumber\fR\fR
 449 .ad
 450 .RS 12n
 451 The job number.
 452 .RE
 453
 454 .sp
 455 .ne 2
 456 .na
 457 \fB\fB%\fR\fIstring\fR\fR
 458 .ad
 459 .RS 12n
 460 The job whose name begins with \fIstring\fR.
 461 .RE
 462
 463 .sp
 464 .ne 2
 465 .na
 466 \fB\fB%?\fR\fIstring\fR\fR
 467 .ad
 468 .RS 12n
 469 The job whose name contains \fIstring\fR.
 470 .RE
 471
 472 .sp
 473 .ne 2
 474 .na
 475 \fB\fB%+\fR\fR
 476 .ad
 477 .br
 478 .na
 479 \fB\fB%%\fR\fR
 480 .ad
 481 .RS 12n
 482 The current job.
 483 .RE
 484
 485 .sp
 486 .ne 2
 487 .na
 488 \fB\fB%-\fR\fR
 489 .ad
 490 .RS 12n
 491 The previous job.
 492 .RE
 493
 494 .sp
 495 .LP
 496 If the signal is not specified with either the \fB-n\fR or the \fB-s\fR option,
 497 the \fBSIGTERM\fR signal is used.
 498 .sp
 499 .LP
 500 If \fB-l\fR is specified, and no \fIarg\fR is specified, then \fBkill\fR writes
 501 the list of signals to standard output. Otherwise, \fIarg\fR can be either a
 502 signal name, or a number representing either a signal number or exit status for
 503 a process that was terminated due to a signal. If a name is specified  the
 504 corresponding signal number is written to standard output. If a number is
 505 specified the corresponding signal name is written to standard output.
 506 .sp
 507 .ne 2
 508 .na
 509 \fB\fB-l\fR\fR
 510 .ad
 511 .RS 14n
 512 List signal names or signal numbers rather than sending signals as described
 513 above. The \fB-n\fR and \fB-s\fR options cannot be specified.
 514 .RE
 515
 516 .sp
 517 .ne 2
 518 .na
 519 \fB\fB-n\fR \fIsignum\fR\fR
 520 .ad
 521 .RS 14n
 522 Specify a signal number to send. Signal numbers are not portable across
 523 platforms, except for the following:
 524 .sp
 525 .ne 2
 526 .na
 527 \fB\fB0\fR\fR
 528 .ad
 529 .RS 6n
 530 No signal.
 531 .RE
 532
 533 .sp
 534 .ne 2
 535 .na
 536 \fB\fB1\fR\fR
 537 .ad
 538 .RS 6n
 539 \fBHUP\fR
 540 .RE
 541
 542 .sp
 543 .ne 2
 544 .na
 545 \fB\fB2\fR\fR
 546 .ad
 547 .RS 6n
 548 \fBINT\fR
 549 .RE
 550
 551 .sp
 552 .ne 2
 553 .na
 554 \fB\fB3\fR\fR
 555 .ad
 556 .RS 6n
 557 \fBQUIT\fR
 558 .RE
 559
 560 .sp
 561 .ne 2
 562 .na
 563 \fB\fB6\fR\fR
 564 .ad
 565 .RS 6n
 566 \fBABRT\fR
 567 .RE
 568
 569 .sp
 570 .ne 2
 571 .na
 572 \fB\fB9\fR\fR
 573 .ad
 574 .RS 6n
 575 \fBKILL\fR
 576 .RE
 577
 578 .sp
 579 .ne 2
 580 .na
 581 \fB\fB14\fR\fR
 582 .ad
 583 .RS 6n
 584 \fBALRM\fR
 585 .RE
 586
 587 .sp
 588 .ne 2
 589 .na
 590 \fB\fB15\fR\fR
 591 .ad
 592 .RS 6n
 593 \fBTERM\fR
 594 .RE
 595
 596 .RE
 597
 598 .sp
 599 .ne 2
 600 .na
 601 \fB\fB-s\fR \fIsigname\fR\fR
 602 .ad
 603 .RS 14n
 604 Specify a signal name to send. The signal names are derived from their names in
 605 \fB<signal.h>\fR without the \fBSIG\fR prefix and are case insensitive.
 606 \fBkill\fR \fB-l\fR generates the list of signals on the current platform.
 607 .RE
 608
 609 .sp
 610 .LP
 611 \fBkill\fR in \fBksh93\fR exits with one of the following values:
 612 .sp
 613 .ne 2
 614 .na
 615 \fB\fB0\fR\fR
 616 .ad
 617 .RS 6n
 618 At least one matching process was found for each job operand, and the specified
 619 signal was successfully sent to at least one matching process.
 620 .RE
 621
 622 .sp
 623 .ne 2
 624 .na
 625 \fB\fB>0\fR\fR
 626 .ad
 627 .RS 6n
 628 An error occurred.
 629 .RE
 630