source: general/genlib/libbytesize.xml@ 9bda86e

<?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 libbytesize-download-http "https://github.com/storaged-project/libbytesize/releases/download/&libbytesize-version;/libbytesize-&libbytesize-version;.tar.gz">
  <!ENTITY libbytesize-download-ftp  " ">
  <!ENTITY libbytesize-md5sum        "c3f5b9bfbf67020c8b42225093321e23">
  <!ENTITY libbytesize-size          "435 KB">
  <!ENTITY libbytesize-buildsize     "3.7 MB">
  <!ENTITY libbytesize-time          "less than 0.1 SBU (including tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>libbytesize</application> package is a library which
      facilitates the common operations with sizes in bytes.
    </para>

    &lfs112_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="pcre2"/> and
      <xref linkend="pygments"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="six"/> (needed for tests, python bindings, and running
      <command>bscalc</command>),
      <ulink url="https://github.com/rhinstaller/pocketlint/releases">pocketlint</ulink> (python module for one test), and
      <ulink url="https://pypi.python.org/pypi/polib">polib</ulink> (python module for one test)
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      If you have the optional python modules installed, the regression
      tests can be run with: <command>make check</command>.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>

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

    <para>
      <option>-i -without-python2</option>: If
      <application>Python 2</application> is installed, use this switch to
      prevent the use of <application>Python 2</application>. This may be
      required to run the tests, if some of the needed python modules have been
      installed for <application>Python 3</application> only.
    </para>
  </sect2>
-->
  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          bscalc
        </seg>
        <seg>
          libbytesize.so
        </seg>
        <seg>
          /usr/include/bytesize and
          /usr/lib/python&python3-majorver;/site-packages/bytesize
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="bscalc">
        <term><command>bscalc</command></term>
        <listitem>
          <para>
            converts from a larger unit, such as MB or TB,
            back to a value in bytes
          </para>
          <indexterm zone="libbytesize bscalc">
            <primary sortas="b-bscalc">bscalc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libbytesize-lib">
        <term><filename class="libraryfile">libbytesize.so</filename></term>
        <listitem>
          <para>
            contains functions used to handle common read/write operations
            with sizes in bytes
          </para>
          <indexterm zone="libbytesize libbytesize-lib">
            <primary sortas="c-libbytesize">libbytesize.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>