source: general/prog/sysprof.xml@ 320d985

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY sysprof-download-http "&gnome-download-http;/sysprof/&sysprof-minor;/sysprof-&sysprof-version;.tar.xz">
  <!ENTITY sysprof-download-ftp  "&gnome-download-ftp;/sysprof/&sysprof-minor;/sysprof-&sysprof-version;.tar.xz">
  <!ENTITY sysprof-md5sum        "ee1556063c7b8d9abd414f451b04c33a">
  <!ENTITY sysprof-size          "524 KB">
  <!ENTITY sysprof-buildsize     "27 MB">
  <!ENTITY sysprof-time          "0.1 SBU (using parallelism=4)">

]>

<sect1 id="sysprof" xreflabel="sysprof-&sysprof-version;">
  <?dbhtml filename="sysprof.html"?>


  <title>Sysprof-&sysprof-version;</title>

  <indexterm zone="sysprof">
    <primary sortas="a-sysprof">sysprof</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Sysprof</title>

    <para>
      The <application>sysprof</application> package contains a statistical and
      system-wide profiler for Linux.
    </para>

    &lfs113_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&sysprof-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&sysprof-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &sysprof-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &sysprof-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &sysprof-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &sysprof-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Sysprof Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="gtk4"/>,
      <xref linkend="itstool"/>,
      <xref linkend="json-glib"/>,
      <xref linkend="libadwaita1"/>,
      <xref linkend="libdazzle"/>,
      <xref linkend="libunwind"/>, <phrase revision="systemd">and</phrase>
      <xref linkend="polkit"/> <phrase revision="sysv">, and</phrase>
      <phrase revision="sysv"><xref linkend="elogind"/></phrase>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/sysprof"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Sysprof</title>

    <para>
      Install <application>Sysprof</application> by running the following
      commands:
    </para>

<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr         \
            --buildtype=release   \
            -Dsystemdunitdir=/tmp \
            ..                    &amp;&amp;
ninja</userinput></screen>

<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
rm -v /tmp/*.service</userinput></screen>

<screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands" revision="sysv">
    <title>Command Explanations</title>

    <para>
      <command>rm -v /tmp/*.service</command>: This command removes
      systemd units which have no use on SysV systems.
    </para>

    <para>
      <parameter>-Dsystemdunitdir=/tmp</parameter>: This parameter puts systemd
      units in /tmp on SysV systems so that they can be removed. It also bypasses
      a check for systemd <!-- for sd-bus --> in the meson.build file.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          sysprof,
          sysprof-agent, and
          sysprof-cli
        </seg>
        <seg>
          libsysprof-4.so,
          libsysprof-capture-4.a, <!-- is required -->
          libsysprof-memory-4.so,
          libsysprof-speedtrack-4.so, and
          libsysprof-ui-5.so
        </seg>
        <seg>
          /usr/include/sysprof-4,
          /usr/include/sysprof-ui-5, and
          /usr/share/help/*/sysprof
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="sysprof-prog">
        <term><command>sysprof</command></term>
        <listitem>
          <para>
            is a graphical interface to sysprof
          </para>
          <indexterm zone="sysprof sysprof-prog">
            <primary sortas="b-sysprof">sysprof</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sysprof-agent">
        <term><command>sysprof-agent</command></term>
        <listitem>
          <para>
            is used to profile applications in containers
          </para>
          <indexterm zone="sysprof sysprof-agent">
            <primary sortas="b-sysprof-agent">sysprof-agent</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sysprof-cli">
        <term><command>sysprof-cli</command></term>
        <listitem>
          <para>
            is a command line interface to sysprof
          </para>
          <indexterm zone="sysprof sysprof-cli">
            <primary sortas="b-sysprof-cli">sysprof-cli</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsysprof-4">
        <term><filename class="libraryfile">libsysprof-4.so</filename></term>
        <listitem>
          <para>
            provides API functions for profiling processes running on a system
          </para>
          <indexterm zone="sysprof libsysprof-4">
            <primary sortas="c-libsysprof">libsysprof-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!-- static library is required for capture stats from a process -->
      <varlistentry id="libsysprof-capture-4">
        <term><filename class="libraryfile">libsysprof-capture-4.a</filename></term>
        <listitem>
          <para>
            provides a hook used to capture statistics from a process
          </para>
          <indexterm zone="sysprof libsysprof-capture-4">
            <primary sortas="c-libsysprof-capture">libsysprof-capture-4.a</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsysprof-memory-4">
        <term><filename class="libraryfile">libsysprof-memory-4.so</filename></term>
        <listitem>
          <para>
            provides API functions for capturing memory statistics
          </para>
          <indexterm zone="sysprof libsysprof-memory-4">
            <primary sortas="c-libsysprof-memory">libsysprof-memory-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsysprof-speedtrack-4">
        <term><filename class="libraryfile">libsysprof-speedtrack-4.so</filename></term>
        <listitem>
          <para>
            provides API functions for tracking the speed of a running process
          </para>
          <indexterm zone="sysprof libsysprof-speedtrack-4">
            <primary sortas="c-libsysprof-speedtrack">libsysprof-speedtrack-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsysprof-ui-4">
        <term><filename class="libraryfile">libsysprof-ui-4.so</filename></term>
        <listitem>
          <para>
            provides API functions for the sysprof GUI
          </para>
          <indexterm zone="sysprof libsysprof-ui-4">
            <primary sortas="c-libsysprof-ui">libsysprof-ui-4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>