along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
-<refentry id="systemd-coredumpctl">
+<refentry id="systemd-coredumpctl" conditional='ENABLE_COREDUMP'
+ xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-coredumpctl</title>
<refsynopsisdiv>
<cmdsynopsis>
- <command>systemd-coredumpctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg></command>
+ <command>systemd-coredumpctl</command>
+ <arg choice="opt" rep="repeat">OPTIONS</arg>
+ <arg choice="req">COMMAND</arg>
+ <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<variablelist>
<varlistentry>
- <term><option>--help</option></term>
- <term><option>-h</option></term>
+ <term><option>-F</option></term>
+ <term><option>--field=</option></term>
- <listitem><para>Print a short help
- text and exit.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--version</option></term>
-
- <listitem><para>Print a short version
- string and exit.</para></listitem>
+ <listitem><para>Print all possible
+ data values the specified field
+ takes in matching coredump entries of the
+ journal.</para></listitem>
</varlistentry>
<varlistentry>
+ <term><option>-o</option></term>
<term><option>--output=FILE</option></term>
- <term><option>-o FILE</option></term>
<listitem><para>Write the core to
<option>FILE</option>.</para></listitem>
</varlistentry>
- <varlistentry>
- <term><option>--no-pager</option></term>
-
- <listitem><para>Do not pipe output of
- <command>list</command> into a
- pager.</para></listitem>
- </varlistentry>
-
<varlistentry>
<term><option>--no-legend</option></term>
</para></listitem>
</varlistentry>
+ <xi:include href="standard-options.xml" xpointer="help" />
+ <xi:include href="standard-options.xml" xpointer="version" />
+ <xi:include href="standard-options.xml" xpointer="no-pager" />
</variablelist>
<para>The following commands are understood:</para>
<listitem><para>Extract the last coredump
matching specified characteristics.
- Coredump will be written on stdout, unless
- an output file is specified with
+ The coredump will be written on standard output,
+ unless an output file is specified with
<option>-o/--output</option>.
</para></listitem>
</varlistentry>
<variablelist>
<varlistentry>
- <term><option>PID</option></term>
+ <term><replaceable>PID</replaceable></term>
<listitem><para>Process ID of the
process that dumped
</varlistentry>
<varlistentry>
- <term><option>COMM</option></term>
+ <term><replaceable>COMM</replaceable></term>
<listitem><para>Name of the executable
(matches <option>COREDUMP_COMM=</option>).
</varlistentry>
<varlistentry>
- <term><option>EXE</option></term>
+ <term><replaceable>EXE</replaceable></term>
<listitem><para>Path to the executable
(matches <option>COREDUMP_EXE=</option>).
</varlistentry>
<varlistentry>
- <term><option>MATCH</option></term>
+ <term><replaceable>MATCH</replaceable></term>
<listitem><para>General journalctl predicates
(see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
- code otherwise. Not finding any mathing coredumps is treated
- as failure.
- </para>
+ <para>On success, 0 is returned; otherwise, a non-zero failure
+ code is returned. Not finding any matching coredumps is treated
+ as failure.
+ </para>
</refsect1>
<refsect1>