xnu-4903.270.47.tar.gz

[apple/xnu.git] / bsd / man / man5 / core.5

diff --git a/bsd/man/man5/core.5 b/bsd/man/man5/core.5
index 6e6ea7a2db947e91bd0b1bbed3858e646474727d..a45898f47ee9cca3bb77b8a55cb62ab08b0ad02c 100644 (file)
--- a/bsd/man/man5/core.5
+++ b/bsd/man/man5/core.5
@@ -1,4 +1,4 @@
-.\""Copyright (c) 2001 Apple Computer, Inc. All Rights Reserved.
+.\""Copyright (c) 2001-2007 Apple Inc. All Rights Reserved.
 .\"The contents of this file constitute Original Code as defined in and are 
 .\"subject to the Apple Public Source License Version 1.2 (the 'License'). 
 .\"You may not use this file except in compliance with the
@@ -12,7 +12,7 @@
 .\"WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 .\"QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the 
 .\"specific language governing rights and limitations under the License."
-.Dd March 18, 2002
+.Dd June 26, 2008
 .Dt CORE 5
 .Os
 .Sh NAME
@@ -27,10 +27,13 @@ to disk for later examination by one of the available debuggers.
 (See
 .Xr sigaction 2 . )
 This memory image is written to a file named by default
-.Nm core.pid
+.Pa core.pid ,
+where
+.Va pid
+is the process ID of the process,
 in the
-.Nm /cores
-directory;
+.Pa /cores
+directory,
 provided the terminated process had write permission in the directory,
 and the directory existed.
 .Pp
@@ -39,7 +42,7 @@ The maximum size of a core file is limited by
 Files which would be larger than the limit are not created.
 .Pp
 The core file consists of the
-.Pa Xr Mach-O 5
+.Xr Mach-O 5
 header as  described in the
 .Aq Pa mach-o/loader.h
 file.
@@ -48,18 +51,31 @@ file consists of various sections described in the
 .Xr Mach-O 5
 header.
 .Sh NOTE
-Core dumps are disabled by default under Darwin/Mac OS X.  To re-enable core dumps, a 
-privlaged user must edit
-.Pa /etc/hostconfig
-to contain the line:
-.Bd -literal
-COREDUMPS=-YES-
-.Ed
+Core dumps are disabled by default under Darwin/Mac OS X.  To re-enable 
+core dumps, a privileged user must do one of the following
+.Pp
+* Edit
+.Pa /etc/launchd.conf 
+or 
+.Pa $HOME/.launchd.conf
+and add a line specifying the limit
+.Pa limit core unlimited
+.Pp
+* A privileged user can also enable cores with
+.Pa launchctl limit core unlimited
+.Pp
+* A privileged user can also enable core files by using
+.Xr ulimit 1
+or 
+.Xr limit 1
+depending upon the shell.
 .Sh SEE ALSO
 .Xr gdb 1 ,
 .Xr setrlimit 2 ,
 .Xr sigaction 2 ,
 .Xr Mach-O 5 ,
+.Xr launchd.conf 5 ,
+.Xr launchd.plist 5 ,
 .Xr sysctl 8
 .Sh HISTORY
 A