X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fbootchart.conf.xml;h=a364826bb01d3e9a4cafc8620c7633e75d44276a;hp=f8fcfe010360f1283e99c8ed4f82aab42f0a0181;hb=d0928791499734e202460d5c027b5d3e0d28e7ab;hpb=83fdc450aa8f79941bec84488ffd5bf8eadab18e

diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml
index f8fcfe010..a364826bb 100644
--- a/man/bootchart.conf.xml
+++ b/man/bootchart.conf.xml
@@ -25,7 +25,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="bootchart.conf">
+<refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
         <refentryinfo>
                 <title>bootchart.conf</title>
                 <productname>systemd</productname>
@@ -47,37 +48,45 @@
 
         <refnamediv>
                 <refname>bootchart.conf</refname>
-                <refpurpose>Boot performance analysis graphing tool configuration file</refpurpose>
+                <refname>bootchart.conf.d</refname>
+                <refpurpose>Boot performance analysis graphing tool configuration files</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
                 <para><filename>/etc/systemd/bootchart.conf</filename></para>
+                <para><filename>/etc/systemd/bootchart.conf.d/*.conf</filename></para>
+                <para><filename>/run/systemd/bootchart.conf.d/*.conf</filename></para>
+                <para><filename>/usr/lib/systemd/bootchart.conf.d/*.conf</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>When starting, systemd-bootchart will read the
-                configuration file <filename>bootchart.conf</filename>.
-                This configuration file determines logging parameters and
-                graph output.</para>
-
+                configuration file
+                <filename>/etc/systemd/bootchart.conf</filename>, followed by
+                the files in the <filename>bootchart.conf.d</filename>
+                directories.  These configuration files determine logging
+                parameters and graph output.</para>
         </refsect1>
 
+        <xi:include href="standard-conf.xml" xpointer="confd" />
+        <xi:include href="standard-conf.xml" xpointer="conf" />
+
         <refsect1>
                 <title>Options</title>
 
                 <variablelist class='bootchart-directives'>
 
                         <varlistentry>
-                                <term><varname>samples=500</varname></term>
+                                <term><varname>Samples=500</varname></term>
                                 <listitem><para>Configure the amount of samples to
-                                record total before bootchart exits. Each sample will
-                                record at intervals defined by freq=.</para></listitem>
+                                record in total before bootchart exits. Each sample will
+                                record at intervals defined by Frequency=.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>freq=25</varname></term>
+                                <term><varname>Frequency=25</varname></term>
                                 <listitem><para>Configure the sample log frequency.
                                 This can be a fractional number, but must be larger than
                                 0.0. Most systems can cope with values under 25-50 without
@@ -85,18 +94,18 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>rel=0</varname></term>
+                                <term><varname>Relative=no</varname></term>
                                 <listitem><para>Configures whether the left axis of the
-                                output graph equals time=0.0 (CLOCK_MONOTONIC start). This
+                                output graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant> start). This
                                 is useful for using bootchart at post-boot time to profile
                                 an already booted system, otherwise the graph would become
-                                extremely large. If set to a non-zero value, the horizontal
-                                axis starts at the first recorded sample instead of time=0.0.
+                                extremely large. If set to yes, the horizontal axis starts
+                                at the first recorded sample instead of time=0.0.
                                 </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>filter=0</varname></term>
+                                <term><varname>Filter=no</varname></term>
                                 <listitem><para>Configures whether the resulting graph
                                 should omit tasks that did not contribute significantly
                                 to the boot. Processes that are too short-lived (only
@@ -106,14 +115,14 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>output=[path]</varname></term>
-                                <listitem><para>Configures the output folder for writing
+                                <term><varname>Output=[path]</varname></term>
+                                <listitem><para>Configures the output directory for writing
                                 the graphs. By default, bootchart writes the graphs to
-                                <filename>/var/log</filename>.</para></listitem>
+                                <filename>/run/log</filename>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>init=[path]</varname></term>
+                                <term><varname>Init=[path]</varname></term>
                                 <listitem><para>Configures bootchart to run a non-standard
                                 binary instead of <filename>/sbin/init</filename>. This
                                 option is only relevant if bootchart was invoked from the
@@ -122,36 +131,42 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>pss=0</varname></term>
-                                <listitem><para>If set to 1, enables logging and graphing
-                                of processes PSS memory consumption.</para></listitem>
+                                <term><varname>PlotMemoryUsage=no</varname></term>
+                                <listitem><para>If set to yes, enables logging and graphing
+                                of processes' PSS memory consumption.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>entropy=0</varname></term>
-                                <listitem><para>If set to 1, enables logging and graphing
+                                <term><varname>PlotEntropyGraph=no</varname></term>
+                                <listitem><para>If set to yes, enables logging and graphing
                                 of the kernel random entropy pool size.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>scale_x=100</varname></term>
+                                <term><varname>ScaleX=100</varname></term>
                                 <listitem><para>Horizontal scaling factor for all variable
                                 graph components.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>scale_y=20</varname></term>
+                                <term><varname>ScaleY=20</varname></term>
                                 <listitem><para>Vertical scaling factor for all variable
                                 graph components.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>ControlGroup=no</varname></term>
+                                <listitem><para>Display process control group.</para></listitem>
+                        </varlistentry>
+
                 </variablelist>
         </refsect1>
 
         <refsect1>
                   <title>See Also</title>
                   <para>
-                          <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                   </para>
         </refsect1>