summaryrefslogtreecommitdiffstats
path: root/man/perror.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man/perror.1157
1 files changed, 157 insertions, 0 deletions
diff --git a/man/perror.1 b/man/perror.1
new file mode 100644
index 00000000..94a4bdb3
--- /dev/null
+++ b/man/perror.1
@@ -0,0 +1,157 @@
+'\" t
+.\"
+.TH "\fBPERROR\fR" "1" "15 May 2020" "MariaDB 10.11" "MariaDB Database System"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.\" perror
+.\" error messages: displaying
+.\" errno
+.\" Errcode
+.SH "NAME"
+perror \- explain error codes
+.SH "SYNOPSIS"
+.HP \w'\fBperror\ [\fR\fB\fIoptions\fR\fR\fB]\ \fR\fB\fIerrorcode\fR\fR\fB\ \&.\&.\&.\fR\ 'u
+\fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB \&.\&.\&.\fR
+.SH "DESCRIPTION"
+.PP
+For most system errors, MariaDB displays, in addition to an internal text message, the system error code in one of the following styles:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+message \&.\&.\&. (errno: #)
+message \&.\&.\&. (Errcode: #)
+.fi
+.if n \{\
+.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
+.if n \{\
+.RS 4
+.\}
+.nf
+shell> \fBperror [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIerrorcode\fR\fR\fB \&.\&.\&.\fR
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+Example:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+shell> \fBperror 13 64\fR
+OS error code 13: Permission denied
+OS error code 64: Machine is not on the network
+.fi
+.if n \{\
+.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\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" perror: help option
+.\" help option: perror
+\fB\-\-help\fR,
+\fB\-\-info\fR,
+\fB\-I\fR,
+\fB\-?\fR
+.sp
+Display a help message and exit\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" perror: silent option
+.\" silent option: perror
+\fB\-\-silent\fR,
+\fB\-s\fR
+.sp
+Silent mode\&. Print only the error message\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" perror: verbose option
+.\" verbose option: perror
+\fB\-\-verbose\fR,
+\fB\-v\fR
+.sp
+Verbose mode\&. Print error code and message\&. This is the default behavior\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+.\" perror: version option
+.\" version option: perror
+\fB\-\-version\fR,
+\fB\-V\fR
+.sp
+Display version information and exit\&.
+.RE
+.SH "COPYRIGHT"
+.br
+.PP
+Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc., 2010-2020 MariaDB Foundation
+.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-1335 USA or see http://www.gnu.org/licenses/.
+.sp
+.SH "SEE ALSO"
+For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/
+.SH AUTHOR
+MariaDB Foundation (http://www.mariadb.org/).