glfs/gnome/applications/gnome-logs.xml

<?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 gnome-logs-download-http
           "&gnome-download-http;/gnome-logs/&gnome-43;/gnome-logs-&gnome-logs-version;.tar.xz">
  <!ENTITY gnome-logs-download-ftp  " ">
  <!ENTITY gnome-logs-md5sum        "fbeada138a28d7ba13a4a95d585ee4c0">
  <!ENTITY gnome-logs-size          "576 KB">
  <!ENTITY gnome-logs-buildsize     "8 MB">
  <!ENTITY gnome-logs-time          "0.1 SBU">
]>

<!-- Unfortunately, after testing this on elogind/SysV, GNOME Logs will ONLY
     use the systemd journal, and will refuse to load logs from /var/log :-( -->
<sect1 id="gnome-logs" xreflabel="gnome-logs-&gnome-logs-version;" revision="systemd">
  <?dbhtml filename="gnome-logs.html"?>


  <title>gnome-logs-&gnome-logs-version;</title>

  <indexterm zone="gnome-logs">
    <primary sortas="a-gnome-logs">gnome-logs</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Logs</title>

    <para>
      The <application>GNOME Logs</application> package contains a log viewer
      for the systemd journal.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">GNOME Logs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk4"/>,
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="itstool"/>, and
      <xref linkend="libadwaita1"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="Optional">
<!--      <xref linkend="appstream-glib"/>, -->
      <xref linkend="desktop-file-utils"/> (for the test suite), and
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/>,
      <xref linkend="libxslt"/> (to build manual pages),
      <ulink url="&appstream-glib-url;">appstream-glib</ulink>, and
      <ulink url="https://pypi.python.org/pypi/dogtail">dogtail</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Logs</title>

    <para>
      Install <application>GNOME Logs</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>
      To test the results, issue: <command>ninja test</command>
    </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>
          gnome-logs
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/gnome-logs and
          /usr/share/help/*/gnome-logs
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-logs-prog">
        <term><command>gnome-logs</command></term>
        <listitem>
          <para>
            is a <application>GNOME</application> log viewer for the
            systemd journal
          </para>
          <indexterm zone="gnome-logs gnome-logs-prog">
            <primary sortas="b-gnome-logs">gnome-logs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>