BSD 4_3_Net_2 release

[unix-history] / usr / src / share / man / man5 / core.5

diff --git a/usr/src/share/man/man5/core.5 b/usr/src/share/man/man5/core.5
index 8303d57..6df18aa 100644 (file)
--- a/usr/src/share/man/man5/core.5
+++ b/usr/src/share/man/man5/core.5
@@ -1,61 +1,111 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)core.5      6.2 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH CORE 5  ""
-.UC 4
-.SH NAME
-core \- format of memory image file
-.SH SYNOPSIS
-.B #include <sys/param.h>
-.SH DESCRIPTION
-The UNIX System writes out a memory image of a terminated
-process when any of various errors occur.  See
-.IR sigvec (2)
-for the list of reasons; the most common are memory violations, illegal
-instructions, bus errors, and user-generated quit signals.
-The memory image is called `core' and is written in the process's
-working directory (provided it can be; normal access controls apply).
-.PP
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)core.5     6.3 (Berkeley) 4/29/91
+.\"
+.Dd April 29, 1991
+.Dt CORE 5
+.Os BSD 4
+.Sh NAME
+.Nm core
+.Nd memory image file format
+.Sh SYNOPSIS
+.Fd #include <sys/param.h>
+.Sh DESCRIPTION
+A small number of signals which cause abnormal termination of a process
+also cause a record of the process's in-core state to be written
+to disk for later examination by one of the aviailable debuggers.
+(See
+.Xr sigaction 2 . )
+This memory image is written to a file named
+.Nm core
+in the working directory;
+provided the terminated process had write permission in the directory,
+and provided the abnormality did not caused
+a system crash.
+(In this event, the decision to save the core file is arbitrary, see
+.Xr savecore 8 . )
+.Pp

 The maximum size of a
 The maximum size of a

-.I core
+.Nm core

 file is limited by
 file is limited by

-.IR setrlimit (2).
+.Xr setrlimit 2 .

 Files which would be larger than the limit are not created.
 Files which would be larger than the limit are not created.

-.PP
-The core file consists of the
-.I u.
+.Pp
+The
+.Nm core
+file consists of the
+.Fa u .

 area, whose size (in pages) is
 area, whose size (in pages) is

-defined by the UPAGES manifest in the
-.RI < sys/param.h >
+defined by the
+.Dv UPAGES
+manifest in the
+.Aq Pa sys/param.h

 file.  The 
 file.  The 

-.I u.
+.Fa u .

 area starts with a 
 area starts with a 

-.I user
+.Fa user

 structure as given in
 structure as given in

-.RI < sys/user.h >.
-The remainder of the core file consists first of the data pages and then
+.Aq Pa sys/user.h .
+The remainder of the
+.Nm core
+file consists of the data pages followed by

 the stack pages of the process image.
 the stack pages of the process image.

-The amount of data space image in the core file is given (in pages) by the
+The amount of data space image in the
+.Nm core
+file is given (in pages) by the

 variable
 variable

-.I u_dsize
+.Fa u_dsize

 in the
 in the

-.I u.
+.Fa u .

 area.
 The amount of stack image in the core file is given (in pages) by the
 variable 
 area.
 The amount of stack image in the core file is given (in pages) by the
 variable 

-.I u_ssize
+.Fa u_ssize

 in the 
 in the 

-.I u.
+.Ar u .

 area.
 area.

-The size of a ``page'' is given by the constant NBPG
+The size of a ``page'' is given by the constant
+.Dv NBPG

 (also from
 (also from

-.RI < sys/param.h >).
-.PP
-In general the debugger
-.IR adb (1)
-is sufficient to deal with core images.
-.SH "SEE ALSO"
-adb(1), dbx(1), sigvec(2), setrlimit(2)
+.Aq Pa sys/param.h ) .
+.Sh SEE ALSO
+.Xr adb 1 ,
+.Xr dbx 1 ,
+.Xr gdb 1 ,
+.Xr kgdb 1 ,
+.Xr sigaction 2 ,
+.Xr setrlimit 2
+.Sh HISTORY
+A
+.Nm
+file format appeared in
+.At v6 .