Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

1 files changed, 91 insertions, 0 deletions

diff --git a/man/mysql_waitpid.1 b/man/mysql_waitpid.1
new file mode 100644
index 00000000000..1dc2b8844f1
--- /dev/null
+++ b/man/mysql_waitpid.1
@@ -0,0 +1,91 @@
+.\"     Title: \fBmysql_waitpid\fR
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 03/31/2009
+.\"    Manual: MySQL Database System
+.\"    Source: MySQL 5.1
+.\"
+.TH "\fBMYSQL_WAITPID\fR" "1" "03/31/2009" "MySQL 5.1" "MySQL Database System"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+mysql_waitpid \- kill process and wait for its termination
+.SH "SYNOPSIS"
+.HP 38
+\fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR
+.SH "DESCRIPTION"
+.PP
+\fBmysql_waitpid\fR
+signals a process to terminate and waits for the process to exit. It uses the
+kill()
+system call and Unix signals, so it runs on Unix and Unix\-like systems.
+.PP
+Invoke
+\fBmysql_waitpid\fR
+like this:
+.sp
+.RS 3n
+.nf
+shell> \fBmysql_waitpid [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIpid\fR\fR\fB \fR\fB\fIwait_time\fR\fR
+.fi
+.RE
+.PP
+\fBmysql_waitpid\fR
+sends signal 0 to the process identified by
+\fIpid\fR
+and waits up to
+\fIwait_time\fR
+seconds for the process to terminate.
+\fIpid\fR
+and
+\fIwait_time\fR
+must be positive integers.
+.PP
+If process termination occurs within the wait time or the process does not exist,
+\fBmysql_waitpid\fR
+returns 0. Otherwise, it returns 1.
+.PP
+If the
+kill()
+system call cannot handle signal 0,
+\fBmysql_waitpid()\fR
+uses signal 1 instead.
+.PP
+\fBmysql_waitpid\fR
+understands the following options:
+.TP 3n
+\(bu
+\fB\-\-help\fR,
+\fB\-?\fR,
+\fB\-I\fR
+.sp
+Display a help message and exit.
+.TP 3n
+\(bu
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode. Display a warning if signal 0 could not be used and signal 1 is used instead.
+.TP 3n
+\(bu
+\fB\-\-version\fR,
+\fB\-V\fR
+.sp
+Display version information and exit.
+.SH "COPYRIGHT"
+.PP
+Copyright 2007\-2008 MySQL AB, 2009 Sun Microsystems, Inc.
+.PP
+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.
+.PP
+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.
+.PP
+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/.
+.SH "SEE ALSO"
+For more information, please refer to the MySQL Reference Manual,
+which may already be installed locally and which is also available
+online at http://dev.mysql.com/doc/.
+.SH AUTHOR
+MySQL AB (http://www.mysql.com/).