[dc59947] | 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 rust-bindgen-download-http "https://github.com/rust-lang/rust-bindgen/archive/v&rust-bindgen-version;/rust-bindgen-&rust-bindgen-version;.tar.gz">
|
---|
[eabcf31a] | 8 | <!ENTITY rust-bindgen-md5sum "05dfba889299f3b666c43bbd1256af9f">
|
---|
| 9 | <!ENTITY rust-bindgen-size "2.3 MB">
|
---|
[dc59947] | 10 | <!ENTITY rust-bindgen-buildsize "178 MB">
|
---|
| 11 | <!ENTITY rust-bindgen-time "0.5 SBU (with parallelism=8)">
|
---|
| 12 | ]>
|
---|
| 13 |
|
---|
| 14 | <sect1 id="rust-bindgen" xreflabel="rust-bindgen-&rust-bindgen-version;">
|
---|
| 15 | <?dbhtml filename="rust-bindgen.html"?>
|
---|
| 16 |
|
---|
| 17 | <title>rust-bindgen-&rust-bindgen-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="rust-bindgen">
|
---|
| 20 | <primary sortas="a-rust-bindgen">rust-bindgen</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title>Introduction to rust-bindgen</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>rust-bindgen</application> package contains a utility
|
---|
| 28 | that generates Rust bindings from C/C++ headers.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
[d4dc5bae] | 31 | &lfs122_checked;
|
---|
[dc59947] | 32 |
|
---|
| 33 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&rust-bindgen-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download MD5 sum: &rust-bindgen-md5sum;
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download size: &rust-bindgen-size;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Estimated disk space required: &rust-bindgen-buildsize;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated build time: &rust-bindgen-time;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
| 61 |
|
---|
| 62 | <bridgehead renderas="sect3">rust-bindgen Dependencies</bridgehead>
|
---|
| 63 |
|
---|
| 64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 65 | <para role="required">
|
---|
[cd7b1ee] | 66 | <xref linkend="rust"/> and
|
---|
| 67 | <xref role='runtime' linkend="llvm"/> (with Clang, runtime)
|
---|
[dc59947] | 68 | </para>
|
---|
| 69 |
|
---|
[0b874205] | 70 | &build-use-internet;
|
---|
| 71 |
|
---|
[dc59947] | 72 | </sect2>
|
---|
| 73 |
|
---|
| 74 | <sect2 role="installation">
|
---|
| 75 | <title>Installation of rust-bindgen</title>
|
---|
| 76 |
|
---|
| 77 | <para>
|
---|
| 78 | Install <application>rust-bindgen</application> by running the following
|
---|
| 79 | commands:
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <screen><userinput>cargo build --release</userinput></screen>
|
---|
| 83 |
|
---|
| 84 | <para>
|
---|
| 85 | To test the results, issue: <command>cargo test --release</command>.
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
| 88 | <para>
|
---|
| 89 | Now, as the &root; user:
|
---|
| 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <screen role="root"><userinput>install -v -m755 target/release/bindgen /usr/bin</userinput></screen>
|
---|
| 93 |
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="content">
|
---|
| 97 | <title>Contents</title>
|
---|
| 98 |
|
---|
| 99 | <segmentedlist>
|
---|
| 100 | <segtitle>Installed Programs</segtitle>
|
---|
| 101 | <segtitle>Installed Libraries</segtitle>
|
---|
| 102 | <segtitle>Installed Directories</segtitle>
|
---|
| 103 |
|
---|
| 104 | <seglistitem>
|
---|
| 105 | <seg>
|
---|
[8a1fba7] | 106 | bindgen
|
---|
[dc59947] | 107 | </seg>
|
---|
| 108 | <seg>
|
---|
| 109 | None
|
---|
| 110 | </seg>
|
---|
| 111 | <seg>
|
---|
| 112 | None
|
---|
| 113 | </seg>
|
---|
| 114 | </seglistitem>
|
---|
| 115 | </segmentedlist>
|
---|
| 116 |
|
---|
| 117 | <variablelist>
|
---|
| 118 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 119 | <?dbfo list-presentation="list"?>
|
---|
| 120 | <?dbhtml list-presentation="table"?>
|
---|
| 121 |
|
---|
| 122 | <varlistentry id="bindgen">
|
---|
| 123 | <term><command>bindgen</command></term>
|
---|
| 124 | <listitem>
|
---|
| 125 | <para>
|
---|
| 126 | generates bindings for Rust from C/C++ headers
|
---|
| 127 | </para>
|
---|
| 128 | <indexterm zone="rust-bindgen bindgen">
|
---|
| 129 | <primary sortas="b-bindgen">bindgen</primary>
|
---|
| 130 | </indexterm>
|
---|
| 131 | </listitem>
|
---|
| 132 | </varlistentry>
|
---|
| 133 | </variablelist>
|
---|
| 134 | </sect2>
|
---|
| 135 | </sect1>
|
---|