| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY sysprof-download-http "&gnome-download-http;/sysprof/&sysprof-minor;/sysprof-&sysprof-version;.tar.xz">
|
|---|
| 8 | <!ENTITY sysprof-download-ftp "&gnome-download-ftp;/sysprof/&sysprof-minor;/sysprof-&sysprof-version;.tar.xz">
|
|---|
| 9 | <!ENTITY sysprof-md5sum "ee1556063c7b8d9abd414f451b04c33a">
|
|---|
| 10 | <!ENTITY sysprof-size "524 KB">
|
|---|
| 11 | <!ENTITY sysprof-buildsize "27 MB">
|
|---|
| 12 | <!ENTITY sysprof-time "0.1 SBU (using parallelism=4)">
|
|---|
| 13 |
|
|---|
| 14 | ]>
|
|---|
| 15 |
|
|---|
| 16 | <sect1 id="sysprof" xreflabel="sysprof-&sysprof-version;">
|
|---|
| 17 | <?dbhtml filename="sysprof.html"?>
|
|---|
| 18 |
|
|---|
| 19 |
|
|---|
| 20 | <title>Sysprof-&sysprof-version;</title>
|
|---|
| 21 |
|
|---|
| 22 | <indexterm zone="sysprof">
|
|---|
| 23 | <primary sortas="a-sysprof">sysprof</primary>
|
|---|
| 24 | </indexterm>
|
|---|
| 25 |
|
|---|
| 26 | <sect2 role="package">
|
|---|
| 27 | <title>Introduction to Sysprof</title>
|
|---|
| 28 |
|
|---|
| 29 | <para>
|
|---|
| 30 | The <application>sysprof</application> package contains a statistical and
|
|---|
| 31 | system-wide profiler for Linux.
|
|---|
| 32 | </para>
|
|---|
| 33 |
|
|---|
| 34 | &lfs120_checked;
|
|---|
| 35 |
|
|---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 37 | <itemizedlist spacing="compact">
|
|---|
| 38 | <listitem>
|
|---|
| 39 | <para>
|
|---|
| 40 | Download (HTTP): <ulink url="&sysprof-download-http;"/>
|
|---|
| 41 | </para>
|
|---|
| 42 | </listitem>
|
|---|
| 43 | <listitem>
|
|---|
| 44 | <para>
|
|---|
| 45 | Download (FTP): <ulink url="&sysprof-download-ftp;"/>
|
|---|
| 46 | </para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>
|
|---|
| 50 | Download MD5 sum: &sysprof-md5sum;
|
|---|
| 51 | </para>
|
|---|
| 52 | </listitem>
|
|---|
| 53 | <listitem>
|
|---|
| 54 | <para>
|
|---|
| 55 | Download size: &sysprof-size;
|
|---|
| 56 | </para>
|
|---|
| 57 | </listitem>
|
|---|
| 58 | <listitem>
|
|---|
| 59 | <para>
|
|---|
| 60 | Estimated disk space required: &sysprof-buildsize;
|
|---|
| 61 | </para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | <listitem>
|
|---|
| 64 | <para>
|
|---|
| 65 | Estimated build time: &sysprof-time;
|
|---|
| 66 | </para>
|
|---|
| 67 | </listitem>
|
|---|
| 68 | </itemizedlist>
|
|---|
| 69 |
|
|---|
| 70 | <bridgehead renderas="sect3">Sysprof Dependencies</bridgehead>
|
|---|
| 71 |
|
|---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 73 | <para role="required">
|
|---|
| 74 | <xref linkend="desktop-file-utils"/>,
|
|---|
| 75 | <xref linkend="gtk4"/>,
|
|---|
| 76 | <xref linkend="itstool"/>,
|
|---|
| 77 | <xref linkend="json-glib"/>,
|
|---|
| 78 | <xref linkend="libadwaita1"/>,
|
|---|
| 79 | <xref linkend="libdazzle"/>,
|
|---|
| 80 | <xref linkend="libunwind"/>, <phrase revision="systemd">and</phrase>
|
|---|
| 81 | <xref linkend="polkit"/> <phrase revision="sysv">, and</phrase>
|
|---|
| 82 | <phrase revision="sysv"><xref linkend="elogind"/></phrase>
|
|---|
| 83 | </para>
|
|---|
| 84 |
|
|---|
| 85 | </sect2>
|
|---|
| 86 |
|
|---|
| 87 | <sect2 role="installation">
|
|---|
| 88 | <title>Installation of Sysprof</title>
|
|---|
| 89 |
|
|---|
| 90 | <para>
|
|---|
| 91 | Install <application>Sysprof</application> by running the following
|
|---|
| 92 | commands:
|
|---|
| 93 | </para>
|
|---|
| 94 |
|
|---|
| 95 | <screen revision="sysv"><userinput>mkdir build &&
|
|---|
| 96 | cd build &&
|
|---|
| 97 |
|
|---|
| 98 | meson setup --prefix=/usr \
|
|---|
| 99 | --buildtype=release \
|
|---|
| 100 | -Dsystemdunitdir=/tmp \
|
|---|
| 101 | .. &&
|
|---|
| 102 | ninja</userinput></screen>
|
|---|
| 103 |
|
|---|
| 104 | <screen revision="systemd"><userinput>mkdir build &&
|
|---|
| 105 | cd build &&
|
|---|
| 106 |
|
|---|
| 107 | meson setup --prefix=/usr --buildtype=release .. &&
|
|---|
| 108 | ninja</userinput></screen>
|
|---|
| 109 |
|
|---|
| 110 | <para>
|
|---|
| 111 | To test the results, issue: <command>ninja test</command>.
|
|---|
| 112 | </para>
|
|---|
| 113 |
|
|---|
| 114 | <para>
|
|---|
| 115 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 116 | </para>
|
|---|
| 117 |
|
|---|
| 118 | <screen role="root" revision="sysv"><userinput>ninja install &&
|
|---|
| 119 | rm -v /tmp/*.service</userinput></screen>
|
|---|
| 120 |
|
|---|
| 121 | <screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>
|
|---|
| 122 |
|
|---|
| 123 | </sect2>
|
|---|
| 124 |
|
|---|
| 125 | <sect2 role="commands" revision="sysv">
|
|---|
| 126 | <title>Command Explanations</title>
|
|---|
| 127 |
|
|---|
| 128 | <para>
|
|---|
| 129 | <command>rm -v /tmp/*.service</command>: This command removes
|
|---|
| 130 | systemd units which have no use on SysV systems.
|
|---|
| 131 | </para>
|
|---|
| 132 |
|
|---|
| 133 | <para>
|
|---|
| 134 | <parameter>-Dsystemdunitdir=/tmp</parameter>: This parameter puts systemd
|
|---|
| 135 | units in /tmp on SysV systems so that they can be removed. It also bypasses
|
|---|
| 136 | a check for systemd <!-- for sd-bus --> in the meson.build file.
|
|---|
| 137 | </para>
|
|---|
| 138 |
|
|---|
| 139 | </sect2>
|
|---|
| 140 |
|
|---|
| 141 | <sect2 role="content">
|
|---|
| 142 | <title>Contents</title>
|
|---|
| 143 |
|
|---|
| 144 | <segmentedlist>
|
|---|
| 145 | <segtitle>Installed Programs</segtitle>
|
|---|
| 146 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 147 | <segtitle>Installed Directories</segtitle>
|
|---|
| 148 |
|
|---|
| 149 | <seglistitem>
|
|---|
| 150 | <seg>
|
|---|
| 151 | sysprof,
|
|---|
| 152 | sysprof-agent, and
|
|---|
| 153 | sysprof-cli
|
|---|
| 154 | </seg>
|
|---|
| 155 | <seg>
|
|---|
| 156 | libsysprof-4.so,
|
|---|
| 157 | libsysprof-capture-4.a, <!-- is required -->
|
|---|
| 158 | libsysprof-memory-4.so,
|
|---|
| 159 | libsysprof-speedtrack-4.so, and
|
|---|
| 160 | libsysprof-ui-5.so
|
|---|
| 161 | </seg>
|
|---|
| 162 | <seg>
|
|---|
| 163 | /usr/include/sysprof-4,
|
|---|
| 164 | /usr/include/sysprof-ui-5, and
|
|---|
| 165 | /usr/share/help/*/sysprof
|
|---|
| 166 | </seg>
|
|---|
| 167 | </seglistitem>
|
|---|
| 168 | </segmentedlist>
|
|---|
| 169 |
|
|---|
| 170 | <variablelist>
|
|---|
| 171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 172 | <?dbfo list-presentation="list"?>
|
|---|
| 173 | <?dbhtml list-presentation="table"?>
|
|---|
| 174 |
|
|---|
| 175 | <varlistentry id="sysprof-prog">
|
|---|
| 176 | <term><command>sysprof</command></term>
|
|---|
| 177 | <listitem>
|
|---|
| 178 | <para>
|
|---|
| 179 | is a graphical interface to sysprof
|
|---|
| 180 | </para>
|
|---|
| 181 | <indexterm zone="sysprof sysprof-prog">
|
|---|
| 182 | <primary sortas="b-sysprof">sysprof</primary>
|
|---|
| 183 | </indexterm>
|
|---|
| 184 | </listitem>
|
|---|
| 185 | </varlistentry>
|
|---|
| 186 |
|
|---|
| 187 | <varlistentry id="sysprof-agent">
|
|---|
| 188 | <term><command>sysprof-agent</command></term>
|
|---|
| 189 | <listitem>
|
|---|
| 190 | <para>
|
|---|
| 191 | is used to profile applications in containers
|
|---|
| 192 | </para>
|
|---|
| 193 | <indexterm zone="sysprof sysprof-agent">
|
|---|
| 194 | <primary sortas="b-sysprof-agent">sysprof-agent</primary>
|
|---|
| 195 | </indexterm>
|
|---|
| 196 | </listitem>
|
|---|
| 197 | </varlistentry>
|
|---|
| 198 |
|
|---|
| 199 | <varlistentry id="sysprof-cli">
|
|---|
| 200 | <term><command>sysprof-cli</command></term>
|
|---|
| 201 | <listitem>
|
|---|
| 202 | <para>
|
|---|
| 203 | is a command line interface to sysprof
|
|---|
| 204 | </para>
|
|---|
| 205 | <indexterm zone="sysprof sysprof-cli">
|
|---|
| 206 | <primary sortas="b-sysprof-cli">sysprof-cli</primary>
|
|---|
| 207 | </indexterm>
|
|---|
| 208 | </listitem>
|
|---|
| 209 | </varlistentry>
|
|---|
| 210 |
|
|---|
| 211 | <varlistentry id="libsysprof-4">
|
|---|
| 212 | <term><filename class="libraryfile">libsysprof-4.so</filename></term>
|
|---|
| 213 | <listitem>
|
|---|
| 214 | <para>
|
|---|
| 215 | provides API functions for profiling processes running on a system
|
|---|
| 216 | </para>
|
|---|
| 217 | <indexterm zone="sysprof libsysprof-4">
|
|---|
| 218 | <primary sortas="c-libsysprof">libsysprof-4.so</primary>
|
|---|
| 219 | </indexterm>
|
|---|
| 220 | </listitem>
|
|---|
| 221 | </varlistentry>
|
|---|
| 222 |
|
|---|
| 223 | <!-- static library is required for capture stats from a process -->
|
|---|
| 224 | <varlistentry id="libsysprof-capture-4">
|
|---|
| 225 | <term><filename class="libraryfile">libsysprof-capture-4.a</filename></term>
|
|---|
| 226 | <listitem>
|
|---|
| 227 | <para>
|
|---|
| 228 | provides a hook used to capture statistics from a process
|
|---|
| 229 | </para>
|
|---|
| 230 | <indexterm zone="sysprof libsysprof-capture-4">
|
|---|
| 231 | <primary sortas="c-libsysprof-capture">libsysprof-capture-4.a</primary>
|
|---|
| 232 | </indexterm>
|
|---|
| 233 | </listitem>
|
|---|
| 234 | </varlistentry>
|
|---|
| 235 |
|
|---|
| 236 | <varlistentry id="libsysprof-memory-4">
|
|---|
| 237 | <term><filename class="libraryfile">libsysprof-memory-4.so</filename></term>
|
|---|
| 238 | <listitem>
|
|---|
| 239 | <para>
|
|---|
| 240 | provides API functions for capturing memory statistics
|
|---|
| 241 | </para>
|
|---|
| 242 | <indexterm zone="sysprof libsysprof-memory-4">
|
|---|
| 243 | <primary sortas="c-libsysprof-memory">libsysprof-memory-4.so</primary>
|
|---|
| 244 | </indexterm>
|
|---|
| 245 | </listitem>
|
|---|
| 246 | </varlistentry>
|
|---|
| 247 |
|
|---|
| 248 | <varlistentry id="libsysprof-speedtrack-4">
|
|---|
| 249 | <term><filename class="libraryfile">libsysprof-speedtrack-4.so</filename></term>
|
|---|
| 250 | <listitem>
|
|---|
| 251 | <para>
|
|---|
| 252 | provides API functions for tracking the speed of a running process
|
|---|
| 253 | </para>
|
|---|
| 254 | <indexterm zone="sysprof libsysprof-speedtrack-4">
|
|---|
| 255 | <primary sortas="c-libsysprof-speedtrack">libsysprof-speedtrack-4.so</primary>
|
|---|
| 256 | </indexterm>
|
|---|
| 257 | </listitem>
|
|---|
| 258 | </varlistentry>
|
|---|
| 259 |
|
|---|
| 260 | <varlistentry id="libsysprof-ui-4">
|
|---|
| 261 | <term><filename class="libraryfile">libsysprof-ui-4.so</filename></term>
|
|---|
| 262 | <listitem>
|
|---|
| 263 | <para>
|
|---|
| 264 | provides API functions for the sysprof GUI
|
|---|
| 265 | </para>
|
|---|
| 266 | <indexterm zone="sysprof libsysprof-ui-4">
|
|---|
| 267 | <primary sortas="c-libsysprof-ui">libsysprof-ui-4.so</primary>
|
|---|
| 268 | </indexterm>
|
|---|
| 269 | </listitem>
|
|---|
| 270 | </varlistentry>
|
|---|
| 271 | </variablelist>
|
|---|
| 272 | </sect2>
|
|---|
| 273 |
|
|---|
| 274 | </sect1>
|
|---|
