Imported freely distributable documentation from upstream MySQL 5.1.34 source tarball.

1 files changed, 117 insertions, 0 deletions

diff --git a/man/perror.1 b/man/perror.1
new file mode 100644
index 00000000000..b1aeee19f92
--- /dev/null
+++ b/man/perror.1
@@ -0,0 +1,117 @@
+.\"     Title: \fBperror\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 "\fBPERROR\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"
+perror \- explain error codes
+.SH "SYNOPSIS"
+.HP 31
+\fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB ...\fR
+.SH "DESCRIPTION"
+.PP
+For most system errors, MySQL displays, in addition to an internal text message, the system error code in one of the following styles:
+.sp
+.RS 3n
+.nf
+message ... (errno: #)
+message ... (Errcode: #)
+.fi
+.RE
+.PP
+You can find out what the error code means by examining the documentation for your system or by using the
+\fBperror\fR
+utility.
+.PP
+\fBperror\fR
+prints a description for a system error code or for a storage engine (table handler) error code.
+.PP
+Invoke
+\fBperror\fR
+like this:
+.sp
+.RS 3n
+.nf
+shell> \fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB ...\fR
+.fi
+.RE
+.PP
+Example:
+.sp
+.RS 3n
+.nf
+shell> \fBperror 13 64\fR
+OS error code  13:  Permission denied
+OS error code  64:  Machine is not on the network
+.fi
+.RE
+.PP
+To obtain the error message for a MySQL Cluster error code, invoke
+\fBperror\fR
+with the
+\fB\-\-ndb\fR
+option:
+.sp
+.RS 3n
+.nf
+shell> \fBperror \-\-ndb \fR\fB\fIerrorcode\fR\fR
+.fi
+.RE
+.PP
+Note that the meaning of system error messages may be dependent on your operating system. A given error code may mean different things on different operating systems.
+.PP
+\fBperror\fR
+supports the following options:
+.TP 3n
+\(bu
+\fB\-\-help\fR,
+\fB\-\-info\fR,
+\fB\-I\fR,
+\fB\-?\fR
+.sp
+Display a help message and exit.
+.TP 3n
+\(bu
+\fB\-\-ndb\fR
+.sp
+Print the error message for a MySQL Cluster error code.
+.TP 3n
+\(bu
+\fB\-\-silent\fR,
+\fB\-s\fR
+.sp
+Silent mode. Print only the error message.
+.TP 3n
+\(bu
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode. Print error code and message. This is the default behavior.
+.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/).