release/src/router/mysql/man/mysql_waitpid.1

   1 '\" t
   2 .\"     Title: \fBmysql_waitpid\fR
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
   5 .\"      Date: 11/04/2013
   6 .\"    Manual: MySQL Database System
   7 .\"    Source: MySQL 5.1
   8 .\"  Language: English
   9 .\"
  10 .TH "\FBMYSQL_WAITPID\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .\" mysql_waitpid
  31 .SH "NAME"
  32 mysql_waitpid \- kill process and wait for its termination
  33 .SH "SYNOPSIS"
  34 .HP \w'\fBmysql_waitpid\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIpid\fR\fR\fB\ \fR\fB\fIwait_time\fR\fR\ 'u
  35 \fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR
  36 .SH "DESCRIPTION"
  37 .PP
  38 \fBmysql_waitpid\fR
  39 signals a process to terminate and waits for the process to exit\&. It uses the
  40 kill()
  41 system call and Unix signals, so it runs on Unix and Unix\-like systems\&.
  42 .PP
  43 Invoke
  44 \fBmysql_waitpid\fR
  45 like this:
  46 .sp
  47 .if n \{\
  48 .RS 4
  49 .\}
  50 .nf
  51 shell> \fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR
  52 .fi
  53 .if n \{\
  54 .RE
  55 .\}
  56 .PP
  57 \fBmysql_waitpid\fR
  58 sends signal 0 to the process identified by
  59 \fIpid\fR
  60 and waits up to
  61 \fIwait_time\fR
  62 seconds for the process to terminate\&.
  63 \fIpid\fR
  64 and
  65 \fIwait_time\fR
  66 must be positive integers\&.
  67 .PP
  68 If process termination occurs within the wait time or the process does not exist,
  69 \fBmysql_waitpid\fR
  70 returns 0\&. Otherwise, it returns 1\&.
  71 .PP
  72 If the
  73 kill()
  74 system call cannot handle signal 0,
  75 \fBmysql_waitpid()\fR
  76 uses signal 1 instead\&.
  77 .PP
  78 \fBmysql_waitpid\fR
  79 supports the following options:
  80 .sp
  81 .RS 4
  82 .ie n \{\
  83 \h'-04'\(bu\h'+03'\c
  84 .\}
  85 .el \{\
  86 .sp -1
  87 .IP \(bu 2.3
  88 .\}
  89 .\" mysql_waitpid: help option
  90 .\" help option: mysql_waitpid
  91 \fB\-\-help\fR,
  92 \fB\-?\fR,
  93 \fB\-I\fR
  94 .sp
  95 Display a help message and exit\&.
  96 .RE
  97 .sp
  98 .RS 4
  99 .ie n \{\
 100 \h'-04'\(bu\h'+03'\c
 101 .\}
 102 .el \{\
 103 .sp -1
 104 .IP \(bu 2.3
 105 .\}
 106 .\" mysql_waitpid: verbose option
 107 .\" verbose option: mysql_waitpid
 108 \fB\-\-verbose\fR,
 109 \fB\-v\fR
 110 .sp
 111 Verbose mode\&. Display a warning if signal 0 could not be used and signal 1 is used instead\&.
 112 .RE
 113 .sp
 114 .RS 4
 115 .ie n \{\
 116 \h'-04'\(bu\h'+03'\c
 117 .\}
 118 .el \{\
 119 .sp -1
 120 .IP \(bu 2.3
 121 .\}
 122 .\" mysql_waitpid: version option
 123 .\" version option: mysql_waitpid
 124 \fB\-\-version\fR,
 125 \fB\-V\fR
 126 .sp
 127 Display version information and exit\&.
 128 .RE
 129 .SH "COPYRIGHT"
 130 .br
 131 .PP
 132 Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 133 .PP
 134 This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
 135 .PP
 136 This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 137 .PP
 138 You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
 139 .sp
 140 .SH "SEE ALSO"
 141 For more information, please refer to the MySQL Reference Manual,
 142 which may already be installed locally and which is also available
 143 online at http://dev.mysql.com/doc/.
 144 .SH AUTHOR
 145 Oracle Corporation (http://dev.mysql.com/).