[6dcb9e77] | 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 |
|
---|
[eea6737] | 7 | <!ENTITY libbytesize-download-http "https://github.com/storaged-project/libbytesize/releases/download/&libbytesize-version;/libbytesize-&libbytesize-version;.tar.gz">
|
---|
[6dcb9e77] | 8 | <!ENTITY libbytesize-download-ftp " ">
|
---|
[1ba06ad9] | 9 | <!ENTITY libbytesize-md5sum "c3f5b9bfbf67020c8b42225093321e23">
|
---|
| 10 | <!ENTITY libbytesize-size "435 KB">
|
---|
| 11 | <!ENTITY libbytesize-buildsize "3.7 MB">
|
---|
[079d52ac] | 12 | <!ENTITY libbytesize-time "less than 0.1 SBU (including tests)">
|
---|
[6dcb9e77] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libbytesize" xreflabel="libbytesize-&libbytesize-version;">
|
---|
| 16 | <?dbhtml filename="libbytesize.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>libbytesize-&libbytesize-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="libbytesize">
|
---|
| 25 | <primary sortas="a-libbytesize">libbytesize</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to libbytesize</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
[477d66d] | 32 | The <application>libbytesize</application> package is a library which
|
---|
[6dcb9e77] | 33 | facilitates the common operations with sizes in bytes.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[0ddf4e7] | 36 | &lfs112_checked;
|
---|
[6dcb9e77] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&libbytesize-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&libbytesize-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &libbytesize-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &libbytesize-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &libbytesize-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &libbytesize-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">libbytesize Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
[f948b30] | 76 | <xref linkend="pcre2"/> and
|
---|
| 77 | <xref linkend="pygments"/>
|
---|
[6dcb9e77] | 78 | </para>
|
---|
| 79 |
|
---|
[10be56f] | 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[b2baae0] | 81 |
|
---|
| 82 | <para role="recommended">
|
---|
| 83 | <xref linkend="six"/>
|
---|
| 84 | </para>
|
---|
| 85 |
|
---|
[6dcb9e77] | 86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 87 | <para role="optional">
|
---|
| 88 | <xref linkend="gtk-doc"/>,
|
---|
[b2baae0] | 89 | <!--<xref linkend="six"/> (needed for tests, python bindings, and running
|
---|
| 90 | <command>bscalc</command>),-->
|
---|
[8558044] | 91 | <ulink url="https://github.com/rhinstaller/pocketlint/releases">pocketlint</ulink> (python module for one test), and
|
---|
[c6afa0d] | 92 | <ulink url="https://pypi.python.org/pypi/polib">polib</ulink> (python module for one test)
|
---|
[6dcb9e77] | 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <para condition="html" role="usernotes">User Notes:
|
---|
| 96 | <ulink url="&blfs-wiki;/libbytesize"/>
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
| 99 | </sect2>
|
---|
| 100 |
|
---|
| 101 | <sect2 role="installation">
|
---|
| 102 | <title>Installation of libbytesize</title>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | Install <application>libbytesize</application> by running the following
|
---|
| 106 | commands:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[ce794256] | 109 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[6dcb9e77] | 110 | make</userinput></screen>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
[8558044] | 113 | If you have the optional python modules installed, the regression
|
---|
| 114 | tests can be run with: <command>make check</command>.
|
---|
[6dcb9e77] | 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 122 |
|
---|
| 123 | </sect2>
|
---|
[8558044] | 124 | <!--
|
---|
[0dc5ab2e] | 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
[568e425] | 129 | <option>-i -without-python2</option>: If
|
---|
[d0331db] | 130 | <application>Python 2</application> is installed, use this switch to
|
---|
| 131 | prevent the use of <application>Python 2</application>. This may be
|
---|
| 132 | required to run the tests, if some of the needed python modules have been
|
---|
| 133 | installed for <application>Python 3</application> only.
|
---|
[0dc5ab2e] | 134 | </para>
|
---|
| 135 | </sect2>
|
---|
[568e425] | 136 | -->
|
---|
[6dcb9e77] | 137 | <sect2 role="content">
|
---|
| 138 | <title>Contents</title>
|
---|
| 139 |
|
---|
| 140 | <segmentedlist>
|
---|
| 141 | <segtitle>Installed Programs</segtitle>
|
---|
| 142 | <segtitle>Installed Library</segtitle>
|
---|
| 143 | <segtitle>Installed Directories</segtitle>
|
---|
| 144 |
|
---|
| 145 | <seglistitem>
|
---|
| 146 | <seg>
|
---|
[05e57e19] | 147 | bscalc
|
---|
[6dcb9e77] | 148 | </seg>
|
---|
| 149 | <seg>
|
---|
| 150 | libbytesize.so
|
---|
| 151 | </seg>
|
---|
| 152 | <seg>
|
---|
[1ba06ad9] | 153 | /usr/include/bytesize and
|
---|
[336d81c3] | 154 | /usr/lib/python&python3-majorver;/site-packages/bytesize
|
---|
[6dcb9e77] | 155 | </seg>
|
---|
| 156 | </seglistitem>
|
---|
| 157 | </segmentedlist>
|
---|
[477d66d] | 158 |
|
---|
[6dcb9e77] | 159 | <variablelist>
|
---|
| 160 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 161 | <?dbfo list-presentation="list"?>
|
---|
| 162 | <?dbhtml list-presentation="table"?>
|
---|
| 163 |
|
---|
[477d66d] | 164 | <varlistentry id="bscalc">
|
---|
| 165 | <term><command>bscalc</command></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>
|
---|
| 168 | converts from a larger unit, such as MB or TB,
|
---|
[4c24eb0a] | 169 | back to a value in bytes
|
---|
[477d66d] | 170 | </para>
|
---|
| 171 | <indexterm zone="libbytesize bscalc">
|
---|
| 172 | <primary sortas="b-bscalc">bscalc</primary>
|
---|
| 173 | </indexterm>
|
---|
| 174 | </listitem>
|
---|
| 175 | </varlistentry>
|
---|
| 176 |
|
---|
[6dcb9e77] | 177 | <varlistentry id="libbytesize-lib">
|
---|
[4c24eb0a] | 178 | <term><filename class="libraryfile">libbytesize.so</filename></term>
|
---|
[6dcb9e77] | 179 | <listitem>
|
---|
| 180 | <para>
|
---|
[477d66d] | 181 | contains functions used to handle common read/write operations
|
---|
[4c24eb0a] | 182 | with sizes in bytes
|
---|
[6dcb9e77] | 183 | </para>
|
---|
| 184 | <indexterm zone="libbytesize libbytesize-lib">
|
---|
| 185 | <primary sortas="c-libbytesize">libbytesize.so</primary>
|
---|
| 186 | </indexterm>
|
---|
| 187 | </listitem>
|
---|
| 188 | </varlistentry>
|
---|
| 189 |
|
---|
| 190 | </variablelist>
|
---|
[477d66d] | 191 |
|
---|
[6dcb9e77] | 192 | </sect2>
|
---|
| 193 |
|
---|
| 194 | </sect1>
|
---|