summaryrefslogtreecommitdiff
path: root/man/bootchart.conf.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/bootchart.conf.xml')
-rw-r--r--man/bootchart.conf.xml289
1 files changed, 145 insertions, 144 deletions
diff --git a/man/bootchart.conf.xml b/man/bootchart.conf.xml
index e11ccb52f6..8bafcbedcc 100644
--- a/man/bootchart.conf.xml
+++ b/man/bootchart.conf.xml
@@ -1,7 +1,7 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
@@ -26,148 +26,149 @@
-->
<refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART'
- xmlns:xi="http://www.w3.org/2001/XInclude">
- <refentryinfo>
- <title>bootchart.conf</title>
- <productname>systemd</productname>
-
- <authorgroup>
- <author>
- <contrib>Developer</contrib>
- <firstname>Auke</firstname>
- <surname>Kok</surname>
- <email>auke-jan.h.kok@intel.com</email>
- </author>
- </authorgroup>
- </refentryinfo>
-
- <refmeta>
- <refentrytitle>bootchart.conf</refentrytitle>
- <manvolnum>5</manvolnum>
- </refmeta>
-
- <refnamediv>
- <refname>bootchart.conf</refname>
- <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>/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>
- <listitem><para>Configure the amount of samples to
- record in total before bootchart exits. Each sample will
- record at intervals defined by Frequency=.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <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
- impacting boot time severely.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>Relative=no</varname></term>
- <listitem><para>Configures whether the left axis of the
- 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 yes, the horizontal axis starts
- at the first recorded sample instead of time=0.0.
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <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
- seen in one sample) or that do not consume any significant
- CPU time (less than 0.001sec) will not be displayed in
- the output graph.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>Output=[path]</varname></term>
- <listitem><para>Configures the output directory for writing
- the graphs. By default, bootchart writes the graphs to
- <filename>/run/log</filename>.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><varname>Init=[path]</varname></term>
- <listitem><para>Configures bootchart to run a non-standard
- binary instead of <filename>/usr/lib/systemd/systemd</filename>. This
- option is only relevant if bootchart was invoked from the
- kernel command line with
- init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <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>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>ScaleX=100</varname></term>
- <listitem><para>Horizontal scaling factor for all variable
- graph components.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <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.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- </para>
- </refsect1>
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refentryinfo>
+ <title>bootchart.conf</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Auke</firstname>
+ <surname>Kok</surname>
+ <email>auke-jan.h.kok@intel.com</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>bootchart.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>bootchart.conf</refname>
+ <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>/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>
+ <listitem><para>Configure the amount of samples to record in
+ total before bootchart exits. Each sample will record at
+ intervals defined by Frequency=.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <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 impacting
+ boot time severely.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>Relative=no</varname></term>
+ <listitem><para>Configures whether the left axis of the 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 yes, the horizontal axis
+ starts at the first recorded sample instead of time=0.0.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <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 seen in one sample)
+ or that do not consume any significant CPU time (less than
+ 0.001sec) will not be displayed in the output
+ graph.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>Output=[path]</varname></term>
+ <listitem><para>Configures the output directory for writing
+ the graphs. By default, bootchart writes the graphs to
+ <filename>/run/log</filename>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>Init=[path]</varname></term>
+ <listitem><para>Configures bootchart to run a non-standard
+ binary instead of
+ <filename>/usr/lib/systemd/systemd</filename>. This option is
+ only relevant if bootchart was invoked from the kernel command
+ line with
+ init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <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>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>ScaleX=100</varname></term>
+ <listitem><para>Horizontal scaling factor for all variable
+ graph components.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <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.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ </para>
+ </refsect1>
</refentry>