1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 |
|
---|
7 | <!ENTITY libbytesize-download-http "https://github.com/storaged-project/libbytesize/releases/download/&libbytesize-version;/libbytesize-&libbytesize-version;.tar.gz">
|
---|
8 | <!ENTITY libbytesize-download-ftp " ">
|
---|
9 | <!ENTITY libbytesize-md5sum "b9a24d3a7b576e67cab729195c26f6e5">
|
---|
10 | <!ENTITY libbytesize-size "452 KB">
|
---|
11 | <!ENTITY libbytesize-buildsize "3.5 MB">
|
---|
12 | <!ENTITY libbytesize-time "less than 0.1 SBU (including tests)">
|
---|
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>
|
---|
29 | The <application>libbytesize</application> package is a library which
|
---|
30 | facilitates the common operations with sizes in bytes.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
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">
|
---|
73 | <xref linkend="pcre2"/> and
|
---|
74 | <xref linkend="pygments"/>
|
---|
75 | </para>
|
---|
76 | <!--
|
---|
77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
78 |
|
---|
79 | <para role="recommended">
|
---|
80 | <xref linkend="six"/>
|
---|
81 | </para>
|
---|
82 | -->
|
---|
83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
84 | <para role="optional">
|
---|
85 | <xref linkend="gtk-doc"/>,
|
---|
86 | <ulink url="https://github.com/rhinstaller/pocketlint/releases">pocketlint</ulink> (python module for one test), and
|
---|
87 | <ulink url="https://pypi.python.org/pypi/polib">polib</ulink> (python module for one test)
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | </sect2>
|
---|
91 |
|
---|
92 | <sect2 role="installation">
|
---|
93 | <title>Installation of libbytesize</title>
|
---|
94 |
|
---|
95 | <para>
|
---|
96 | Install <application>libbytesize</application> by running the following
|
---|
97 | commands:
|
---|
98 | </para>
|
---|
99 |
|
---|
100 | <screen><userinput>./configure --prefix=/usr &&
|
---|
101 | make</userinput></screen>
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | If you have the optional python modules installed, the regression
|
---|
105 | tests can be run with: <command>make check</command>.
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 | <!--
|
---|
116 | <sect2 role="commands">
|
---|
117 | <title>Command Explanations</title>
|
---|
118 |
|
---|
119 | <para>
|
---|
120 | <option>-i -without-python2</option>: If
|
---|
121 | <application>Python 2</application> is installed, use this switch to
|
---|
122 | prevent the use of <application>Python 2</application>. This may be
|
---|
123 | required to run the tests, if some of the needed python modules have been
|
---|
124 | installed for <application>Python 3</application> only.
|
---|
125 | </para>
|
---|
126 | </sect2>
|
---|
127 | -->
|
---|
128 | <sect2 role="content">
|
---|
129 | <title>Contents</title>
|
---|
130 |
|
---|
131 | <segmentedlist>
|
---|
132 | <segtitle>Installed Programs</segtitle>
|
---|
133 | <segtitle>Installed Library</segtitle>
|
---|
134 | <segtitle>Installed Directories</segtitle>
|
---|
135 |
|
---|
136 | <seglistitem>
|
---|
137 | <seg>
|
---|
138 | bscalc
|
---|
139 | </seg>
|
---|
140 | <seg>
|
---|
141 | libbytesize.so
|
---|
142 | </seg>
|
---|
143 | <seg>
|
---|
144 | /usr/include/bytesize and
|
---|
145 | /usr/lib/python&python3-majorver;/site-packages/bytesize
|
---|
146 | </seg>
|
---|
147 | </seglistitem>
|
---|
148 | </segmentedlist>
|
---|
149 |
|
---|
150 | <variablelist>
|
---|
151 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
152 | <?dbfo list-presentation="list"?>
|
---|
153 | <?dbhtml list-presentation="table"?>
|
---|
154 |
|
---|
155 | <varlistentry id="bscalc">
|
---|
156 | <term><command>bscalc</command></term>
|
---|
157 | <listitem>
|
---|
158 | <para>
|
---|
159 | converts from a larger unit, such as MB or TB,
|
---|
160 | back to a value in bytes
|
---|
161 | </para>
|
---|
162 | <indexterm zone="libbytesize bscalc">
|
---|
163 | <primary sortas="b-bscalc">bscalc</primary>
|
---|
164 | </indexterm>
|
---|
165 | </listitem>
|
---|
166 | </varlistentry>
|
---|
167 |
|
---|
168 | <varlistentry id="libbytesize-lib">
|
---|
169 | <term><filename class="libraryfile">libbytesize.so</filename></term>
|
---|
170 | <listitem>
|
---|
171 | <para>
|
---|
172 | contains functions used to handle common read/write operations
|
---|
173 | with sizes in bytes
|
---|
174 | </para>
|
---|
175 | <indexterm zone="libbytesize libbytesize-lib">
|
---|
176 | <primary sortas="c-libbytesize">libbytesize.so</primary>
|
---|
177 | </indexterm>
|
---|
178 | </listitem>
|
---|
179 | </varlistentry>
|
---|
180 |
|
---|
181 | </variablelist>
|
---|
182 |
|
---|
183 | </sect2>
|
---|
184 |
|
---|
185 | </sect1>
|
---|