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 | <!-- This link does not work presently (as of February 16th, 2014), but the
|
---|
8 | next one may have to be updated soon.
|
---|
9 | <!ENTITY serf-download-http "https://serf.googlecode.com/files/serf-&serf-version;.tar.bz2">-->
|
---|
10 | <!ENTITY serf-download-http "http://serf.googlecode.com/svn/src_releases/serf-&serf-version;.tar.bz2">
|
---|
11 | <!ENTITY serf-download-ftp " ">
|
---|
12 | <!ENTITY serf-md5sum "2e4efe57ff28cb3202a112e90f0c2889">
|
---|
13 | <!ENTITY serf-size "140 KB">
|
---|
14 | <!ENTITY serf-buildsize "2.6 MB (additional 2.2 MB for the tests)">
|
---|
15 | <!ENTITY serf-time "less than 0.1 SBU (additional 0.3 SBU for the tests)">
|
---|
16 | ]>
|
---|
17 |
|
---|
18 | <sect1 id="serf" xreflabel="Serf-&serf-version;">
|
---|
19 | <?dbhtml filename="serf.html"?>
|
---|
20 |
|
---|
21 | <sect1info>
|
---|
22 | <othername>$LastChangedBy$</othername>
|
---|
23 | <date>$Date$</date>
|
---|
24 | </sect1info>
|
---|
25 |
|
---|
26 | <title>Serf-&serf-version;</title>
|
---|
27 |
|
---|
28 | <indexterm zone="serf">
|
---|
29 | <primary sortas="a-Serf">Serf</primary>
|
---|
30 | </indexterm>
|
---|
31 |
|
---|
32 | <sect2 role="package">
|
---|
33 | <title>Introduction to Serf</title>
|
---|
34 |
|
---|
35 | <para>
|
---|
36 | The <application>Serf</application> package contains a C-based HTTP client
|
---|
37 | library built upon the Apache Portable Runtime (APR) library. It
|
---|
38 | multiplexes connections, running the read/write communication asynchronously.
|
---|
39 | Memory copies and transformations are kept to a minimum to provide high
|
---|
40 | performance operation.
|
---|
41 | </para>
|
---|
42 |
|
---|
43 | &lfs78_checked;
|
---|
44 |
|
---|
45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
46 | <itemizedlist spacing="compact">
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (HTTP): <ulink url="&serf-download-http;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download (FTP): <ulink url="&serf-download-ftp;"/>
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download MD5 sum: &serf-md5sum;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Download size: &serf-size;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated disk space required: &serf-buildsize;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | <listitem>
|
---|
73 | <para>
|
---|
74 | Estimated build time: &serf-time;
|
---|
75 | </para>
|
---|
76 | </listitem>
|
---|
77 | </itemizedlist>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect3">Serf Dependencies</bridgehead>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
82 | <para role="required">
|
---|
83 | <xref linkend="apr-util"/>,
|
---|
84 | <xref linkend="openssl"/>, and
|
---|
85 | <xref linkend="scons"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="mitkrb"/>, for the GSSAPI
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <para condition="html" role="usernotes">
|
---|
94 | User Notes: <ulink url="&blfs-wiki;/serf"/>
|
---|
95 | </para>
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 role="installation">
|
---|
99 | <title>Installation of Serf</title>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Install <application>Serf</application> by running the following
|
---|
103 | commands:
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <screen><userinput>sed -i "/Append/s:RPATH=libdir,::" SConstruct &&
|
---|
107 | sed -i "/Default/s:lib_static,::" SConstruct &&
|
---|
108 | sed -i "/Alias/s:install_static,::" SConstruct &&
|
---|
109 | scons PREFIX=/usr</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | If you wish to run the test suite, fix one file:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen><userinput>sed -i test/test_buckets.c \
|
---|
116 | -e 's://\( buf_size = orig_len + (orig_len / 1000) + 12;\):/\*\1\ */:'</userinput></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | To test the results, issue: <command>scons check</command>. With above
|
---|
120 | fix, 1 out of 65 tests still fails for unknown reasons.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
125 | </para>
|
---|
126 |
|
---|
127 | <screen role="root"><userinput>scons PREFIX=/usr install</userinput></screen>
|
---|
128 |
|
---|
129 | </sect2>
|
---|
130 |
|
---|
131 | <sect2 role="commands">
|
---|
132 | <title>Command Explanations</title>
|
---|
133 |
|
---|
134 | <para>
|
---|
135 | <command>sed -i "..."</command>: The first command removes the runtime
|
---|
136 | path from a shared library and the next two commands disable building and
|
---|
137 | installing of the static library.
|
---|
138 | </para>
|
---|
139 |
|
---|
140 | <para>
|
---|
141 | <option>GSSAPI=/usr</option>: Use this switch if you have installed a
|
---|
142 | GSSAPI library and you want <application>serf</application> to use it.
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | </sect2>
|
---|
146 |
|
---|
147 | <sect2 role="content">
|
---|
148 | <title>Contents</title>
|
---|
149 |
|
---|
150 | <segmentedlist>
|
---|
151 | <segtitle>Installed Programs</segtitle>
|
---|
152 | <segtitle>Installed Library</segtitle>
|
---|
153 | <segtitle>Installed Directory</segtitle>
|
---|
154 |
|
---|
155 | <seglistitem>
|
---|
156 | <seg>
|
---|
157 | None
|
---|
158 | </seg>
|
---|
159 | <seg>
|
---|
160 | libserf-1.so
|
---|
161 | </seg>
|
---|
162 | <seg>
|
---|
163 | /usr/include/serf-1
|
---|
164 | </seg>
|
---|
165 | </seglistitem>
|
---|
166 | </segmentedlist>
|
---|
167 |
|
---|
168 | <variablelist>
|
---|
169 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
170 | <?dbfo list-presentation="list"?>
|
---|
171 | <?dbhtml list-presentation="table"?>
|
---|
172 |
|
---|
173 | <varlistentry id="libserf-1">
|
---|
174 | <term><filename class="libraryfile">libserf-1.so</filename></term>
|
---|
175 | <listitem>
|
---|
176 | <para>
|
---|
177 | contains the <application>Serf</application> API functions.
|
---|
178 | </para>
|
---|
179 | <indexterm zone="serf libserf-1">
|
---|
180 | <primary sortas="c-libserf-1">libserf-1.so</primary>
|
---|
181 | </indexterm>
|
---|
182 | </listitem>
|
---|
183 | </varlistentry>
|
---|
184 |
|
---|
185 | </variablelist>
|
---|
186 |
|
---|
187 | </sect2>
|
---|
188 |
|
---|
189 | </sect1>
|
---|