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 volume_key-download-http "https://github.com/felixonmars/volume_key/archive/volume_key-&volume_key-version;.tar.gz">
|
---|
8 | <!ENTITY volume_key-download-ftp " ">
|
---|
9 | <!ENTITY volume_key-md5sum "d1c76f24e08ddd8c1787687d0af5a814">
|
---|
10 | <!ENTITY volume_key-size "196 KB">
|
---|
11 | <!ENTITY volume_key-buildsize "11 MB">
|
---|
12 | <!ENTITY volume_key-time "0.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="volume_key" xreflabel="volume_key-&volume_key-version;">
|
---|
16 | <?dbhtml filename="volume_key.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>volume_key-&volume_key-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="volume_key">
|
---|
22 | <primary sortas="a-volume_key">volume_key</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to volume_key</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>volume_key</application> package provides
|
---|
30 | a library for manipulating storage volume encryption keys and storing
|
---|
31 | them separately from volumes to handle forgotten passphrases.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs120_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&volume_key-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&volume_key-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &volume_key-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &volume_key-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &volume_key-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &volume_key-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">volume_key Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="cryptsetup"/>,
|
---|
75 | <xref linkend="glib2"/>,
|
---|
76 | <!-- To editors: if GnuPG is not installed, a wrong path to gpg will
|
---|
77 | be hard-coded into the library. Even if GnuPG is installed, we
|
---|
78 | still need the 's/gpg2/gpg/' sed below. I can't find an elegant
|
---|
79 | way to specify the path manually (so I can't make it a runtime
|
---|
80 | dependency). -->
|
---|
81 | <xref linkend="gnupg2"/>,
|
---|
82 | <xref linkend="gpgme"/>, and
|
---|
83 | <xref linkend="nss"/>
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
87 | <para role="recommended">
|
---|
88 | <xref linkend="swig"/>
|
---|
89 | </para>
|
---|
90 | <!-- We prevent using Python2, so do not advertise it
|
---|
91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
92 | <para role="optional">
|
---|
93 | <xref linkend="python2"/>
|
---|
94 | </para>
|
---|
95 | -->
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 role="installation">
|
---|
99 | <title>Installation of volume_key</title>
|
---|
100 |
|
---|
101 | <note>
|
---|
102 | <para>
|
---|
103 | This package expands to the directory
|
---|
104 | volume_key-volume_key-&volume_key-version;.
|
---|
105 | </para>
|
---|
106 | </note>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Tell the building system how to locate GPGME and GnuPG correctly:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen><userinput remap='pre'>sed -e '/AM_PATH_GPGME/iAM_PATH_GPG_ERROR' \
|
---|
113 | -e 's/gpg2/gpg/' -i configure.ac</userinput></screen>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Install <application>volume_key</application> by running the following
|
---|
117 | commands:
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | <screen><userinput>autoreconf -fiv &&
|
---|
121 | ./configure --prefix=/usr \
|
---|
122 | --without-python &&
|
---|
123 | make</userinput></screen>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | To test the results, issue: <command>make check</command>.
|
---|
127 | </para>
|
---|
128 |
|
---|
129 | <para>
|
---|
130 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
131 | </para>
|
---|
132 |
|
---|
133 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
134 |
|
---|
135 | </sect2>
|
---|
136 |
|
---|
137 | <sect2 role="commands">
|
---|
138 | <title>Command Explanations</title>
|
---|
139 |
|
---|
140 | <para>
|
---|
141 | <parameter>--without-python</parameter>: This parameter prevents building
|
---|
142 | the <application>Python 2</application> bindings, if <xref
|
---|
143 | linkend="python2"/> is installed.
|
---|
144 | </para>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <option>--without-python3</option>: Use this option if you do not want
|
---|
148 | to build the <application>Python 3</application> bindings. In this case,
|
---|
149 | <xref linkend="swig"/> is not needed.
|
---|
150 | </para>
|
---|
151 |
|
---|
152 | </sect2>
|
---|
153 | <sect2 role="content">
|
---|
154 | <title>Contents</title>
|
---|
155 |
|
---|
156 | <segmentedlist>
|
---|
157 | <segtitle>Installed Program</segtitle>
|
---|
158 | <segtitle>Installed Library</segtitle>
|
---|
159 | <segtitle>Installed Directory</segtitle>
|
---|
160 |
|
---|
161 | <seglistitem>
|
---|
162 | <seg>
|
---|
163 | volume_key
|
---|
164 | </seg>
|
---|
165 | <seg>
|
---|
166 | libvolume_key.so
|
---|
167 | </seg>
|
---|
168 | <seg>
|
---|
169 | /usr/include/volume_key
|
---|
170 | </seg>
|
---|
171 | </seglistitem>
|
---|
172 | </segmentedlist>
|
---|
173 |
|
---|
174 | <variablelist>
|
---|
175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
176 | <?dbfo list-presentation="list"?>
|
---|
177 | <?dbhtml list-presentation="table"?>
|
---|
178 |
|
---|
179 | <varlistentry id="volume_key-prog">
|
---|
180 | <term><command>volume_key</command></term>
|
---|
181 | <listitem>
|
---|
182 | <para>
|
---|
183 | manages encrypted volume keys and passphrases
|
---|
184 | </para>
|
---|
185 | <indexterm zone="volume_key volume_key-prog">
|
---|
186 | <primary sortas="b-volume_key">volume_key</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 |
|
---|
191 | <varlistentry id="volume_key-lib">
|
---|
192 | <term><filename class="libraryfile">volume_key.so</filename></term>
|
---|
193 | <listitem>
|
---|
194 | <para>
|
---|
195 | contains API functions for managing encrypted volume keys
|
---|
196 | </para>
|
---|
197 | <indexterm zone="volume_key volume_key-lib">
|
---|
198 | <primary sortas="c-volume_key">volume_key.so</primary>
|
---|
199 | </indexterm>
|
---|
200 | </listitem>
|
---|
201 | </varlistentry>
|
---|
202 |
|
---|
203 | </variablelist>
|
---|
204 |
|
---|
205 | </sect2>
|
---|
206 |
|
---|
207 | </sect1>
|
---|