[092e7fb] | 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 |
|
---|
| 7 | <!ENTITY grantlee-download-http
|
---|
| 8 | "http://downloads.grantlee.org/grantlee-&grantlee-version;.tar.gz">
|
---|
| 9 | <!ENTITY grantlee-download-ftp " ">
|
---|
[0515763] | 10 | <!ENTITY grantlee-md5sum "6239b3703674f88b2236d30d0ed67eea">
|
---|
[092e7fb] | 11 | <!ENTITY grantlee-size "1.1 MB">
|
---|
[0515763] | 12 | <!ENTITY grantlee-buildsize "22 MB">
|
---|
| 13 | <!ENTITY grantlee-time "0.6 SBU (Using parallelism=4)">
|
---|
[092e7fb] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="grantlee" xreflabel="grantlee-&grantlee-version;">
|
---|
| 17 | <?dbhtml filename="grantlee.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
[d027410] | 20 | <date>$Date$</date>
|
---|
[092e7fb] | 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Grantlee-&grantlee-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="grantlee">
|
---|
| 26 | <primary sortas="a-grantlee">grantlee</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to grantlee</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
[7c98ee5] | 33 | Grantlee is a set of free software libraries written using the Qt
|
---|
| 34 | framework. Currently two libraries are shipped with Grantlee: Grantlee
|
---|
| 35 | Templates and Grantlee TextDocument. The goal of Grantlee Templates is
|
---|
[092e7fb] | 36 | to make it easier for application developers to separate the structure
|
---|
| 37 | of documents from the data they contain, opening the door for theming.
|
---|
| 38 | </para>
|
---|
| 39 |
|
---|
[38030654] | 40 | &lfs111_checked;
|
---|
[092e7fb] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
[d56e7df] | 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&grantlee-download-http;"/>
|
---|
| 47 | </para>
|
---|
[092e7fb] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[d56e7df] | 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&grantlee-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
[092e7fb] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[d56e7df] | 55 | <para>
|
---|
| 56 | Download MD5 sum: &grantlee-md5sum;
|
---|
| 57 | </para>
|
---|
[092e7fb] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[d56e7df] | 60 | <para>
|
---|
| 61 | Download size: &grantlee-size;
|
---|
| 62 | </para>
|
---|
[092e7fb] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[d56e7df] | 65 | <para>
|
---|
| 66 | Estimated disk space required: &grantlee-buildsize;
|
---|
| 67 | </para>
|
---|
[092e7fb] | 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
[d56e7df] | 70 | <para>
|
---|
| 71 | Estimated build time: &grantlee-time;
|
---|
| 72 | </para>
|
---|
[092e7fb] | 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">Grantlee Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
[ed74a9a] | 80 | <xref linkend="cmake"/> and <xref linkend="qt5"/>
|
---|
[092e7fb] | 81 | </para>
|
---|
| 82 |
|
---|
[9c0463d] | 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
| 85 | <xref linkend="doxygen"/> (for documentation)
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
[092e7fb] | 88 | <para condition="html" role="usernotes">User Notes:
|
---|
| 89 | <ulink url="&blfs-wiki;/grantlee"/></para>
|
---|
| 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2 role="installation">
|
---|
| 94 | <title>Installation of Grantlee</title>
|
---|
| 95 |
|
---|
[d56e7df] | 96 | <para>
|
---|
| 97 | Install <application>Grantlee</application> by
|
---|
| 98 | running the following commands:
|
---|
| 99 | </para>
|
---|
[092e7fb] | 100 |
|
---|
| 101 | <screen><userinput>mkdir build &&
|
---|
[b6d3d395] | 102 | cd build &&
|
---|
| 103 |
|
---|
| 104 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
[00e29190] | 105 | -DCMAKE_BUILD_TYPE=Release \
|
---|
[7c98ee5] | 106 | .. &&
|
---|
| 107 | make</userinput></screen>
|
---|
[092e7fb] | 108 |
|
---|
| 109 | <para>
|
---|
| 110 | This package does not come with a test suite.
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
[d56e7df] | 113 | <para>
|
---|
| 114 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 115 | </para>
|
---|
[092e7fb] | 116 |
|
---|
| 117 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 118 |
|
---|
| 119 | </sect2>
|
---|
| 120 |
|
---|
| 121 | <sect2 role="content">
|
---|
| 122 | <title>Contents</title>
|
---|
| 123 |
|
---|
| 124 | <segmentedlist>
|
---|
| 125 | <segtitle>Installed Programs</segtitle>
|
---|
| 126 | <segtitle>Installed Libraries</segtitle>
|
---|
| 127 | <segtitle>Installed Directories</segtitle>
|
---|
| 128 |
|
---|
| 129 | <seglistitem>
|
---|
| 130 | <seg>none</seg>
|
---|
| 131 | <seg>
|
---|
[9c0463d] | 132 | libGrantlee_Templates.so and
|
---|
| 133 | libGrantlee_TextDocument.so
|
---|
[092e7fb] | 134 | </seg>
|
---|
| 135 | <seg>
|
---|
[9c0463d] | 136 | /usr/lib/cmake/Grantlee5,
|
---|
| 137 | /usr/lib/grantlee/5.2, and
|
---|
| 138 | /usr/include/grantlee</seg>
|
---|
[092e7fb] | 139 | </seglistitem>
|
---|
| 140 | </segmentedlist>
|
---|
[9c0463d] | 141 |
|
---|
| 142 | <variablelist>
|
---|
| 143 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 144 | <?dbfo list-presentation="list"?>
|
---|
| 145 | <?dbhtml list-presentation="table"?>
|
---|
| 146 |
|
---|
| 147 | <varlistentry id="libGrantlee_Templates">
|
---|
| 148 | <term><filename class="libraryfile">libGrantlee_Templates.so</filename></term>
|
---|
| 149 | <listitem>
|
---|
| 150 | <para>
|
---|
| 151 | contains common documentation templates for separating documents
|
---|
| 152 | from their structure
|
---|
| 153 | </para>
|
---|
| 154 | <indexterm zone="grantlee libGrantlee_Templates">
|
---|
| 155 | <primary sortas="c-libGrantlee_Templates">libGrantlee_Templates.so</primary>
|
---|
| 156 | </indexterm>
|
---|
| 157 | </listitem>
|
---|
| 158 | </varlistentry>
|
---|
| 159 |
|
---|
| 160 | <varlistentry id="libGrantlee_TextDocument">
|
---|
| 161 | <term><filename class="libraryfile">libGrantlee_TextDocument.so</filename></term>
|
---|
| 162 | <listitem>
|
---|
| 163 | <para>
|
---|
| 164 | contains functions that allow separating the content of text
|
---|
| 165 | documents from their structure.
|
---|
| 166 | </para>
|
---|
| 167 | <indexterm zone="grantlee libGrantlee_TextDocument">
|
---|
| 168 | <primary sortas="c-libGrantlee_TextDocument">libGrantlee_TextDocument.so</primary>
|
---|
| 169 | </indexterm>
|
---|
| 170 | </listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 | </variablelist>
|
---|
| 173 |
|
---|
[092e7fb] | 174 | </sect2>
|
---|
| 175 |
|
---|
| 176 | </sect1>
|
---|