]>
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 | ||
d51167c6 | 24 | <refentry id="systemd-coredumpctl" conditional='ENABLE_COREDUMP'> |
5de0409e ZJS |
25 | |
26 | <refentryinfo> | |
27 | <title>systemd-coredumpctl</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Zbigniew</firstname> | |
34 | <surname>Jędrzejewski-Szmek</surname> | |
35 | <email>zbyszek@in.waw.pl</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>systemd-coredumpctl</refentrytitle> | |
42 | <manvolnum>1</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd-coredumpctl</refname> | |
47 | <refpurpose>Retrieve coredumps from the journal</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <cmdsynopsis> | |
7e15bd33 ZJS |
52 | <command>systemd-coredumpctl</command> |
53 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
54 | <arg choice="req">COMMAND</arg> | |
55 | <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg> | |
5de0409e ZJS |
56 | </cmdsynopsis> |
57 | </refsynopsisdiv> | |
58 | ||
59 | <refsect1> | |
60 | <title>Description</title> | |
61 | ||
62 | <para><command>systemd-coredumpctl</command> may be used to | |
63 | retrieve coredumps from | |
64 | <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> | |
65 | </refsect1> | |
66 | ||
67 | <refsect1> | |
68 | <title>Options</title> | |
69 | ||
70 | <para>The following options are understood:</para> | |
71 | ||
72 | <variablelist> | |
73 | <varlistentry> | |
5de0409e | 74 | <term><option>-h</option></term> |
a7f5bb1e | 75 | <term><option>--help</option></term> |
5de0409e ZJS |
76 | |
77 | <listitem><para>Print a short help | |
78 | text and exit.</para></listitem> | |
79 | </varlistentry> | |
80 | ||
81 | <varlistentry> | |
82 | <term><option>--version</option></term> | |
83 | ||
84 | <listitem><para>Print a short version | |
85 | string and exit.</para></listitem> | |
86 | </varlistentry> | |
87 | ||
4f76ae1b | 88 | <varlistentry> |
4f76ae1b | 89 | <term><option>-F</option></term> |
a7f5bb1e | 90 | <term><option>--field=</option></term> |
4f76ae1b ZJS |
91 | |
92 | <listitem><para>Print all possible | |
93 | data values the specified field | |
94 | takes in matching coredump entries of the | |
95 | journal.</para></listitem> | |
96 | </varlistentry> | |
97 | ||
5de0409e | 98 | <varlistentry> |
a7f5bb1e | 99 | <term><option>-o</option></term> |
5de0409e | 100 | <term><option>--output=FILE</option></term> |
5de0409e ZJS |
101 | |
102 | <listitem><para>Write the core to | |
103 | <option>FILE</option>.</para></listitem> | |
104 | </varlistentry> | |
105 | ||
106 | <varlistentry> | |
107 | <term><option>--no-pager</option></term> | |
108 | ||
109 | <listitem><para>Do not pipe output of | |
110 | <command>list</command> into a | |
111 | pager.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
9a340880 ZJS |
114 | <varlistentry> |
115 | <term><option>--no-legend</option></term> | |
116 | ||
117 | <listitem><para>Do not print the column headers. | |
118 | </para></listitem> | |
119 | </varlistentry> | |
120 | ||
5de0409e ZJS |
121 | </variablelist> |
122 | ||
123 | <para>The following commands are understood:</para> | |
124 | ||
125 | <variablelist> | |
126 | <varlistentry> | |
127 | <term><command>list</command></term> | |
128 | ||
129 | <listitem><para>List coredumps captured in the journal | |
130 | matching specified characteristics.</para></listitem> | |
131 | </varlistentry> | |
132 | ||
133 | <varlistentry> | |
134 | <term><command>dump</command></term> | |
135 | ||
136 | <listitem><para>Extract the last coredump | |
137 | matching specified characteristics. | |
138 | Coredump will be written on stdout, unless | |
139 | an output file is specified with | |
140 | <option>-o/--output</option>. | |
141 | </para></listitem> | |
142 | </varlistentry> | |
143 | ||
ada45c78 LP |
144 | |
145 | <varlistentry> | |
146 | <term><command>gdb</command></term> | |
147 | ||
148 | <listitem><para>Invoke the GNU | |
149 | debugger on the last coredump matching | |
150 | specified characteristics. | |
151 | </para></listitem> | |
152 | </varlistentry> | |
153 | ||
5de0409e ZJS |
154 | </variablelist> |
155 | ||
156 | </refsect1> | |
157 | ||
158 | <refsect1> | |
159 | <title>Matching</title> | |
160 | ||
161 | <para>Match can be:</para> | |
162 | ||
163 | <variablelist> | |
164 | <varlistentry> | |
6b76fa66 | 165 | <term><replaceable>PID</replaceable></term> |
5de0409e ZJS |
166 | |
167 | <listitem><para>Process ID of the | |
168 | process that dumped | |
169 | core. An integer.</para></listitem> | |
170 | </varlistentry> | |
171 | ||
172 | <varlistentry> | |
6b76fa66 | 173 | <term><replaceable>COMM</replaceable></term> |
5de0409e ZJS |
174 | |
175 | <listitem><para>Name of the executable | |
176 | (matches <option>COREDUMP_COMM=</option>). | |
177 | Must not contain slashes. | |
178 | </para></listitem> | |
179 | </varlistentry> | |
180 | ||
181 | <varlistentry> | |
6b76fa66 | 182 | <term><replaceable>EXE</replaceable></term> |
5de0409e ZJS |
183 | |
184 | <listitem><para>Path to the executable | |
185 | (matches <option>COREDUMP_EXE=</option>). | |
186 | Must contain at least one slash. | |
187 | </para></listitem> | |
188 | </varlistentry> | |
189 | ||
190 | <varlistentry> | |
6b76fa66 | 191 | <term><replaceable>MATCH</replaceable></term> |
5de0409e ZJS |
192 | |
193 | <listitem><para>General journalctl predicates | |
194 | (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>). | |
195 | Must contain an equals sign. | |
196 | </para></listitem> | |
197 | </varlistentry> | |
198 | </variablelist> | |
199 | </refsect1> | |
200 | ||
201 | <refsect1> | |
202 | <title>Exit status</title> | |
203 | <para>On success 0 is returned, a non-zero failure | |
5a5c72ca | 204 | code otherwise. Not finding any matching coredumps is treated |
5de0409e ZJS |
205 | as failure. |
206 | </para> | |
207 | </refsect1> | |
208 | ||
209 | <refsect1> | |
210 | <title>See Also</title> | |
211 | <para> | |
ada45c78 LP |
212 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
213 | <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
5de0409e ZJS |
214 | </para> |
215 | </refsect1> | |
216 | ||
217 | </refentry> |