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