]>
Commit | Line | Data |
---|---|---|
5de0409e ZJS |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
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 | ||
dfdebb1b ZJS |
24 | <refentry id="systemd-coredumpctl" conditional='ENABLE_COREDUMP' |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
5de0409e ZJS |
26 | |
27 | <refentryinfo> | |
28 | <title>systemd-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>systemd-coredumpctl</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemd-coredumpctl</refname> | |
48 | <refpurpose>Retrieve coredumps from the journal</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
7e15bd33 ZJS |
53 | <command>systemd-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> | |
5de0409e ZJS |
57 | </cmdsynopsis> |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | ||
63 | <para><command>systemd-coredumpctl</command> may be used to | |
64 | retrieve coredumps from | |
65 | <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
66 | </refsect1> | |
67 | ||
68 | <refsect1> | |
69 | <title>Options</title> | |
70 | ||
71 | <para>The following options are understood:</para> | |
72 | ||
73 | <variablelist> | |
4f76ae1b | 74 | <varlistentry> |
4f76ae1b | 75 | <term><option>-F</option></term> |
a7f5bb1e | 76 | <term><option>--field=</option></term> |
4f76ae1b ZJS |
77 | |
78 | <listitem><para>Print all possible | |
79 | data values the specified field | |
80 | takes in matching coredump entries of the | |
81 | journal.</para></listitem> | |
82 | </varlistentry> | |
83 | ||
5de0409e | 84 | <varlistentry> |
a7f5bb1e | 85 | <term><option>-o</option></term> |
5de0409e | 86 | <term><option>--output=FILE</option></term> |
5de0409e ZJS |
87 | |
88 | <listitem><para>Write the core to | |
89 | <option>FILE</option>.</para></listitem> | |
90 | </varlistentry> | |
91 | ||
9a340880 ZJS |
92 | <varlistentry> |
93 | <term><option>--no-legend</option></term> | |
94 | ||
95 | <listitem><para>Do not print the column headers. | |
96 | </para></listitem> | |
97 | </varlistentry> | |
98 | ||
dfdebb1b ZJS |
99 | <xi:include href="standard-options.xml" xpointer="help" /> |
100 | <xi:include href="standard-options.xml" xpointer="version" /> | |
101 | <xi:include href="standard-options.xml" xpointer="no-pager" /> | |
5de0409e ZJS |
102 | </variablelist> |
103 | ||
104 | <para>The following commands are understood:</para> | |
105 | ||
106 | <variablelist> | |
107 | <varlistentry> | |
108 | <term><command>list</command></term> | |
109 | ||
110 | <listitem><para>List coredumps captured in the journal | |
111 | matching specified characteristics.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><command>dump</command></term> | |
116 | ||
117 | <listitem><para>Extract the last coredump | |
118 | matching specified characteristics. | |
66f756d4 | 119 | The coredump will be written on standard output, |
6db27428 | 120 | unless an output file is specified with |
5de0409e ZJS |
121 | <option>-o/--output</option>. |
122 | </para></listitem> | |
123 | </varlistentry> | |
124 | ||
ada45c78 LP |
125 | |
126 | <varlistentry> | |
127 | <term><command>gdb</command></term> | |
128 | ||
129 | <listitem><para>Invoke the GNU | |
130 | debugger on the last coredump matching | |
131 | specified characteristics. | |
132 | </para></listitem> | |
133 | </varlistentry> | |
134 | ||
5de0409e ZJS |
135 | </variablelist> |
136 | ||
137 | </refsect1> | |
138 | ||
139 | <refsect1> | |
140 | <title>Matching</title> | |
141 | ||
142 | <para>Match can be:</para> | |
143 | ||
144 | <variablelist> | |
145 | <varlistentry> | |
6b76fa66 | 146 | <term><replaceable>PID</replaceable></term> |
5de0409e ZJS |
147 | |
148 | <listitem><para>Process ID of the | |
149 | process that dumped | |
150 | core. An integer.</para></listitem> | |
151 | </varlistentry> | |
152 | ||
153 | <varlistentry> | |
6b76fa66 | 154 | <term><replaceable>COMM</replaceable></term> |
5de0409e ZJS |
155 | |
156 | <listitem><para>Name of the executable | |
157 | (matches <option>COREDUMP_COMM=</option>). | |
158 | Must not contain slashes. | |
159 | </para></listitem> | |
160 | </varlistentry> | |
161 | ||
162 | <varlistentry> | |
6b76fa66 | 163 | <term><replaceable>EXE</replaceable></term> |
5de0409e ZJS |
164 | |
165 | <listitem><para>Path to the executable | |
166 | (matches <option>COREDUMP_EXE=</option>). | |
167 | Must contain at least one slash. | |
168 | </para></listitem> | |
169 | </varlistentry> | |
170 | ||
171 | <varlistentry> | |
6b76fa66 | 172 | <term><replaceable>MATCH</replaceable></term> |
5de0409e ZJS |
173 | |
174 | <listitem><para>General journalctl predicates | |
175 | (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>). | |
176 | Must contain an equals sign. | |
177 | </para></listitem> | |
178 | </varlistentry> | |
179 | </variablelist> | |
180 | </refsect1> | |
181 | ||
182 | <refsect1> | |
183 | <title>Exit status</title> | |
bcddd5bf JSJ |
184 | <para>On success, 0 is returned; otherwise, a non-zero failure |
185 | code is returned. Not finding any matching coredumps is treated | |
e9c1ea9d JSJ |
186 | as failure. |
187 | </para> | |
5de0409e ZJS |
188 | </refsect1> |
189 | ||
190 | <refsect1> | |
191 | <title>See Also</title> | |
192 | <para> | |
ada45c78 LP |
193 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
194 | <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
5de0409e ZJS |
195 | </para> |
196 | </refsect1> | |
197 | ||
198 | </refentry> |