source: server/databases/sqlite.xml

trunk
Last change on this file was 0e8c7f3, checked in by Xi Ruoyao <xry111@…>, 36 hours ago

sqlite: Remove outdated reference to SeaMonkey

Mozilla has deliberately unsupported building their apps with system
sqlite years ago. While I'm not sure if we can drop the CPPFLAGS thing
at all, let's remove the obvious outdated reference from the explanation
first.

Link: https://bugzilla.mozilla.org/show_bug.cgi?id=1611386

  • Property mode set to 100644
File size: 7.1 KB
RevLine 
[ab4fdfc]1<?xml version="1.0" encoding="UTF-8"?>
[e2a0e91]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
[2222949]7<!-- moved to packages.ent because they are often forgotten...
[aa5c3a7]8 <!ENTITY sqlite-dl-version "3360000">
9 <!ENTITY sqlite-doc-version "3360000">
[b00c15b]10
[2222949]11When updating, do not forget the above entities... They are anyway -->
[8cce479c]12
[79a6c29]13 <!ENTITY sqlite-download-http "https://sqlite.org/&sqlite-year;/sqlite-autoconf-&sqlite-dl-version;.tar.gz">
[e2a0e91]14 <!ENTITY sqlite-download-ftp " ">
[c2dab1b0]15 <!ENTITY sqlite-md5sum "f418272ba1d588747dcd4201018ed912">
16 <!ENTITY sqlite-size "3.1 MB">
[8032794]17 <!ENTITY sqlite-buildsize "79 MB">
18 <!ENTITY sqlite-time "0.4 SBU (Using parallelism=4)">
[e5085ae1]19
[79a6c29]20 <!ENTITY sqlite-docs-download "https://sqlite.org/&sqlite-year;/sqlite-doc-&sqlite-doc-version;.zip">
[c2dab1b0]21 <!ENTITY sqlite-docs-md5sum "de799a90c24450196036ad1f497976ad">
22 <!ENTITY sqlite-docs-size "11 MB">
[e2a0e91]23]>
24
25<sect1 id="sqlite" xreflabel="SQLite-&sqlite-version;">
26 <?dbhtml filename="sqlite.html"?>
27
28
29 <title>SQLite-&sqlite-version;</title>
30
31 <indexterm zone="sqlite">
32 <primary sortas="a-SQLite">SQLite</primary>
33 </indexterm>
34
35 <sect2 role="package">
36 <title>Introduction to SQLite</title>
37
[a26f3f8f]38 <para>
39 The <application>SQLite</application> package is a software library that
40 implements a self-contained, serverless, zero-configuration, transactional
41 SQL database engine.
42 </para>
[e2a0e91]43
[133eab2]44 &lfs121_checked;
[49f7d8b]45
[e2a0e91]46 <bridgehead renderas="sect3">Package Information</bridgehead>
47 <itemizedlist spacing="compact">
48 <listitem>
[a26f3f8f]49 <para>
50 Download (HTTP): <ulink url="&sqlite-download-http;"/>
51 </para>
[e2a0e91]52 </listitem>
53 <listitem>
[a26f3f8f]54 <para>
55 Download (FTP): <ulink url="&sqlite-download-ftp;"/>
56 </para>
[e2a0e91]57 </listitem>
58 <listitem>
[a26f3f8f]59 <para>
60 Download MD5 sum: &sqlite-md5sum;
61 </para>
[e2a0e91]62 </listitem>
63 <listitem>
[a26f3f8f]64 <para>
65 Download size: &sqlite-size;
66 </para>
[e2a0e91]67 </listitem>
68 <listitem>
[a26f3f8f]69 <para>
70 Estimated disk space required: &sqlite-buildsize;
71 </para>
[e2a0e91]72 </listitem>
73 <listitem>
[a26f3f8f]74 <para>
75 Estimated build time: &sqlite-time;
76 </para>
[e2a0e91]77 </listitem>
78 </itemizedlist>
79
[10e02da]80 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
81 <itemizedlist spacing="compact">
82 <title>Optional Documentation</title>
83 <listitem>
[a26f3f8f]84 <para>
85 Download (HTTP): <ulink url="&sqlite-docs-download;"/>
86 </para>
[10e02da]87 </listitem>
88 <listitem>
[a26f3f8f]89 <para>
90 Download MD5 sum: &sqlite-docs-md5sum;
91 </para>
[10e02da]92 </listitem>
93 <listitem>
[a26f3f8f]94 <para>
95 Download size: &sqlite-docs-size;
96 </para>
[10e02da]97 </listitem>
98 </itemizedlist>
[e2a0e91]99
[780294af]100 <bridgehead renderas="sect3">SQLite Dependencies</bridgehead>
101
102 <bridgehead renderas="sect4">Optional</bridgehead>
[a26f3f8f]103 <para role="optional">
[90fb8f6]104 <ulink url="https://www.thrysoee.dk/editline/">libedit</ulink> and
[85e109d]105 <xref linkend="unzip"/> (required to unzip the documentation)
[a26f3f8f]106 </para>
[e2a0e91]107
108 </sect2>
109
110 <sect2 role="installation">
111 <title>Installation of SQLite</title>
112
[a26f3f8f]113 <para>
114 If you downloaded the optional documentation, issue the following command
115 to install the documentation into the source tree:
116 </para>
[e5085ae1]117
[5b50432]118<screen><userinput>unzip -q ../sqlite-doc-&sqlite-doc-version;.zip</userinput></screen>
[e5085ae1]119
[a26f3f8f]120 <para>
121 Install <application>SQLite</application> by running the following
122 commands:
123 </para>
[e2a0e91]124
[b596c229]125<screen><userinput>./configure --prefix=/usr \
126 --disable-static \
[2363ba8]127 --enable-fts{4,5} \
128 CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1 \
[179d426d]129 -DSQLITE_ENABLE_UNLOCK_NOTIFY=1 \
130 -DSQLITE_ENABLE_DBSTAT_VTAB=1 \
[577f279]131 -DSQLITE_SECURE_DELETE=1" &amp;&amp;
[41745476]132make</userinput></screen>
[e2a0e91]133
[a26f3f8f]134 <para>
135 This package does not come with a test suite.
136 </para>
[e2a0e91]137
[a26f3f8f]138 <para>
139 Now, as the <systemitem class="username">root</systemitem> user:
140 </para>
[e2a0e91]141
142<screen role="root"><userinput>make install</userinput></screen>
143
[a26f3f8f]144 <para>
145 If you downloaded the optional documentation, issue the following commands
146 as the <systemitem class="username">root</systemitem> user to install it:
147 </para>
[e5085ae1]148
[780294af]149<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/sqlite-&sqlite-version; &amp;&amp;
[5b50432]150cp -v -R sqlite-doc-&sqlite-doc-version;/* /usr/share/doc/sqlite-&sqlite-version;</userinput></screen>
[85e109d]151
[e2a0e91]152 </sect2>
153
[bdf24aa4]154 <sect2 role="commands">
155 <title>Command Explanations</title>
156
[a26f3f8f]157 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
[10a480a]158 href="../../xincludes/static-libraries.xml"/>
[a26f3f8f]159
160 <para>
[ffe5cb0]161 <parameter>--enable-fts{4,5}</parameter>: These switches enable
[2363ba8]162 support for version 3, 4 and 5 of the full text search (FTS)
163 extension. Note that the <option>--enable-fts4</option> switch
164 enables support for both FTS version 4 and FTS version 3.
[f4ac439a]165 </para>
166
167 <para>
[875b3b57]168 <parameter>CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1 ... </parameter>:
[0e8c7f3]169 Some applications require these options to be turned on.
[477e9f51]170 The only way to do this is to include them in
[f622c396]171 the <envar>CFLAGS</envar> or <envar>CPPFLAGS</envar>.
172 We use the latter so the default value (or any value set by the user)
173 of <envar>CFLAGS</envar> won't be affected.
174 For further information on what can be specified see <ulink
[90fb8f6]175 url="https://www.sqlite.org/compile.html"/>.
[a26f3f8f]176 </para>
177
[bdf24aa4]178 </sect2>
179
[e2a0e91]180 <sect2 role="content">
181 <title>Contents</title>
182
183 <segmentedlist>
184 <segtitle>Installed Program</segtitle>
[985d9e0]185 <segtitle>Installed Library</segtitle>
186 <segtitle>Installed Directory</segtitle>
[e2a0e91]187
188 <seglistitem>
[8cce479c]189 <seg>
190 sqlite3
191 </seg>
192 <seg>
[985d9e0]193 libsqlite3.so
[8cce479c]194 </seg>
195 <seg>
196 /usr/share/doc/sqlite-&sqlite-version;
197 </seg>
[e2a0e91]198 </seglistitem>
199 </segmentedlist>
200
201 <variablelist>
202 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
203 <?dbfo list-presentation="list"?>
204 <?dbhtml list-presentation="table"?>
205
206 <varlistentry id="sqlite3">
207 <term><command>sqlite3</command></term>
208 <listitem>
[a26f3f8f]209 <para>
[cceceaaf]210 is a terminal-based front-end to the <application>SQLite</application>
[a26f3f8f]211 library that can evaluate queries interactively and display the
[4c24eb0a]212 results
[a26f3f8f]213 </para>
[e2a0e91]214 <indexterm zone="sqlite sqlite3">
215 <primary sortas="b-sqlite3">sqlite3</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="libsqlite3">
[8cce479c]221 <term><filename class="libraryfile">libsqlite3.so</filename></term>
[e2a0e91]222 <listitem>
[a26f3f8f]223 <para>
[4c24eb0a]224 contains the <application>SQLite</application> API functions
[a26f3f8f]225 </para>
[e2a0e91]226 <indexterm zone="sqlite libsqlite3">
[1f95134]227 <primary sortas="c-libsqlite3">libsqlite3.so</primary>
[e2a0e91]228 </indexterm>
229 </listitem>
230 </varlistentry>
[8cce479c]231
[e2a0e91]232 </variablelist>
[8cce479c]233
[e2a0e91]234 </sect2>
[8cce479c]235
[e2a0e91]236</sect1>
Note: See TracBrowser for help on using the repository browser.