source: x/lib/libadwaita.xml@ 8a09beb

<?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 libadwaita-download-http "&gnome-download-http;/libadwaita/&libadwaita-minor;/libadwaita-&libadwaita-version;.tar.xz">
  <!ENTITY libadwaita-download-ftp  " ">
  <!ENTITY libadwaita-md5sum        "c2fc600025914eb8c5304b52f376197d">
  <!ENTITY libadwaita-size          "3.9 MB">
  <!ENTITY libadwaita-buildsize     "53 MB (with tests)">
  <!ENTITY libadwaita-time          "0.3 SBU (with parallelism=4; with tests)">
]>

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


  <title>libadwaita-&libadwaita-version;</title>

  <indexterm zone="libadwaita1">
    <primary sortas="a-libadwaita">libadwaita</primary>
  </indexterm>

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

    <para>
      The <application>libadwaita</application> package provides additional
      GTK4 UI widgets for use in developing user interfaces. It is used
      primarily for GNOME applications.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="appstream"/> and
      <xref linkend="gtk4"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/>
    </para>

  </sect2>

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

 <!-- Fixed in 1.4.2
    <para>
      Adapt some AppStream API usage for AppStream-1.0.0 or later:
    </para>

<screen><userinput>sed -e "/releases =/s/=.*/ =                             \
        as_release_list_get_entries                      \
        (as_component_get_releases_plain (component));/" \
    -e "/ developer_name =/s/=.*/ =                      \
        as_developer_get_name                            \
        (as_component_get_developer (component));/"      \
    -i src/adw-about-window.c</userinput></screen>
-->

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

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

    <para>
      If you have <xref linkend='gi-docgen'/> installed and wish to build
      the API documentation for this package, issue:
    </para>

<screen role='nodump'><userinput>sed "s/apiversion/'&libadwaita-version;'/" -i ../doc/meson.build &amp;&amp;
meson configure -Dgtk_doc=true                    &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
      The tests must be run from a graphical session.  One test named
      <quote>Validate appstream file</quote> is known to fail because the
      test input contains constructs deprecated by AppStream-1.0.0 or
      later.
    </para>

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

<screen role="root"><userinput>ninja install</userinput></screen>
  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          adwaita-1-demo
        </seg>
        <seg>
          libadwaita-1.so
        </seg>
        <seg>
          /usr/include/libadwaita-1
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="adwaita-1-demo">
        <term><command>adwaita-1-demo</command></term>
        <listitem>
          <para>
            provides an example of how to use the
            <application>libadwaita</application> library
          </para>
          <indexterm zone="libadwaita1 adwaita-1-demo">
            <primary sortas="b-adwaita-1-demo">adwaita-1-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libadwaita-1">
        <term><filename class="libraryfile">libadwaita-1.so</filename></term>
        <listitem>
          <para>
            provides additional GTK widgets for use in creating user interfaces
          </para>
          <indexterm zone="libadwaita1 libadwaita-1">
            <primary sortas="c-libadwaita-1">libadwaita-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>