utilities/ofp-kill.8.in

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