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 libnvme-download-http "https://github.com/linux-nvme/libnvme/archive/v&libnvme-version;/libnvme-&libnvme-version;.tar.gz">
|
---|
8 | <!ENTITY libnvme-download-ftp " ">
|
---|
9 | <!ENTITY libnvme-md5sum "0d43167362a119f8a621607b7ee20c51">
|
---|
10 | <!ENTITY libnvme-size "704 KB">
|
---|
11 | <!ENTITY libnvme-buildsize "21 MB">
|
---|
12 | <!ENTITY libnvme-time "less than 0.1 SBU (including tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libnvme" xreflabel="libnvme-&libnvme-version;">
|
---|
16 | <?dbhtml filename="libnvme.html"?>
|
---|
17 |
|
---|
18 | <title>libnvme-&libnvme-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="libnvme">
|
---|
21 | <primary sortas="a-libnvme">libnvme</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to libnvme</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | The <application>libnvme</application> package is a library which
|
---|
29 | provides type definitions for NVMe specification structures,
|
---|
30 | enumerations, and bit fields, helper functions to construct, dispatch,
|
---|
31 | and decode commands and payloads, and utilities to connect, scan, and
|
---|
32 | manage NVMe devices on a Linux system.
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | &lfs122_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>
|
---|
41 | Download (HTTP): <ulink url="&libnvme-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&libnvme-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &libnvme-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &libnvme-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &libnvme-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &libnvme-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">libnvme Dependencies</bridgehead>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
74 | <para role="optional">
|
---|
75 | <phrase revision="sysv"><xref linkend="dbus"/>,</phrase>
|
---|
76 | <xref linkend="json-c"/>,
|
---|
77 | <xref linkend="keyutils"/>, and
|
---|
78 | <xref linkend="swig"/>
|
---|
79 | </para>
|
---|
80 |
|
---|
81 |
|
---|
82 | </sect2>
|
---|
83 |
|
---|
84 | <sect2 role="installation">
|
---|
85 | <title>Installation of libnvme</title>
|
---|
86 |
|
---|
87 | <para>
|
---|
88 | Install <application>libnvme</application> by running the following
|
---|
89 | commands:
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <screen><userinput>mkdir build &&
|
---|
93 | cd build &&
|
---|
94 |
|
---|
95 | meson setup --prefix=/usr --buildtype=release -D libdbus=auto .. &&
|
---|
96 | ninja</userinput></screen>
|
---|
97 |
|
---|
98 | <para>
|
---|
99 | To run the tests, issue: <command>ninja test</command>.
|
---|
100 | </para>
|
---|
101 |
|
---|
102 | <para>
|
---|
103 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
107 |
|
---|
108 | </sect2>
|
---|
109 |
|
---|
110 | <sect2 role="content">
|
---|
111 | <title>Contents</title>
|
---|
112 |
|
---|
113 | <segmentedlist>
|
---|
114 | <segtitle>Installed Programs</segtitle>
|
---|
115 | <segtitle>Installed Library</segtitle>
|
---|
116 | <segtitle>Installed Directories</segtitle>
|
---|
117 |
|
---|
118 | <seglistitem>
|
---|
119 | <seg>
|
---|
120 | None
|
---|
121 | </seg>
|
---|
122 | <seg>
|
---|
123 | libnvme.so and
|
---|
124 | libnvme-mi.so
|
---|
125 | </seg>
|
---|
126 | <seg>
|
---|
127 | /usr/include/nvme
|
---|
128 | </seg>
|
---|
129 | </seglistitem>
|
---|
130 | </segmentedlist>
|
---|
131 |
|
---|
132 | <variablelist>
|
---|
133 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
134 | <?dbfo list-presentation="list"?>
|
---|
135 | <?dbhtml list-presentation="table"?>
|
---|
136 |
|
---|
137 | <varlistentry id="libnvme-lib">
|
---|
138 | <term><filename class="libraryfile">libnvme.so</filename></term>
|
---|
139 | <listitem>
|
---|
140 | <para>
|
---|
141 | contains functions used to handle operations
|
---|
142 | relating to NVMe devices.
|
---|
143 | </para>
|
---|
144 | <indexterm zone="libnvme libnvme-lib">
|
---|
145 | <primary sortas="c-libnvme">libnvme.so</primary>
|
---|
146 | </indexterm>
|
---|
147 | </listitem>
|
---|
148 | </varlistentry>
|
---|
149 |
|
---|
150 | </variablelist>
|
---|
151 |
|
---|
152 | </sect2>
|
---|
153 |
|
---|
154 | </sect1>
|
---|