source: general/prog/rust-bindgen.xml@ 0b874205

<?xml version="1.0" encoding="UTF-8"?>
<!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 rust-bindgen-download-http "https://github.com/rust-lang/rust-bindgen/archive/v&rust-bindgen-version;/rust-bindgen-&rust-bindgen-version;.tar.gz">
  <!ENTITY rust-bindgen-md5sum        "c5b7bc02995eb4a2aacecab0b377da4b">
  <!ENTITY rust-bindgen-size          "2.2 MB">
  <!ENTITY rust-bindgen-buildsize     "178 MB">
  <!ENTITY rust-bindgen-time          "0.5 SBU (with parallelism=8)">
]>

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

  <title>rust-bindgen-&rust-bindgen-version;</title>

  <indexterm zone="rust-bindgen">
    <primary sortas="a-rust-bindgen">rust-bindgen</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to rust-bindgen</title>

    <para>
      The <application>rust-bindgen</application> package contains a utility
      that generates Rust bindings from C/C++ headers.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect3">rust-bindgen Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="rust"/> and
      <xref role='runtime' linkend="llvm"/> (with Clang, runtime)
    </para>

    &build-use-internet;

  </sect2>

  <sect2 role="installation">
    <title>Installation of rust-bindgen</title>

    <para>
      Install <application>rust-bindgen</application> by running the following
      commands:
    </para>

<screen><userinput>cargo build --release</userinput></screen>

    <para>
      To test the results, issue: <command>cargo test --release</command>.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>install -v -m755 target/release/bindgen /usr/bin</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          rust-bindgen
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="bindgen">
        <term><command>bindgen</command></term>
        <listitem>
          <para>
            generates bindings for Rust from C/C++ headers
          </para>
          <indexterm zone="rust-bindgen bindgen">
            <primary sortas="b-bindgen">bindgen</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>