bsd/man/man5/core.5

   1 .\""Copyright (c) 2001 Apple Computer, Inc. All Rights Reserved.
   2 .\"The contents of this file constitute Original Code as defined in and are
   3 .\"subject to the Apple Public Source License Version 1.2 (the 'License').
   4 .\"You may not use this file except in compliance with the
   5 .\"License. Please obtain a copy of the License at
   6 .\"http://www.apple.com/publicsource and read it before using this file.
   7 .\"
   8 .\"This Original Code and all software distributed under the License are
   9 .\"distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  10 .\"EXPRESS OR IMPLIED, AND APPLE
  11 .\"HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY
  12 .\"WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
  13 .\"QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  14 .\"specific language governing rights and limitations under the License."
  15 .Dd March 18, 2002
  16 .Dt CORE 5
  17 .Os
  18 .Sh NAME
  19 .Nm core
  20 .Nd memory image file format
  21 .Sh SYNOPSIS
  22 .In sys/param.h
  23 .Sh DESCRIPTION
  24 A small number of signals which cause abnormal termination of a process
  25 also cause a record of the process's in-core state to be written
  26 to disk for later examination by one of the available debuggers.
  27 (See
  28 .Xr sigaction 2 . )
  29 This memory image is written to a file named by default
  30 .Nm core.pid
  31 in the
  32 .Nm /cores
  33 directory;
  34 provided the terminated process had write permission in the directory,
  35 and the directory existed.
  36 .Pp
  37 The maximum size of a core file is limited by
  38 .Xr setrlimit 2 .
  39 Files which would be larger than the limit are not created.
  40 .Pp
  41 The core file consists of the
  42 .Pa Xr Mach-O 5
  43 header as  described in the
  44 .Aq Pa mach-o/loader.h
  45 file.
  46 The remainder of the core
  47 file consists of various sections described in the
  48 .Xr Mach-O 5
  49 header.
  50 .Sh NOTE
  51 Core dumps are disabled by default under Darwin/Mac OS X.  To re-enable core dumps, a
  52 privlaged user must edit
  53 .Pa /etc/hostconfig
  54 to contain the line:
  55 .Bd -literal
  56 COREDUMPS=-YES-
  57 .Ed
  58 .Sh SEE ALSO
  59 .Xr gdb 1 ,
  60 .Xr setrlimit 2 ,
  61 .Xr sigaction 2 ,
  62 .Xr Mach-O 5 ,
  63 .Xr sysctl 8
  64 .Sh HISTORY
  65 A
  66 .Nm
  67 file format appeared in
  68 .At v6 .