utilities/ovs-kill.8.in

   1 .TH ovs\-kill 8 "May 2008" "Open vSwitch" "Open vSwitch Manual"
   2 .ds PN ovs\-kill
   3
   4 .SH NAME
   5 ovs\-kill \- kills processes given their pidfiles
   6
   7 .SH SYNOPSIS
   8 .B ovs\-kill
   9 [\fIoptions\fR] \fIpidfile\fR [\fIpidfile\fR...]
  10
  11 .SH DESCRIPTION
  12 The \fBovs\-kill\fR program reads each \fIpidfile\fR specified on the
  13 command line and sends a signal to the program associated with it, if
  14 any.  It reads one line of text from \fIpidfile\fR, which must contain
  15 the PID of the process to kill as a text string.  It then uses
  16 \fBfcntl\fR(2) to verify that a process with the PID from the file
  17 owns a lock on \fIpidfile\fR before it sends the signal.
  18
  19 A \fIpidfile\fR whose name begins with \fB/\fR is used literally.
  20 Otherwise, \fB@RUNDIR@/\fR is prefixed.
  21
  22 This program exists for use by \fBovs\-switch\-setup\fR, which cannot
  23 easily implement its functionality since Perl has no portable
  24 interface to \fBfcntl\fR-based file locking.
  25
  26 .SH OPTIONS
  27 .TP
  28 \fB\-s \fInumber\fR|\fIname\fR, \fB\-\^\-signal=\fInumber\fR|\fIname\fR
  29 Sets the signal to be sent to each process.  Signals may be given by
  30 number (e.g. \fB1\fR) or by name (e.g. \fBHUP\fR or \fBSIGHUP\fR).
  31 By default, \fBSIGTERM\fR is sent.
  32
  33 .TP
  34 \fB\-f\fR, \fB\-\^\-force\fR
  35 Causes \fBovs\-kill\fR to ignore all errors without printing a message
  36 to \fBstderr\fR, and to exit with return code 0.
  37
  38 .so lib/common.man
  39
  40 .SH "EXIT CODE"
  41
  42 Without \fB\-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR exits with
  43 status 0 if at least one \fIpidfile\fR was given and the process
  44 represented by every \fIpidfile\fR was signaled successfully,
  45 otherwise with status 1.
  46
  47 With \fB\-f\fR or \fB\-\^\-force\fR, \fBovs\-kill\fR always exits with
  48 status 0.
  49
  50 .SH BUGS
  51
  52 There is a race between verifying the lock on \fIpidfile\fR and
  53 actually killing the process.
  54
  55 \fBovs\-kill\fR does not wait for the signaled processes to die before
  56 exiting.
  57
  58 .SH "SEE ALSO"
  59
  60 .BR ovs\-switch\-setup (8)