bootchart: Ensure that systemd is the init called after using bootchart

[elogind.git] / man / systemd-bootchart.xml

diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml
index 9067d6530cf35f6c7ef999398a7d98988ab71f15..ff86be2ad8b6726aec5bcd5b6cd7c72c2ad63572 100644 (file)
--- a/man/systemd-bootchart.xml
+++ b/man/systemd-bootchart.xml
@@ -26,7 +26,9 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-bootchart" conditional='ENABLE_BOOTCHART'>
+<refentry id="systemd-bootchart" conditional='ENABLE_BOOTCHART'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
+
         <refentryinfo>
                 <title>systemd-bootchart</title>
                 <productname>systemd</productname>
@@ -62,7 +64,7 @@
                         as an SVG graph. Normally, systemd-bootchart
                         is invoked by the kernel by passing
                         <option>init=<filename>/usr/lib/systemd/systemd-bootchart</filename></option>
-                        on the kernel commandline. systemd-bootchart will then
+                        on the kernel command line. systemd-bootchart will then
                         fork the real init off to resume normal system
                         startup, while monitoring and logging startup
                         information in the background.
@@ -76,8 +78,8 @@
                         in which order, and where possible problems
                         exist in the startup sequence of the system.
                         It is essentially a more detailed version of
-                        the <command>systemd-analyze</command>
-                        <command>plot</command> function.
+                        the <command>systemd-analyze plot</command>
+                        function.
                 </para>
                 <para>
                         Of course, bootchart can also be used at any
@@ -92,7 +94,11 @@
                 </para>
                 <para>
                         Bootchart graphs are by default written
-                        time-stamped in <filename>/run/log</filename>.
+                        time-stamped in <filename>/run/log</filename>
+                        and saved to the journal with
+                        <varname>MESSAGE_ID=9f26aa562cf440c2b16c773d0479b518</varname>.
+                        Journal field <varname>BOOTCHART=</varname> contains
+                        the bootchart in SVG format.
                 </para>
 
         </refsect1>
@@ -110,7 +116,7 @@
                                 <command>systemd-bootchart</command>
                                 instead of the init process. In turn,
                                 <command>systemd-bootchart</command>
-                                will invoke <command>/sbin/init</command>.
+                                will invoke <command>/usr/lib/systemd/systemd</command>.
                                 </para></listitem>
                         </varlistentry>
 
@@ -119,13 +125,15 @@
                                 <listitem><para>One can execute
                                 <command>systemd-bootchart</command>
                                 as normal application from the
-                                commandline. In this mode it is highly
+                                command line. In this mode it is highly
                                 recommended to pass the
                                 <option>-r</option> flag in order to
                                 not graph the time elapsed since boot
                                 and before systemd-bootchart was
                                 started, as it may result in extremely
-                                large graphs.  </para></listitem>
+                                large graphs. The time elapsed since boot
+                                might also include any time that the system
+                                was suspended.</para></listitem>
                         </varlistentry>
                 </variablelist>
         </refsect1>
@@ -136,10 +144,11 @@
                 <para>These options can also be set in the
                 <filename>/etc/systemd/bootchart.conf</filename>
                 file. See
-                <citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                <citerefentry project='man-pages'><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
                 </para>
 
                 <variablelist>
+                        <xi:include href="standard-options.xml" xpointer="help" />
 
                         <varlistentry>
                                 <term><option>-n</option></term>
@@ -182,10 +191,25 @@
                                 </para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>-C</option></term>
+                                <term><option>--cmdline</option></term>
+                                <listitem><para>Display the full command line with arguments of processes,
+                                instead of only the process name.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-g</option></term>
+                                <term><option>--control-group</option></term>
+                                <listitem><para>Display process control group
+                                </para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>-o</option></term>
                                 <term><option>--output <replaceable>path</replaceable></option></term>
-                                <listitem><para>Specify the output folder for the
+                                <listitem><para>Specify the output directory for the
                                 graphs. By default, bootchart writes the graphs to
                                 <filename>/run/log</filename>.</para></listitem>
                         </varlistentry>
@@ -194,7 +218,7 @@
                                 <term><option>-i</option></term>
                                 <term><option>--init <replaceable>path</replaceable></option></term>
                                 <listitem><para>Use this init binary. Defaults to
-                                <command>/sbin/init</command>.
+                                <command>/usr/lib/systemd/systemd</command>.
                                 </para></listitem>
                         </varlistentry>
 
@@ -294,7 +318,7 @@
         <refsect1>
                 <title>See Also</title>
                 <para>
-                        <citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                        <citerefentry project='man-pages'><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>