man: minor addition to coredumpctl example

[elogind.git] / man / coredumpctl.xml

diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml
index 159fabb84085f5f13ecf35372e463c66906b0822..ed84621d3798dcaeb1faee0529373aee49bdff91 100644 (file)
--- a/man/coredumpctl.xml
+++ b/man/coredumpctl.xml
@@ -71,6 +71,22 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
+                        <varlistentry>
+                                <term><option>--no-legend</option></term>
+
+                                <listitem><para>Do not print the column headers.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-1</option></term>
+
+                                <listitem><para>Show information of a
+                                single coredump only, instead of
+                                listing all known coredumps.
+                                </para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>-F</option></term>
                                 <term><option>--field=</option></term>
@@ -89,16 +105,10 @@
                                 <option>FILE</option>.</para></listitem>
                         </varlistentry>
 
-                        <varlistentry>
-                                <term><option>--no-legend</option></term>
-
-                                <listitem><para>Do not print the column headers.
-                                </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>
@@ -107,8 +117,19 @@
                         <varlistentry>
                                 <term><command>list</command></term>
 
-                                <listitem><para>List coredumps captured in the journal
-                                matching specified characteristics.</para></listitem>
+                                <listitem><para>List coredumps
+                                captured in the journal matching
+                                specified characteristics. If no
+                                command is specified, this is the
+                                implied default.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>info</command></term>
+
+                                <listitem><para>Show detailed
+                                information about coredumps captured
+                                in the journal.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -122,7 +143,6 @@
                                 </para></listitem>
                         </varlistentry>
 
-
                         <varlistentry>
                                 <term><command>gdb</command></term>
 
@@ -139,7 +159,7 @@
         <refsect1>
                 <title>Matching</title>
 
-                <para>Match can be:</para>
+                <para>A match can be:</para>
 
                 <variablelist>
                         <varlistentry>
@@ -173,7 +193,7 @@
 
                                 <listitem><para>General journalctl predicates
                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
-                                Must contain an equals sign.
+                                Must contain an equal sign.
                                 </para></listitem>
                         </varlistentry>
                 </variablelist>
@@ -187,11 +207,41 @@
                 </para>
         </refsect1>
 
+        <refsect1>
+                <title>Examples</title>
+
+                <example>
+                        <title>List all the coredumps of a program named foo</title>
+
+                        <programlisting># coredumpctl list foo</programlisting>
+                </example>
+
+                <example>
+                        <title>Invoke gdb on the last coredump</title>
+
+                        <programlisting># coredumpctl gdb</programlisting>
+                </example>
+
+                <example>
+                        <title>Show information about a process that dumped core, matching by its PID 6654</title>
+
+                        <programlisting># coredumpctl info 6654</programlisting>
+                </example>
+
+                <example>
+                        <title>Extract the last coredump of /usr/bin/bar to a file named bar.coredump</title>
+
+                        <programlisting># coredumpctl -o bar.coredump dump /usr/bin/bar</programlisting>
+                </example>
+        </refsect1>
+
         <refsect1>
                 <title>See Also</title>
                 <para>
+                        <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>