[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[299d5c54] | 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 |
|
---|
[d5cddad] | 7 | <!ENTITY serf-download-http "https://archive.apache.org/dist/serf/serf-&serf-version;.tar.bz2">
|
---|
[299d5c54] | 8 | <!ENTITY serf-download-ftp " ">
|
---|
[bb0a661] | 9 | <!ENTITY serf-md5sum "5320087299084c297eff8e1dacfab1af">
|
---|
| 10 | <!ENTITY serf-size "148 KB">
|
---|
| 11 | <!ENTITY serf-buildsize "2.4 MB">
|
---|
[30f98dc] | 12 | <!ENTITY serf-time "less than 0.1 SBU">
|
---|
[299d5c54] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="serf" xreflabel="Serf-&serf-version;">
|
---|
| 16 | <?dbhtml filename="serf.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Serf-&serf-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="serf">
|
---|
| 22 | <primary sortas="a-Serf">Serf</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Serf</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>Serf</application> package contains a C-based HTTP client
|
---|
| 30 | library built upon the Apache Portable Runtime (APR) library. It
|
---|
| 31 | multiplexes connections, running the read/write communication asynchronously.
|
---|
| 32 | Memory copies and transformations are kept to a minimum to provide high
|
---|
| 33 | performance operation.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[57791dd] | 36 | &lfs122_checked;
|
---|
[299d5c54] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&serf-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&serf-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &serf-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &serf-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &serf-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &serf-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
[bb0a661] | 71 | <!--
|
---|
[3d50d36] | 72 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 73 | <itemizedlist spacing="compact">
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>
|
---|
| 76 | Required patch:
|
---|
| 77 | <ulink url="&patch-root;/serf-&serf-version;-openssl3_fixes-1.patch"/>
|
---|
| 78 | </para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </itemizedlist>
|
---|
[bb0a661] | 81 | -->
|
---|
[299d5c54] | 82 | <bridgehead renderas="sect3">Serf Dependencies</bridgehead>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 85 | <para role="required">
|
---|
[94b42903] | 86 | <xref linkend="apr-util"/> and
|
---|
[1b35ce63] | 87 | <xref linkend="scons"/>
|
---|
[299d5c54] | 88 | </para>
|
---|
| 89 |
|
---|
[d0b65e4] | 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 91 | <para role="optional">
|
---|
[7daa99e] | 92 | <xref linkend="mitkrb"/> (for GSSAPI support)
|
---|
[d0b65e4] | 93 | </para>
|
---|
| 94 |
|
---|
[299d5c54] | 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of Serf</title>
|
---|
[bb0a661] | 99 | <!--
|
---|
[3d50d36] | 100 | <para>
|
---|
| 101 | First, fix an issue that causes compilation issues in other packages
|
---|
| 102 | when using OpenSSL-3:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <screen><userinput remap="pre">patch -Np1 -i ../serf-&serf-version;-openssl3_fixes-1.patch</userinput></screen>
|
---|
[bb0a661] | 106 | -->
|
---|
[299d5c54] | 107 | <para>
|
---|
| 108 | Install <application>Serf</application> by running the following
|
---|
| 109 | commands:
|
---|
| 110 | </para>
|
---|
| 111 |
|
---|
[fabeff7] | 112 | <screen><userinput>sed -i "/Append/s:RPATH=libdir,::" SConstruct &&
|
---|
| 113 | sed -i "/Default/s:lib_static,::" SConstruct &&
|
---|
| 114 | sed -i "/Alias/s:install_static,::" SConstruct &&
|
---|
| 115 |
|
---|
[46491e5] | 116 | scons PREFIX=/usr</userinput></screen>
|
---|
[bb0a661] | 117 | <!--
|
---|
| 118 | sed -i "/ print/{s/print/print(/; s/$/)/}" SConstruct &&
|
---|
| 119 | sed -i "/get_contents()/s/,/.decode()&/" SConstruct &&
|
---|
| 120 | -->
|
---|
[299d5c54] | 121 |
|
---|
[ba8f1a8] | 122 | <!-- I did not find this to be needed as of 1.3.9 -renodr
|
---|
[299d5c54] | 123 | <para>
|
---|
[7f08245] | 124 | If you wish to run the test suite, fix one file:
|
---|
| 125 | </para>
|
---|
| 126 |
|
---|
| 127 | <screen><userinput>sed -i test/test_buckets.c \
|
---|
| 128 | -e 's://\( buf_size = orig_len + (orig_len / 1000) + 12;\):/\*\1\ */:'</userinput></screen>
|
---|
[ba8f1a8] | 129 | -->
|
---|
[7f08245] | 130 |
|
---|
[440647ab] | 131 | <!-- With Python 3, check.py is broken. It could be fixed, but since the
|
---|
[48771ae] | 132 | test suite hangs anyway...
|
---|
[7f08245] | 133 | <para>
|
---|
[45f8102] | 134 | To test the results, issue: <command>scons check</command>.
|
---|
| 135 | The tests currently will cause a hang.
|
---|
[440647ab] | 136 | </para>
|
---|
| 137 | -->
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
[48771ae] | 140 | This package does not come with a functional test suite.
|
---|
[299d5c54] | 141 | </para>
|
---|
| 142 |
|
---|
| 143 | <para>
|
---|
| 144 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
[b26bc4c] | 147 | <screen role="root"><userinput>scons PREFIX=/usr install</userinput></screen>
|
---|
[1b35ce63] | 148 |
|
---|
[299d5c54] | 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2 role="commands">
|
---|
| 152 | <title>Command Explanations</title>
|
---|
| 153 |
|
---|
[1b35ce63] | 154 | <para>
|
---|
[5bff14ac] | 155 | <command>sed -i "..."</command>: The first command removes the runtime
|
---|
[9c93f095] | 156 | path from a shared library and the next two commands disable building and
|
---|
[bb0a661] | 157 | installing of the static library. <!--The fourth command corrects for
|
---|
[440647ab] | 158 | changes in scons-3.x. The last command allows to use <application>
|
---|
[bb0a661] | 159 | Python 3</application>.-->
|
---|
[f3429309] | 160 | </para>
|
---|
[299d5c54] | 161 |
|
---|
[d0b65e4] | 162 | <para>
|
---|
| 163 | <option>GSSAPI=/usr</option>: Use this switch if you have installed a
|
---|
| 164 | GSSAPI library and you want <application>serf</application> to use it.
|
---|
| 165 | </para>
|
---|
| 166 |
|
---|
[299d5c54] | 167 | </sect2>
|
---|
| 168 |
|
---|
| 169 | <sect2 role="content">
|
---|
| 170 | <title>Contents</title>
|
---|
| 171 |
|
---|
| 172 | <segmentedlist>
|
---|
| 173 | <segtitle>Installed Programs</segtitle>
|
---|
| 174 | <segtitle>Installed Library</segtitle>
|
---|
| 175 | <segtitle>Installed Directory</segtitle>
|
---|
| 176 |
|
---|
| 177 | <seglistitem>
|
---|
| 178 | <seg>
|
---|
| 179 | None
|
---|
| 180 | </seg>
|
---|
| 181 | <seg>
|
---|
| 182 | libserf-1.so
|
---|
| 183 | </seg>
|
---|
| 184 | <seg>
|
---|
| 185 | /usr/include/serf-1
|
---|
| 186 | </seg>
|
---|
| 187 | </seglistitem>
|
---|
| 188 | </segmentedlist>
|
---|
| 189 |
|
---|
| 190 | <variablelist>
|
---|
| 191 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 192 | <?dbfo list-presentation="list"?>
|
---|
| 193 | <?dbhtml list-presentation="table"?>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="libserf-1">
|
---|
| 196 | <term><filename class="libraryfile">libserf-1.so</filename></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
[4c24eb0a] | 199 | contains the <application>Serf</application> API functions
|
---|
[299d5c54] | 200 | </para>
|
---|
| 201 | <indexterm zone="serf libserf-1">
|
---|
| 202 | <primary sortas="c-libserf-1">libserf-1.so</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | </variablelist>
|
---|
| 208 |
|
---|
| 209 | </sect2>
|
---|
| 210 |
|
---|
| 211 | </sect1>
|
---|