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 nghttp2-download-http "https://github.com/nghttp2/nghttp2/releases/download/v&nghttp2-version;/nghttp2-&nghttp2-version;.tar.xz">
|
---|
8 | <!ENTITY nghttp2-download-ftp " ">
|
---|
9 | <!ENTITY nghttp2-md5sum "0cf8f819f4b717de7dde9f8164d0b466">
|
---|
10 | <!ENTITY nghttp2-size "1.6 MB">
|
---|
11 | <!ENTITY nghttp2-buildsize "19 MB">
|
---|
12 | <!ENTITY nghttp2-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="nghttp2" xreflabel="nghttp2-&nghttp2-version;">
|
---|
16 | <?dbhtml filename="nghttp2.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>nghttp2-&nghttp2-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="nghttp2">
|
---|
22 | <primary sortas="a-nghttp2">nghttp2</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to nghttp2</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>nghttp2</application> is an implementation of HTTP/2 and
|
---|
30 | its header compression algorithm, HPACK.
|
---|
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="&nghttp2-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&nghttp2-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &nghttp2-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &nghttp2-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &nghttp2-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &nghttp2-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">nghttp2 Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
72 | <para role="required">
|
---|
73 | <xref linkend="libxml2"/>
|
---|
74 | </para>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
77 | <para role="optional">
|
---|
78 | The following are only used if building the full package instead of
|
---|
79 | only the main libraries:
|
---|
80 | <xref linkend="boost"/>, <!--required for the C++ asio library)-->
|
---|
81 | <xref linkend="c-ares"/>, <!-- required to build the HPACK tools -->
|
---|
82 | <xref linkend="cython"/>, <!-- required to python bindings -->
|
---|
83 | <xref linkend="jansson"/>, <!-- required to build the HPACK tools -->
|
---|
84 | <xref linkend="libevent"/>, <!--required to build the examples-->
|
---|
85 | <xref linkend="sphinx"/>, <!--required to build documentation-->
|
---|
86 | <!-- <ulink url="http://www.digip.org/jansson/">Jansson</ulink>, <!- -required
|
---|
87 | to build the HPACK tools-->
|
---|
88 | <ulink url="https://jemalloc.net/">jemalloc</ulink>,
|
---|
89 | <!--required for the example HTTP server-->
|
---|
90 | <ulink url="http://software.schmorp.de/pkg/libev.html">libev</ulink>,
|
---|
91 | <!--required to build the applications-->
|
---|
92 | <ulink url="https://mruby.org/">mruby</ulink>, and
|
---|
93 | <!--provides ruby support in the sample HTTP server-->
|
---|
94 | <ulink url="https://tatsuhiro-t.github.io/spdylay/">Spdylay</ulink>.
|
---|
95 | <!--provide SPDY functionality-->
|
---|
96 | </para>
|
---|
97 | <!--
|
---|
98 | <para role="optional">
|
---|
99 | <ulink url="https://cunit.sourceforge.net/">CUnit</ulink> is required if
|
---|
100 | you wish to run the test suite.
|
---|
101 | </para>
|
---|
102 | -->
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2 role="installation">
|
---|
107 | <title>Installation of nghttp2</title>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | Install <application>nghttp2</application> by running the following
|
---|
111 | commands:
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <screen><userinput>./configure --prefix=/usr \
|
---|
115 | --disable-static \
|
---|
116 | --enable-lib-only \
|
---|
117 | --docdir=/usr/share/doc/nghttp2-&nghttp2-version; &&
|
---|
118 | make</userinput></screen>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | To test the results, issue: <command>make check</command>.
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
129 |
|
---|
130 | </sect2>
|
---|
131 |
|
---|
132 | <sect2 role="commands">
|
---|
133 | <title>Command Explanations</title>
|
---|
134 |
|
---|
135 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
136 | href="../../xincludes/static-libraries.xml"/>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | <parameter>--enable-lib-only</parameter>: only build libnghttp2. Omit
|
---|
140 | this switch if you'd like to build the example applications, Python
|
---|
141 | bindings, or the C++ asio library.
|
---|
142 | </para>
|
---|
143 |
|
---|
144 | </sect2>
|
---|
145 |
|
---|
146 | <sect2 role="content">
|
---|
147 | <title>Contents</title>
|
---|
148 |
|
---|
149 | <segmentedlist>
|
---|
150 | <segtitle>Installed Programs</segtitle>
|
---|
151 | <segtitle>Installed Libraries</segtitle>
|
---|
152 | <segtitle>Installed Directories</segtitle>
|
---|
153 |
|
---|
154 | <seglistitem>
|
---|
155 | <seg>
|
---|
156 | None
|
---|
157 | </seg>
|
---|
158 | <seg>
|
---|
159 | libnghttp2.so
|
---|
160 | </seg>
|
---|
161 | <seg>
|
---|
162 | /usr/include/nghttp2,
|
---|
163 | /usr/share/nghttp2, and
|
---|
164 | /usr/share/doc/nghttp2-&nghttp2-version;
|
---|
165 | </seg>
|
---|
166 | </seglistitem>
|
---|
167 | </segmentedlist>
|
---|
168 |
|
---|
169 | <variablelist>
|
---|
170 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
171 | <?dbfo list-presentation="list"?>
|
---|
172 | <?dbhtml list-presentation="table"?>
|
---|
173 |
|
---|
174 | <varlistentry id="libnghttp2">
|
---|
175 | <term><filename class="libraryfile">libnghttp2.so</filename></term>
|
---|
176 | <listitem>
|
---|
177 | <para>
|
---|
178 | an implementation of the Hypertext Transfer Protocol version 2 in C
|
---|
179 | </para>
|
---|
180 | <indexterm zone="nghttp2 libnghttp2">
|
---|
181 | <primary sortas="c-libnghttp2">libnghttp2.so</primary>
|
---|
182 | </indexterm>
|
---|
183 | </listitem>
|
---|
184 | </varlistentry>
|
---|
185 |
|
---|
186 | </variablelist>
|
---|
187 |
|
---|
188 | </sect2>
|
---|
189 |
|
---|
190 | </sect1>
|
---|