source: networking/netlibs/nghttp2.xml@ 10af883

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY nghttp2-download-http "https://github.com/nghttp2/nghttp2/releases/download/v&nghttp2-version;/nghttp2-&nghttp2-version;.tar.xz">
  <!ENTITY nghttp2-download-ftp  " ">
  <!ENTITY nghttp2-md5sum        "aa826d44c65e7e1ec25ed314d5a4d5b5">
  <!ENTITY nghttp2-size          "1.5 MB">
  <!ENTITY nghttp2-buildsize     "19 MB">
  <!ENTITY nghttp2-time          "less than 0.1 SBU">
]>

<sect1 id="nghttp2" xreflabel="nghttp2-&nghttp2-version;">
  <?dbhtml filename="nghttp2.html"?>


  <title>nghttp2-&nghttp2-version;</title>

  <indexterm zone="nghttp2">
    <primary sortas="a-nghttp2">nghttp2</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to nghttp2</title>

    <para>
      <application>nghttp2</application> is an implementation of HTTP/2 and
      its header compression algorithm, HPACK.
    </para>

    &lfs113_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&nghttp2-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&nghttp2-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &nghttp2-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &nghttp2-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &nghttp2-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &nghttp2-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">nghttp2 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="required">
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      The following are only used if building the full package instead of
      only the main libraries:
      <xref linkend="boost"/>, <!--required for the C++ asio library)-->
      <xref linkend="c-ares"/>, <!-- required to build the HPACK tools -->
      <xref linkend="cython"/>, <!-- required to python bindings -->
      <xref linkend="jansson"/>, <!-- required to build the HPACK tools -->
      <xref linkend="libevent"/>, <!--required to build the examples-->
      <xref linkend="sphinx"/>, <!--required to build documentation-->
      <!--<xref linkend="python2"/>,--> <!--required for the python bindings)-->
<!--      <ulink url="http://www.digip.org/jansson/">Jansson</ulink>, <!- -required
      to build the HPACK tools-->
      <ulink url="https://jemalloc.net/">jemalloc</ulink>,
      <!--required for the example HTTP server-->
      <ulink url="http://software.schmorp.de/pkg/libev.html">libev</ulink>,
      <!--required to build the applications-->
      <ulink url="https://mruby.org/">mruby</ulink>, and
      <!--provides ruby support in the sample HTTP server-->
      <ulink url="https://tatsuhiro-t.github.io/spdylay/">Spdylay</ulink>.
      <!--provide SPDY functionality-->
    </para>
    <para role="optional">
      <ulink url="https://cunit.sourceforge.net/">CUnit</ulink> is required if
      you wish to run the test suite.
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/nghttp2"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of nghttp2</title>

    <para>
      Install <application>nghttp2</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr     \
            --disable-static  \
            --enable-lib-only \
            --docdir=/usr/share/doc/nghttp2-&nghttp2-version; &amp;&amp;
make</userinput></screen>

    <para>
      The test suite needs CUnit, which is beyond the scope of BLFS.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <parameter>--enable-lib-only</parameter>: only build libnghttp2. Omit
      this switch if you'd like to build the example applications, Python
      bindings, or the C++ asio library.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libnghttp2.so
        </seg>
        <seg>
          /usr/include/nghttp2,
          /usr/share/nghttp2, and
          /usr/share/doc/nghttp2-&nghttp2-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libnghttp2">
        <term><filename class="libraryfile">libnghttp2.so</filename></term>
        <listitem>
          <para>
            an implementation of the Hypertext Transfer Protocol version 2 in C
          </para>
          <indexterm zone="nghttp2 libnghttp2">
            <primary sortas="c-libnghttp2">libnghttp2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>