summaryrefslogtreecommitdiff
path: root/static/freebsd/man5/core.5 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
commit1f19f33e45791ea59aed048796fc68672c6723a5 (patch)
tree54625fba89e91d1c2177801ec635e8528bba937f /static/freebsd/man5/core.5 3.html
parentac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (diff)
docs: Removed Precompiled HTML
Diffstat (limited to 'static/freebsd/man5/core.5 3.html')
-rw-r--r--static/freebsd/man5/core.5 3.html153
1 files changed, 0 insertions, 153 deletions
diff --git a/static/freebsd/man5/core.5 3.html b/static/freebsd/man5/core.5 3.html
deleted file mode 100644
index 167df948..00000000
--- a/static/freebsd/man5/core.5 3.html
+++ /dev/null
@@ -1,153 +0,0 @@
-<table class="head">
- <tr>
- <td class="head-ltitle">CORE(5)</td>
- <td class="head-vol">File Formats Manual</td>
- <td class="head-rtitle">CORE(5)</td>
- </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<p class="Pp"><code class="Nm">core</code> &#x2014; <span class="Nd">memory
- image file format</span></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<p class="Pp"><code class="In">#include
- &lt;<a class="In">sys/param.h</a>&gt;</code></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-<p class="Pp">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 available debuggers. (See
- <a class="Xr">sigaction(2)</a>.) This memory image is written to a file
- named by default <code class="Nm">programname.core</code> in the working
- directory; provided the terminated process had write permission in the
- directory, and provided the abnormality did not cause a system crash. (In
- this event, the decision to save the core file is arbitrary, see
- <a class="Xr">savecore(8)</a>.)</p>
-<p class="Pp">The name of the file is controlled via the
- <a class="Xr">sysctl(8)</a> variable <var class="Va">kern.corefile</var>.
- The contents of this variable describes a filename to store the core image
- to. This filename can be absolute, or relative (which will resolve to the
- current working directory of the program generating it).</p>
-<p class="Pp">The following format specifiers may be used in the
- <var class="Va">kern.corefile</var> sysctl to insert additional information
- into the resulting core filename:</p>
-<div class="Bd-indent">
-<dl class="Bl-tag Bl-compact">
- <dt id="_H"><a class="permalink" href="#_H"><i class="Em">%H</i></a></dt>
- <dd>Machine hostname.</dd>
- <dt id="_I"><a class="permalink" href="#_I"><i class="Em">%I</i></a></dt>
- <dd>An index starting at zero until the sysctl
- <a class="permalink" href="#debug.ncores"><i class="Em" id="debug.ncores">debug.ncores</i></a>
- is reached. This can be useful for limiting the number of corefiles
- generated by a particular process.</dd>
- <dt id="_N"><a class="permalink" href="#_N"><i class="Em">%N</i></a></dt>
- <dd>process name.</dd>
- <dt id="_P"><a class="permalink" href="#_P"><i class="Em">%P</i></a></dt>
- <dd>processes PID.</dd>
- <dt id="_S"><a class="permalink" href="#_S"><i class="Em">%S</i></a></dt>
- <dd>signal during core.</dd>
- <dt id="_U"><a class="permalink" href="#_U"><i class="Em">%U</i></a></dt>
- <dd>process UID.</dd>
-</dl>
-</div>
-<p class="Pp" id="_N.core">The name defaults to
- <a class="permalink" href="#_N.core"><i class="Em">%N.core</i></a>, yielding
- the traditional <span class="Ux">FreeBSD</span> behaviour.</p>
-<p class="Pp">The maximum size of a core file is limited by the
- <code class="Dv">RLIMIT_CORE</code> <a class="Xr">setrlimit(2)</a> limit.
- Files which would be larger than the limit are not created.</p>
-<p class="Pp">With a large limit, a process that had mapped a very large, and
- perhaps sparsely populated, virtual memory region, could take a very long
- time to create core dumps. The system ignores all signals sent to a process
- writing a core file, except <code class="Dv">SIGKILL</code> which terminates
- the writing and causes immediate exit of the process. The behavior of
- <code class="Dv">SIGKILL</code> can be disabled by setting tunable
- <a class="Xr">sysctl(8)</a> variable
- <var class="Va">kern.core_dump_can_intr</var> to zero.</p>
-<p class="Pp">By default, a process that changes user or group credentials
- whether real or effective will not create a corefile. This behaviour can be
- changed to generate a core dump by setting the <a class="Xr">sysctl(8)</a>
- variable <var class="Va">kern.sugid_coredump</var> to 1.</p>
-<p class="Pp">Corefiles can be compressed by the kernel if one of the following
- items are included in the kernel configuration file:</p>
-<div class="Bd-indent">
-<dl class="Bl-tag Bl-compact">
- <dt>options</dt>
- <dd>GZIO</dd>
- <dt>options</dt>
- <dd>ZSTDIO</dd>
-</dl>
-</div>
-<p class="Pp">The following sysctl control core file compression:</p>
-<div class="Bd-indent">
-<dl class="Bl-tag Bl-compact">
- <dt id="kern.compress_user_cores"><a class="permalink" href="#kern.compress_user_cores"><i class="Em">kern.compress_user_cores</i></a></dt>
- <dd>Enable compression of user cores. A value of 1 configures
- <a class="Xr">gzip(1)</a> compression, and a value of 2 configures
- <a class="Xr">zstd(1)</a> compression. Compressed core files will have a
- suffix of &#x2018;<code class="Li">.gz</code>&#x2019; or
- &#x2018;<code class="Li">.zst</code>&#x2019; appended to their filenames
- depending on the selected format.</dd>
- <dt id="kern.compress_user_cores_level"><a class="permalink" href="#kern.compress_user_cores_level"><i class="Em">kern.compress_user_cores_level</i></a></dt>
- <dd>Compression level. Defaults to 6.</dd>
-</dl>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="NOTES"><a class="permalink" href="#NOTES">NOTES</a></h1>
-<p class="Pp">Corefiles are written with open file descriptor information as an
- ELF note. By default, file paths are packed to only use as much space as
- needed. However, file paths can change at any time, including during core
- dump, and this can result in truncated file descriptor data.</p>
-<p class="Pp">All file descriptor information can be preserved by disabling
- packing. This potentially wastes up to PATH_MAX bytes per open fd. Packing
- is disabled with</p>
-<div class="Bd Bd-indent"><code class="Li">sysctl
- kern.coredump_pack_fileinfo=0</code></div>
-.
-<p class="Pp">Similarly, corefiles are written with vmmap information as an ELF
- note, which contains file paths. By default, they are packed to only use as
- much space as needed. By the same mechanism as for the open files note,
- these paths can also change at any time and result in a truncated note.</p>
-<p class="Pp">All vmmap information can be preserved by disabling packing. Like
- the file information, this potentially wastes up to PATH_MAX bytes per
- mapped object. Packing is disabled with</p>
-<div class="Bd Bd-indent"><code class="Li">sysctl
- kern.coredump_pack_vmmapinfo=0</code></div>
-.
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-<p class="Pp">In order to store all core images in per-user private areas under
- <span class="Pa">/var/coredumps</span> (assuming the appropriate
- subdirectories exist and are writable by users), the following
- <a class="Xr">sysctl(8)</a> command can be used:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent"><code class="Li">sysctl
- kern.corefile=/var/coredumps/%U/%N.core</code></div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
- ALSO</a></h1>
-<p class="Pp"><a class="Xr">gdb(1)</a>
- (<span class="Pa">ports/devel/gdb</span>), <a class="Xr">gzip(1)</a>,
- <a class="Xr">kgdb(1)</a> (<span class="Pa">ports/devel/gdb</span>),
- <a class="Xr">setrlimit(2)</a>, <a class="Xr">sigaction(2)</a>,
- <a class="Xr">sysctl(8)</a></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<p class="Pp">A <code class="Nm">core</code> file format appeared in
- <span class="Ux">Version&#x00A0;1 AT&amp;T UNIX</span>.</p>
-</section>
-</div>
-<table class="foot">
- <tr>
- <td class="foot-date">July 17, 2025</td>
- <td class="foot-os">FreeBSD 15.0</td>
- </tr>
-</table>