]>
Commit | Line | Data |
---|---|---|
5de0409e ZJS |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
5de0409e ZJS |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2012 Zbigniew Jędrzejewski-Szmek | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | --> | |
23 | ||
f4bab169 | 24 | <refentry id="coredumpctl" conditional='ENABLE_COREDUMP' |
798d3a52 ZJS |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
26 | ||
27 | <refentryinfo> | |
28 | <title>coredumpctl</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Zbigniew</firstname> | |
35 | <surname>Jędrzejewski-Szmek</surname> | |
36 | <email>zbyszek@in.waw.pl</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>coredumpctl</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>coredumpctl</refname> | |
246ba4aa | 48 | <refpurpose>Retrieve and process saved core dumps and metadata</refpurpose> |
798d3a52 ZJS |
49 | </refnamediv> |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
53 | <command>coredumpctl</command> | |
54 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
55 | <arg choice="req">COMMAND</arg> | |
56 | <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg> | |
57 | </cmdsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | ||
246ba4aa PM |
63 | <para><command>coredumpctl</command> is a tool that can be used to retrieve and process core |
64 | dumps and metadata which were saved by | |
65 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
66 | </para> | |
798d3a52 ZJS |
67 | </refsect1> |
68 | ||
69 | <refsect1> | |
70 | <title>Options</title> | |
71 | ||
72 | <para>The following options are understood:</para> | |
73 | ||
74 | <variablelist> | |
246ba4aa PM |
75 | |
76 | <xi:include href="standard-options.xml" xpointer="help" /> | |
77 | <xi:include href="standard-options.xml" xpointer="version" /> | |
78 | ||
798d3a52 ZJS |
79 | <varlistentry> |
80 | <term><option>--no-legend</option></term> | |
81 | ||
246ba4aa | 82 | <listitem><para>Do not print column headers.</para></listitem> |
798d3a52 ZJS |
83 | </varlistentry> |
84 | ||
246ba4aa PM |
85 | <xi:include href="standard-options.xml" xpointer="no-pager" /> |
86 | ||
798d3a52 ZJS |
87 | <varlistentry> |
88 | <term><option>-1</option></term> | |
89 | ||
246ba4aa PM |
90 | <listitem><para>Show information of a single core dump only, instead of listing |
91 | all known core dumps.</para></listitem> | |
798d3a52 ZJS |
92 | </varlistentry> |
93 | ||
94 | <varlistentry> | |
f6a4dae6 LP |
95 | <term><option>-F</option> <replaceable>FIELD</replaceable></term> |
96 | <term><option>--field=</option><replaceable>FIELD</replaceable></term> | |
798d3a52 ZJS |
97 | |
98 | <listitem><para>Print all possible data values the specified | |
246ba4aa | 99 | field takes in matching core dump entries of the |
798d3a52 ZJS |
100 | journal.</para></listitem> |
101 | </varlistentry> | |
102 | ||
103 | <varlistentry> | |
f6a4dae6 LP |
104 | <term><option>-o</option> <replaceable>FILE</replaceable></term> |
105 | <term><option>--output=</option><replaceable>FILE</replaceable></term> | |
798d3a52 ZJS |
106 | |
107 | <listitem><para>Write the core to <option>FILE</option>. | |
108 | </para></listitem> | |
109 | </varlistentry> | |
110 | ||
b73e9a02 SW |
111 | <varlistentry> |
112 | <term><option>-D</option> <replaceable>DIR</replaceable></term> | |
113 | <term><option>--directory=</option><replaceable>DIR</replaceable></term> | |
114 | ||
115 | <listitem><para>Use the journal files in the specified <option>DIR</option>. | |
116 | </para></listitem> | |
117 | </varlistentry> | |
118 | ||
798d3a52 | 119 | </variablelist> |
246ba4aa PM |
120 | </refsect1> |
121 | ||
122 | <refsect1> | |
123 | <title>Commands</title> | |
798d3a52 ZJS |
124 | |
125 | <para>The following commands are understood:</para> | |
126 | ||
127 | <variablelist> | |
128 | <varlistentry> | |
129 | <term><command>list</command></term> | |
130 | ||
246ba4aa | 131 | <listitem><para>List core dumps captured in the journal |
798d3a52 | 132 | matching specified characteristics. If no command is |
246ba4aa PM |
133 | specified, this is the implied default.</para> |
134 | ||
135 | <para>It's worth noting that different restrictions apply to | |
136 | data saved in the journal and core dump files saved in | |
137 | <filename>/var/lib/systemd/coredump</filename>, see overview in | |
138 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
139 | Thus it may very well happen that a particular core dump is still listed | |
140 | in the journal while its corresponding core dump file has already been | |
141 | removed.</para></listitem> | |
798d3a52 ZJS |
142 | </varlistentry> |
143 | ||
144 | <varlistentry> | |
145 | <term><command>info</command></term> | |
146 | ||
246ba4aa | 147 | <listitem><para>Show detailed information about core dumps |
798d3a52 ZJS |
148 | captured in the journal.</para></listitem> |
149 | </varlistentry> | |
150 | ||
151 | <varlistentry> | |
152 | <term><command>dump</command></term> | |
153 | ||
246ba4aa PM |
154 | <listitem><para>Extract the last core dump matching specified |
155 | characteristics. The core dump will be written on standard | |
798d3a52 | 156 | output, unless an output file is specified with |
f6a4dae6 | 157 | <option>--output=</option>. </para></listitem> |
798d3a52 ZJS |
158 | </varlistentry> |
159 | ||
160 | <varlistentry> | |
161 | <term><command>gdb</command></term> | |
162 | ||
246ba4aa | 163 | <listitem><para>Invoke the GNU debugger on the last core dump |
798d3a52 ZJS |
164 | matching specified characteristics. </para></listitem> |
165 | </varlistentry> | |
166 | ||
167 | </variablelist> | |
168 | ||
169 | </refsect1> | |
170 | ||
171 | <refsect1> | |
172 | <title>Matching</title> | |
173 | ||
174 | <para>A match can be:</para> | |
175 | ||
176 | <variablelist> | |
177 | <varlistentry> | |
178 | <term><replaceable>PID</replaceable></term> | |
179 | ||
180 | <listitem><para>Process ID of the | |
181 | process that dumped | |
182 | core. An integer.</para></listitem> | |
183 | </varlistentry> | |
184 | ||
185 | <varlistentry> | |
186 | <term><replaceable>COMM</replaceable></term> | |
187 | ||
188 | <listitem><para>Name of the executable (matches | |
189 | <option>COREDUMP_COMM=</option>). Must not contain slashes. | |
190 | </para></listitem> | |
191 | </varlistentry> | |
192 | ||
193 | <varlistentry> | |
194 | <term><replaceable>EXE</replaceable></term> | |
195 | ||
196 | <listitem><para>Path to the executable (matches | |
197 | <option>COREDUMP_EXE=</option>). Must contain at least one | |
198 | slash. </para></listitem> | |
199 | </varlistentry> | |
200 | ||
201 | <varlistentry> | |
202 | <term><replaceable>MATCH</replaceable></term> | |
203 | ||
204 | <listitem><para>General journalctl predicates (see | |
205 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>). | |
206 | Must contain an equal sign. </para></listitem> | |
207 | </varlistentry> | |
208 | </variablelist> | |
209 | </refsect1> | |
210 | ||
211 | <refsect1> | |
212 | <title>Exit status</title> | |
213 | <para>On success, 0 is returned; otherwise, a non-zero failure | |
246ba4aa | 214 | code is returned. Not finding any matching core dumps is treated as |
798d3a52 ZJS |
215 | failure. |
216 | </para> | |
217 | </refsect1> | |
218 | ||
219 | <refsect1> | |
220 | <title>Examples</title> | |
221 | ||
222 | <example> | |
246ba4aa | 223 | <title>List all the core dumps of a program named foo</title> |
798d3a52 ZJS |
224 | |
225 | <programlisting># coredumpctl list foo</programlisting> | |
226 | </example> | |
227 | ||
228 | <example> | |
246ba4aa | 229 | <title>Invoke gdb on the last core dump</title> |
798d3a52 ZJS |
230 | |
231 | <programlisting># coredumpctl gdb</programlisting> | |
232 | </example> | |
233 | ||
234 | <example> | |
235 | <title>Show information about a process that dumped core, | |
236 | matching by its PID 6654</title> | |
237 | ||
238 | <programlisting># coredumpctl info 6654</programlisting> | |
239 | </example> | |
240 | ||
241 | <example> | |
246ba4aa | 242 | <title>Extract the last core dump of /usr/bin/bar to a file named |
798d3a52 ZJS |
243 | <filename noindex="true">bar.coredump</filename></title> |
244 | ||
245 | <programlisting># coredumpctl -o bar.coredump dump /usr/bin/bar</programlisting> | |
246 | </example> | |
247 | </refsect1> | |
248 | ||
249 | <refsect1> | |
250 | <title>See Also</title> | |
251 | <para> | |
252 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
253 | <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
254 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
255 | <citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
256 | </para> | |
257 | </refsect1> | |
5de0409e ZJS |
258 | |
259 | </refentry> |