chiark / gitweb /
execute: Fix seccomp support on x32
[elogind.git] / man / systemd-bootchart.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <!--
7   This file is part of systemd.
8
9   Copyright 2012 Intel Corporation
10
11   Authors:
12     Auke Kok <auke-jan.h.kok@intel.com>
13
14   systemd is free software; you can redistribute it and/or modify it
15   under the terms of the GNU Lesser General Public License as published by
16   the Free Software Foundation; either version 2.1 of the License, or
17   (at your option) any later version.
18
19   systemd is distributed in the hope that it will be useful, but
20   WITHOUT ANY WARRANTY; without even the implied warranty of
21   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22   Lesser General Public License for more details.
23
24   You should have received a copy of the GNU Lesser General Public License
25   along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 -->
27
28 <refentry id="systemd-bootchart">
29         <refentryinfo>
30                 <title>systemd-bootchart</title>
31                 <productname>systemd</productname>
32
33                 <authorgroup>
34                         <author>
35                                 <contrib>Developer</contrib>
36                                 <firstname>Auke</firstname>
37                                 <surname>Kok</surname>
38                                 <email>auke-jan.h.kok@intel.com</email>
39                         </author>
40                 </authorgroup>
41         </refentryinfo>
42
43         <refmeta>
44                 <refentrytitle>systemd-bootchart</refentrytitle>
45                 <manvolnum>1</manvolnum>
46         </refmeta>
47
48         <refnamediv>
49                 <refname>systemd-bootchart</refname>
50                 <refpurpose>Boot performance analysis graphing tool</refpurpose>
51         </refnamediv>
52
53         <refsect1>
54                 <title>Description</title>
55
56                 <para>Systemd-bootchart is an boot time analysis tool. It represents
57                 various aspects of the system as graph elements. These graph
58                 elements allow the user to determine resource usage, efficiency
59                 and performance issues.</para>
60
61         </refsect1>
62
63         <refsect1>
64                 <title>Invocation</title>
65
66                 <para>systemd-bootchart can be invoked in several different ways:</para>
67
68                 <variablelist class='bootchart-invocation'>
69
70                         <varlistentry>
71                                 <title>Kernel invocation</title>
72                                 <listitem><para>The kernel can invoke systemd-bootchart
73                                 instead of the init process. In itself, systemd-bootchart
74                                 will invoke <filename>/sbin/init</filename> if invoked in
75                                 this matter.</para></listitem>
76                         </varlistentry>
77
78                         <varlistentry>
79                                 <title>Started as a standalone program</title>
80                                 <listitem><para>One can execute systemd-bootchart as
81                                 normal application from the commandline. In this mode
82                                 it is highly recommended to pass the "-r" flag in order
83                                 to not graph the time elapsed since boot and before
84                                 systemd-bootchart was started, as it may result in
85                                 extremely large graphs.
86                                 </para></listitem>
87                         </varlistentry>
88                 </variablelist>
89         </refsect1>
90
91         <refsect1>
92                 <title>Options</title>
93
94                 <para>Please read systemd-bootchart --help or the bootchart.conf manual
95                 page for information about the various options that influence how
96                 systemd-bootchart operates.</para>
97         </refsect1>
98
99         <refsect1>
100                 <title>Output</title>
101
102                 <para>Systemd-bootchart generates SVG graphs. In order to render these
103                 on a graphical display any SVG capable viewer can be used. It should be
104                 noted that the SVG render engines in most browsers (including Chrome
105                 and Firefox) are many times faster than dedicated graphical applications
106                 like Gimp and Inkscape.  Just point your browser at "file:///var/log"!
107                 </para>
108         </refsect1>
109
110         <refsect1>
111                   <title>See Also</title>
112                   <para>
113                           <citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
114                   </para>
115         </refsect1>
116
117 </refentry>