1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
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/refs/tags/v&libnvme-version;/libnvme-&libnvme-version;.tar.gz">
|
---|
8 | <!ENTITY libnvme-download-ftp " ">
|
---|
9 | <!ENTITY libnvme-md5sum "8289e988a3244a35cc326aa564a7a727">
|
---|
10 | <!ENTITY libnvme-size "556 KB">
|
---|
11 | <!ENTITY libnvme-buildsize "9.0 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 | &lfs120_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">Required</bridgehead>
|
---|
74 | <para role="required">
|
---|
75 | None so for for this package
|
---|
76 | </para>
|
---|
77 | -->
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
80 | <para role="optional">
|
---|
81 | <phrase revision="sysv"><xref linkend="dbus"/>,</phrase>
|
---|
82 | <xref linkend="json-c"/>,
|
---|
83 | <xref linkend="keyutils"/>, and
|
---|
84 | <xref linkend="swig"/>
|
---|
85 | </para>
|
---|
86 |
|
---|
87 |
|
---|
88 | </sect2>
|
---|
89 |
|
---|
90 | <sect2 role="installation">
|
---|
91 | <title>Installation of libnvme</title>
|
---|
92 |
|
---|
93 | <para>
|
---|
94 | Install <application>libnvme</application> by running the following
|
---|
95 | commands:
|
---|
96 | </para>
|
---|
97 |
|
---|
98 | <screen><userinput>mkdir build &&
|
---|
99 | cd build &&
|
---|
100 |
|
---|
101 | meson setup --prefix=/usr --buildtype=release -Dlibdbus=auto .. &&
|
---|
102 | ninja</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | To run the tests, issue: <command>ninja test</command>.
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2 role="content">
|
---|
117 | <title>Contents</title>
|
---|
118 |
|
---|
119 | <segmentedlist>
|
---|
120 | <segtitle>Installed Programs</segtitle>
|
---|
121 | <segtitle>Installed Library</segtitle>
|
---|
122 | <segtitle>Installed Directories</segtitle>
|
---|
123 |
|
---|
124 | <seglistitem>
|
---|
125 | <seg>
|
---|
126 | None
|
---|
127 | </seg>
|
---|
128 | <seg>
|
---|
129 | libnvme.so and
|
---|
130 | libnvme-mi.so
|
---|
131 | </seg>
|
---|
132 | <seg>
|
---|
133 | /usr/include/nvme and
|
---|
134 | /usr/lib/python3.11/site-packages/libnvme
|
---|
135 | </seg>
|
---|
136 | </seglistitem>
|
---|
137 | </segmentedlist>
|
---|
138 |
|
---|
139 | <variablelist>
|
---|
140 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
141 | <?dbfo list-presentation="list"?>
|
---|
142 | <?dbhtml list-presentation="table"?>
|
---|
143 |
|
---|
144 | <varlistentry id="libnvme-lib">
|
---|
145 | <term><filename class="libraryfile">libnvme.so</filename></term>
|
---|
146 | <listitem>
|
---|
147 | <para>
|
---|
148 | contains functions used to handle operations
|
---|
149 | relating to NVMe devices.
|
---|
150 | </para>
|
---|
151 | <indexterm zone="libnvme libnvme-lib">
|
---|
152 | <primary sortas="c-libnvme">libnvme.so</primary>
|
---|
153 | </indexterm>
|
---|
154 | </listitem>
|
---|
155 | </varlistentry>
|
---|
156 |
|
---|
157 | </variablelist>
|
---|
158 |
|
---|
159 | </sect2>
|
---|
160 |
|
---|
161 | </sect1>
|
---|